Class List Method List File List

# Class: Vertx::CompositeFuture

Inherits:
  Future
  - Object
  - Future
  - Vertx::CompositeFuture
  show all
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb

## Overview

The composite future wraps a list of Futurefutures, it is useful when several futures needs to be coordinated.

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (::Vertx::CompositeFuture) all(param_1 = nil, param_2 = nil, param_3 = nil, param_4 = nil, param_5 = nil, param_6 = nil)
  Like #all but with 6 futures.
- + (::Vertx::CompositeFuture) any(param_1 = nil, param_2 = nil, param_3 = nil, param_4 = nil, param_5 = nil, param_6 = nil)
  Like #any but with 6 futures.
- + (Object) j_api_type
- + (Object) j_class
- + (::Vertx::CompositeFuture) join(param_1 = nil, param_2 = nil, param_3 = nil, param_4 = nil, param_5 = nil, param_6 = nil)
  Like #join but with 6 futures.
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (Exception) cause(index = nil)
  Returns a cause of a wrapped future.
- - (void) complete(result = nil)
  Set the result.
- - (true, false) complete?(index = nil)
  Returns true if a wrapped future is completed.
- - (Proc) completer
  An handler completing this future.
- - (::Vertx::Future) compose(param_1 = nil, param_2 = nil)
  Compose this future with a provided next future.
- - (void) fail(param_1 = nil)
  Set the failure.
- - (true, false) failed?(index = nil)
  Returns true if a wrapped future is failed.
- - (::Vertx::Future) map(param_1 = nil)
  Map the result of a future to a specific value.
- - (::Vertx::CompositeFuture) result
  The result of the operation.
- - (Object) result_at(index = nil)
  Returns the result of a wrapped future.
- - (self) set_handler { ... }
- - (Fixnum) size
  The number of wrapped future.
- - (true, false) succeeded?(index = nil)
  Returns true if a wrapped future is succeeded.

### Methods inherited from Future

failed_future, future, succeeded_future

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    20
    21
    22
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 20

    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:

- + (`::Vertx::CompositeFuture`) all(futures)

  Parameters:

  - futures (`Array<::Vertx::Future>`)
- + (`::Vertx::CompositeFuture`) all(f1, f2)

  Parameters:

  - f1 (`::Vertx::Future`) —
    future
  - f2 (`::Vertx::Future`) —
    future
- + (`::Vertx::CompositeFuture`) all(f1, f2, f3)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) all(f1, f2, f3, f4)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) all(f1, f2, f3, f4, f5)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) all(f1, f2, f3, f4, f5, f6)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
  - f6 (`::Vertx::Future`)

Returns:

- (`::Vertx::CompositeFuture`)

Raises:

- (`ArgumentError`)

    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 192

    def self.all(param_1=nil,param_2=nil,param_3=nil,param_4=nil,param_5=nil,param_6=nil)
      if param_1.class == Array && !block_given? && param_2 == nil && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::JavaUtil::List.java_class]).call(param_1.map { |element| element.j_del }),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && !block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:all, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(param_1.j_del,param_2.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && !block_given? && param_4 == nil && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && !block_given? && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && !block_given? && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && param_6.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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del,param_6.j_del),::Vertx::CompositeFuture)
      end
      raise ArgumentError, "Invalid arguments when calling all(#{param_1},#{param_2},#{param_3},#{param_4},#{param_5},#{param_6})"
    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:

- + (`::Vertx::CompositeFuture`) any(futures)

  Parameters:

  - futures (`Array<::Vertx::Future>`)
- + (`::Vertx::CompositeFuture`) any(f1, f2)

  Parameters:

  - f1 (`::Vertx::Future`) —
    future
  - f2 (`::Vertx::Future`) —
    future
- + (`::Vertx::CompositeFuture`) any(f1, f2, f3)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) any(f1, f2, f3, f4)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) any(f1, f2, f3, f4, f5)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) any(f1, f2, f3, f4, f5, f6)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
  - f6 (`::Vertx::Future`)

Returns:

- (`::Vertx::CompositeFuture`)

Raises:

- (`ArgumentError`)

    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 237

    def self.any(param_1=nil,param_2=nil,param_3=nil,param_4=nil,param_5=nil,param_6=nil)
      if param_1.class == Array && !block_given? && param_2 == nil && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::JavaUtil::List.java_class]).call(param_1.map { |element| element.j_del }),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && !block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:any, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(param_1.j_del,param_2.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && !block_given? && param_4 == nil && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && !block_given? && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && !block_given? && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && param_6.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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del,param_6.j_del),::Vertx::CompositeFuture)
      end
      raise ArgumentError, "Invalid arguments when calling any(#{param_1},#{param_2},#{param_3},#{param_4},#{param_5},#{param_6})"
    end

### + (`Object`) j_api_type

    29
    30
    31
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 29

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    32
    33
    34
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 32

    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:

- + (`::Vertx::CompositeFuture`) join(futures)

  Parameters:

  - futures (`Array<::Vertx::Future>`)
- + (`::Vertx::CompositeFuture`) join(f1, f2)

  Parameters:

  - f1 (`::Vertx::Future`) —
    future
  - f2 (`::Vertx::Future`) —
    future
- + (`::Vertx::CompositeFuture`) join(f1, f2, f3)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) join(f1, f2, f3, f4)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) join(f1, f2, f3, f4, f5)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
- + (`::Vertx::CompositeFuture`) join(f1, f2, f3, f4, f5, f6)

  Parameters:

  - f1 (`::Vertx::Future`)
  - f2 (`::Vertx::Future`)
  - f3 (`::Vertx::Future`)
  - f4 (`::Vertx::Future`)
  - f5 (`::Vertx::Future`)
  - f6 (`::Vertx::Future`)

Returns:

- (`::Vertx::CompositeFuture`)

Raises:

- (`ArgumentError`)

    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 282

    def self.join(param_1=nil,param_2=nil,param_3=nil,param_4=nil,param_5=nil,param_6=nil)
      if param_1.class == Array && !block_given? && param_2 == nil && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::JavaUtil::List.java_class]).call(param_1.map { |element| element.j_del }),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && !block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::CompositeFuture.java_method(:join, [Java::IoVertxCore::Future.java_class,Java::IoVertxCore::Future.java_class]).call(param_1.j_del,param_2.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && !block_given? && param_4 == nil && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && !block_given? && param_5 == nil && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && !block_given? && param_6 == 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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del),::Vertx::CompositeFuture)
      elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && param_3.class.method_defined?(:j_del) && param_4.class.method_defined?(:j_del) && param_5.class.method_defined?(:j_del) && param_6.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(param_1.j_del,param_2.j_del,param_3.j_del,param_4.j_del,param_5.j_del,param_6.j_del),::Vertx::CompositeFuture)
      end
      raise ArgumentError, "Invalid arguments when calling join(#{param_1},#{param_2},#{param_3},#{param_4},#{param_5},#{param_6})"
    end

### + (`Object`) unwrap(obj)

    26
    27
    28
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 26

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

### + (`Object`) wrap(obj)

    23
    24
    25
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 23

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

## Instance Method Details

### - (`Exception`) cause(index = nil)

Returns a cause of a wrapped future

Parameters:

- index (`Fixnum`) (defaults to: `nil`) —
  the wrapped future index

Returns:

- (`Exception`)

Raises:

- (`ArgumentError`)

    82
    83
    84
    85
    86
    87
    88
    89
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 82

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

### - (`void`) complete(result = nil)

This method returns an undefined value.

Set the result. Any handler will be called, if there is one, and the future will be marked as completed.

Parameters:

- result (`::Vertx::CompositeFuture`) (defaults to: `nil`) —
  the result

Raises:

- (`ArgumentError`)

    49
    50
    51
    52
    53
    54
    55
    56
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 49

    def complete(result=nil)
      if !block_given? && result == nil
        return @j_del.java_method(:complete, []).call()
      elsif result.class.method_defined?(:j_del) && !block_given?
        return @j_del.java_method(:complete, [Java::IoVertxCore::CompositeFuture.java_class]).call(result.j_del)
      end
      raise ArgumentError, "Invalid arguments when calling complete(#{result})"
    end

### - (`true`, `false`) complete?(index = nil)

Returns true if a wrapped future is completed

Parameters:

- index (`Fixnum`) (defaults to: `nil`) —
  the wrapped future index

Returns:

- (`true`, `false`)

Raises:

- (`ArgumentError`)

    38
    39
    40
    41
    42
    43
    44
    45
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 38

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

### - (`Proc`) completer

Returns an handler completing this future

Returns:

- (`Proc`) —
  an handler completing this future

Raises:

- (`ArgumentError`)

    154
    155
    156
    157
    158
    159
    160
    161
    162
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 154

    def completer
      if !block_given?
        if @cached_completer != nil
          return @cached_completer
        end
        return @cached_completer = ::Vertx::Util::Utils.to_async_result_handler_proc(@j_del.java_method(:completer, []).call()) { |val| val.j_del }
      end
      raise ArgumentError, "Invalid arguments when calling completer()"
    end

### - (`::Vertx::Future`) compose(mapper) { ... } - (`::Vertx::Future`) compose(handler)

Compose this future with a provided `next` future.

When this (the one on which `compose` is called) future succeeds, the `handler` will be called with the completed value, this handler should complete the next future.

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

When this future fails, the failure will be propagated to the `next` future and the `handler` will not be called.

Overloads:

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

  Yields:

  - the mapper function
- - (`::Vertx::Future`) compose(handler)

  Parameters:

  - handler (`Proc`) —
    the handler
  - _next (`::Vertx::Future`) —
    the next future

Returns:

- (`::Vertx::Future`) —
  the next future, used for chaining

Raises:

- (`ArgumentError`)

    127
    128
    129
    130
    131
    132
    133
    134
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 127

    def compose(param_1=nil,param_2=nil)
      if block_given? && param_1 == nil && param_2 == 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 })),::Vertx::Future, nil)
      elsif param_1.class == Proc && param_2.class.method_defined?(:j_del) && !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Future.java_class]).call((Proc.new { |event| param_1.call(::Vertx::Util::Utils.safe_create(event,::Vertx::CompositeFuture)) }),param_2.j_del),::Vertx::Future, nil)
      end
      raise ArgumentError, "Invalid arguments when calling compose(#{param_1},#{param_2})"
    end

### - (`void`) fail(throwable) - (`void`) fail(failureMessage)

This method returns an undefined value.

Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.

Overloads:

- - (`void`) fail(throwable)

  Parameters:

  - throwable (`Exception`) —
    the failure cause
- - (`void`) fail(failureMessage)

  Parameters:

  - failureMessage (`String`) —
    the failure message

Raises:

- (`ArgumentError`)

    63
    64
    65
    66
    67
    68
    69
    70
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 63

    def fail(param_1=nil)
      if param_1.is_a?(Exception) && !block_given?
        return @j_del.java_method(:fail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1))
      elsif param_1.class == String && !block_given?
        return @j_del.java_method(:fail, [Java::java.lang.String.java_class]).call(param_1)
      end
      raise ArgumentError, "Invalid arguments when calling fail(#{param_1})"
    end

### - (`true`, `false`) failed?(index = nil)

Returns true if a wrapped future is failed

Parameters:

- index (`Fixnum`) (defaults to: `nil`) —
  the wrapped future index

Returns:

- (`true`, `false`)

Raises:

- (`ArgumentError`)

    104
    105
    106
    107
    108
    109
    110
    111
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 104

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

### - (`::Vertx::Future`) map(mapper) { ... } - (`::Vertx::Future`) map(value)

Map the result of a future to a specific `value`.

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

When this future fails, the failure will be propagated to the returned future.

Overloads:

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

  Yields:

  - the mapper function
- - (`::Vertx::Future`) map(value)

  Parameters:

  - value (`Object`) —
    the value that eventually completes the mapped future

Returns:

- (`::Vertx::Future`) —
  the mapped future

Raises:

- (`ArgumentError`)

    145
    146
    147
    148
    149
    150
    151
    152
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 145

    def map(param_1=nil)
      if block_given? && param_1 == 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))) })),::Vertx::Future, nil)
      elsif ::Vertx::Util::unknown_type.accept?(param_1) && !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(param_1)),::Vertx::Future, nil)
      end
      raise ArgumentError, "Invalid arguments when calling map(#{param_1})"
    end

### - (`::Vertx::CompositeFuture`) result

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

Returns:

- (`::Vertx::CompositeFuture`) —
  the result or null if the operation failed.

Raises:

- (`ArgumentError`)

    73
    74
    75
    76
    77
    78
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 73

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

### - (`Object`) result_at(index = nil)

Returns the result of a wrapped future

Parameters:

- index (`Fixnum`) (defaults to: `nil`) —
  the wrapped future index

Returns:

- (`Object`)

Raises:

- (`ArgumentError`)

    310
    311
    312
    313
    314
    315
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 310

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

### - (`self`) set_handler { ... }

Yields:

Returns:

- (`self`)

Raises:

- (`ArgumentError`)

    300
    301
    302
    303
    304
    305
    306
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 300

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

### - (`Fixnum`) size

Returns the number of wrapped future

Returns:

- (`Fixnum`) —
  the number of wrapped future

Raises:

- (`ArgumentError`)

    317
    318
    319
    320
    321
    322
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 317

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

### - (`true`, `false`) succeeded?(index = nil)

Returns true if a wrapped future is succeeded

Parameters:

- index (`Fixnum`) (defaults to: `nil`) —
  the wrapped future index

Returns:

- (`true`, `false`)

Raises:

- (`ArgumentError`)

    93
    94
    95
    96
    97
    98
    99
    100
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/composite_future.rb', line 93

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