Class: Vertx::CompositeFuture

Inherits:
Future
  • Object
show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb

Overview

The composite future wraps a list of Futurefutures, it is useful when several futures needs to be coordinated. The handlers set for the coordinated futures are overridden by the handler of the composite future.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Future

#context, failed_future, future, #map_empty, succeeded_future

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


22
23
24
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 22

def @@j_api_type.accept?(obj)
  obj.class == CompositeFuture
end

+ (::Vertx::CompositeFuture) all(futures) + (::Vertx::CompositeFuture) all(f1, f2) + (::Vertx::CompositeFuture) all(f1, f2, f3) + (::Vertx::CompositeFuture) all(f1, f2, f3, f4) + (::Vertx::CompositeFuture) all(f1, f2, f3, f4, f5) + (::Vertx::CompositeFuture) all(f1, f2, f3, f4, f5, f6)

Like #all but with 6 futures.

Overloads:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 66

def self.all(*args)
  if args[0].class == Array && !block_given? && args[1] == nil && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| element.j_del }),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && !block_given? && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && !block_given? && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && !block_given? && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && !block_given? && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && args[5].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del,args[5].j_del),::Vertx::CompositeFuture)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling all(#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]},#{args[5]})"
  end
end

+ (::Vertx::CompositeFuture) any(futures) + (::Vertx::CompositeFuture) any(f1, f2) + (::Vertx::CompositeFuture) any(f1, f2, f3) + (::Vertx::CompositeFuture) any(f1, f2, f3, f4) + (::Vertx::CompositeFuture) any(f1, f2, f3, f4, f5) + (::Vertx::CompositeFuture) any(f1, f2, f3, f4, f5, f6)

Like #any but with 6 futures.

Overloads:

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 260

def self.any(*args)
  if args[0].class == Array && !block_given? && args[1] == nil && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| element.j_del }),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && !block_given? && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && !block_given? && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && !block_given? && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && !block_given? && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && args[5].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del,args[5].j_del),::Vertx::CompositeFuture)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling any(#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]},#{args[5]})"
  end
end

+ (Object) j_api_type



31
32
33
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 31

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



34
35
36
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 34

def self.j_class
  Java::IoVertxCore::CompositeFuture.java_class
end

+ (::Vertx::CompositeFuture) join(futures) + (::Vertx::CompositeFuture) join(f1, f2) + (::Vertx::CompositeFuture) join(f1, f2, f3) + (::Vertx::CompositeFuture) join(f1, f2, f3, f4) + (::Vertx::CompositeFuture) join(f1, f2, f3, f4, f5) + (::Vertx::CompositeFuture) join(f1, f2, f3, f4, f5, f6)

Like #join but with 6 futures.

Overloads:

Returns:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 396

def self.join(*args)
  if args[0].class == Array && !block_given? && args[1] == nil && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| element.j_del }),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && !block_given? && args[2] == nil && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && !block_given? && args[3] == nil && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && !block_given? && args[4] == nil && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && !block_given? && args[5] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del),::Vertx::CompositeFuture)
  elsif args[0].class.method_defined?(:j_del) && args[1].class.method_defined?(:j_del) && args[2].class.method_defined?(:j_del) && args[3].class.method_defined?(:j_del) && args[4].class.method_defined?(:j_del) && args[5].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(args[0].j_del,args[1].j_del,args[2].j_del,args[3].j_del,args[4].j_del,args[5].j_del),::Vertx::CompositeFuture)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling join(#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]},#{args[5]})"
  end
end

+ (Object) unwrap(obj)



28
29
30
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 28

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



25
26
27
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 25

def @@j_api_type.wrap(obj)
  CompositeFuture.new(obj)
end

Instance Method Details

- (Exception) cause(index)

Returns a cause of a wrapped future

Parameters:

  • index (Fixnum)
    the wrapped future index

Returns:

  • (Exception)


167
168
169
170
171
172
173
174
175
176
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 167

def cause(*args)
  if args[0].class == Fixnum && !block_given?
    return ::Vertx::Util::Utils.from_throwable(@j_del.java_method(:cause, [Java::int.java_class]).call(args[0]))
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling cause(#{args[0]})"
  end
end

- (true, false) isComplete(index)

Returns true if a wrapped future is completed

Parameters:

  • index (Fixnum)
    the wrapped future index

Returns:

  • (true, false)


442
443
444
445
446
447
448
449
450
451
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 442

def complete?(*args)
  if args[0].class == Fixnum && !block_given?
    return @j_del.java_method(:isComplete, [Java::int.java_class]).call(args[0])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling complete?(#{args[0]})"
  end
end

- (::Vertx::Future) compose(mapper) { ... } - (::Vertx::Future) compose(successMapper, failureMapper) { ... }

Compose this future with a successMapper and failureMapper functions.

When this future (the one on which compose is called) succeeds, the successMapper will be called with the completed value and this mapper returns another future object. This returned future completion will complete the future returned by this method call.

When this future (the one on which compose is called) fails, the failureMapper will be called with the failure and this mapper returns another future object. This returned future completion will complete the future returned by this method call.

If any mapper function throws an exception, the returned future will be failed with this exception.

Overloads:

  • - (::Vertx::Future) compose(mapper) { ... }

    Yields:

    • the mapper function
  • - (::Vertx::Future) compose(successMapper, failureMapper) { ... }

    Parameters:

    • successMapper (Proc)
      the function mapping the success

    Yields:

    • the function mapping the failure

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 355

def compose(*args)
  if block_given? && args[0] == nil && args[1] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture)).j_del unless !block_given? })),::Vertx::Future, nil)
  elsif args[0].class == Proc && block_given? && args[1] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::JavaUtilFunction::Function.java_class,Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| args[0].call(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture)).j_del unless args[0] == nil }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)).j_del unless !block_given? })),::Vertx::Future, nil)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling compose(#{args[0]},#{args[1]})"
  end
end

- (true, false) failed(index)

Returns true if a wrapped future is failed

Parameters:

  • index (Fixnum)
    the wrapped future index

Returns:

  • (true, false)


195
196
197
198
199
200
201
202
203
204
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 195

def failed?(*args)
  if args[0].class == Fixnum && !block_given?
    return @j_del.java_method(:failed, [Java::int.java_class]).call(args[0])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling failed?(#{args[0]})"
  end
end

- (::Vertx::Future) flatMap(mapper) { ... }

Alias for Future#compose.

Yields:

Returns:



303
304
305
306
307
308
309
310
311
312
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 303

def flat_map(*args)
  if block_given? && args[0] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:flatMap, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture)).j_del unless !block_given? })),::Vertx::Future, nil)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling flat_map(#{args[0]})"
  end
end

- (Proc) getHandler

Returns the handler for the result

Returns:

  • (Proc)
    the handler for the result


221
222
223
224
225
226
227
228
229
230
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 221

def get_handler
  if !block_given?
    return ::Vertx::Util::Utils.to_async_result_handler_proc(@j_del.java_method(:getHandler, []).call()) { |val| val.j_del }
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_handler()"
  end
end

- (::Vertx::Future) map(mapper) { ... }

Apply a mapper function on this future.

When this future succeeds, the mapper will be called with the completed value and this mapper returns a value. This value will complete the future returned by this method call.

If the mapper throws an exception, the returned future will be failed with this exception.

When this future fails, the failure will be propagated to the returned future and the mapper will not be called.

Yields:

  • the mapper function

Returns:



428
429
430
431
432
433
434
435
436
437
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 428

def map(*args)
  if block_given? && args[0] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| ::Vertx::Util::Utils.to_object(yield(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture))) unless !block_given? })),::Vertx::Future, nil)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling map(#{args[0]})"
  end
end

- (self) onComplete(handler) { ... }

Yields:

Returns:

  • (self)


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 146

def on_complete
  if true
    if (block_given?)
      @j_del.java_method(:onComplete, [Java::IoVertxCore::Handler.java_class]).call(block_given? ? Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::CompositeFuture) : nil) } : promise)
      return self
    else
      promise = ::Vertx::Util::Utils.promise
      @j_del.java_method(:onComplete, [Java::IoVertxCore::Handler.java_class]).call(block_given? ? Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::CompositeFuture) : nil) } : promise)
      return ::Vertx::Util::Utils.safe_create(promise.future(),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
    end
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling on_complete()"
  end
end

- (self) onFailure(handler) { ... }

Yields:

Returns:

  • (self)


180
181
182
183
184
185
186
187
188
189
190
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 180

def on_failure
  if true
    @j_del.java_method(:onFailure, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) unless !block_given? }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling on_failure()"
  end
end

- (self) onSuccess(handler) { ... }

Yields:

Returns:

  • (self)


469
470
471
472
473
474
475
476
477
478
479
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 469

def on_success
  if true
    @j_del.java_method(:onSuccess, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture)) unless !block_given? }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling on_success()"
  end
end

- (::Vertx::Future) otherwise(mapper) { ... } - (::Vertx::Future) otherwise(value)

Map the failure of a future to a specific value.

When this future fails, this value will complete the future returned by this method call.

When this future succeeds, the result will be propagated to the returned future.

Overloads:

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 96

def otherwise(*args)
  if block_given? && args[0] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)).j_del unless !block_given? })),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
  elsif args[0].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::IoVertxCore::CompositeFuture.java_class]).call(args[0].j_del),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling otherwise(#{args[0]})"
  end
end

- (::Vertx::Future) otherwiseEmpty

Map the failure of a future to null.

This is a convenience for future.otherwise((T) null).

When this future fails, the null value will complete the future returned by this method call.

When this future succeeds, the result will be propagated to the returned future.

Returns:



289
290
291
292
293
294
295
296
297
298
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 289

def otherwise_empty
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwiseEmpty, []).call(),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling otherwise_empty()"
  end
end

- (::Vertx::Future) recover(mapper) { ... }

Handles a failure of this Future by returning the result of another Future. If the mapper fails, then the returned future will be failed with this failure.

Yields:

  • A function which takes the exception of a failure and returns a new future.

Returns:



133
134
135
136
137
138
139
140
141
142
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 133

def recover(*args)
  if block_given? && args[0] == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:recover, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)).j_del unless !block_given? })),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling recover(#{args[0]})"
  end
end

- (::Vertx::CompositeFuture) result

The result of the operation. This will be null if the operation failed.

Returns:



316
317
318
319
320
321
322
323
324
325
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 316

def result
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:result, []).call(),::Vertx::CompositeFuture)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling result()"
  end
end

- (Object) resultAt(index)

Returns the result of a wrapped future

Parameters:

  • index (Fixnum)
    the wrapped future index

Returns:

  • (Object)


209
210
211
212
213
214
215
216
217
218
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 209

def result_at(*args)
  if args[0].class == Fixnum && !block_given?
    return ::Vertx::Util::Utils.from_object(@j_del.java_method(:resultAt, [Java::int.java_class]).call(args[0]))
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling result_at(#{args[0]})"
  end
end

- (self) setHandler(handler) { ... }

Yields:

Returns:

  • (self)


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 111

def set_handler
  if true
    if (block_given?)
      @j_del.java_method(:setHandler, [Java::IoVertxCore::Handler.java_class]).call(block_given? ? Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::CompositeFuture) : nil) } : promise)
      return self
    else
      promise = ::Vertx::Util::Utils.promise
      @j_del.java_method(:setHandler, [Java::IoVertxCore::Handler.java_class]).call(block_given? ? Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::CompositeFuture) : nil) } : promise)
      return ::Vertx::Util::Utils.safe_create(promise.future(),::Vertx::Future,::Vertx::CompositeFuture.j_api_type)
    end
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_handler()"
  end
end

- (Fixnum) size

Returns the number of wrapped future

Returns:

  • (Fixnum)
    the number of wrapped future


328
329
330
331
332
333
334
335
336
337
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 328

def size
  if !block_given?
    return @j_del.java_method(:size, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling size()"
  end
end

- (true, false) succeeded(index)

Returns true if a wrapped future is succeeded

Parameters:

  • index (Fixnum)
    the wrapped future index

Returns:

  • (true, false)


456
457
458
459
460
461
462
463
464
465
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/composite_future.rb', line 456

def succeeded?(*args)
  if args[0].class == Fixnum && !block_given?
    return @j_del.java_method(:succeeded, [Java::int.java_class]).call(args[0])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling succeeded?(#{args[0]})"
  end
end