Class: CompositeFuture

vertx-js/composite_future~ CompositeFuture

new CompositeFuture()

Source:

Methods

cause(index) → {todo}

Returns a cause of a wrapped future
Parameters:
Name Type Description
index number the wrapped future index
Source:
Returns:
Type
todo

compose(mapper) → {Future}

Compose this future with a mapper function.

When this future (the one on which compose is called) succeeds, the mapper 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.

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.

Parameters:
Name Type Description
mapper function the mapper function
Source:
Returns:
the composed future
Type
Future

failed(index) → {boolean}

Returns true if a wrapped future is failed
Parameters:
Name Type Description
index number the wrapped future index
Source:
Returns:
Type
boolean

getHandler() → {function}

Source:
Returns:
the handler for the result
Type
function

isComplete(index) → {boolean}

Returns true if a wrapped future is completed
Parameters:
Name Type Description
index number the wrapped future index
Source:
Returns:
Type
boolean

map(mapper) → {Future}

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.

Parameters:
Name Type Description
mapper function the mapper function
Source:
Returns:
the mapped future
Type
Future

otherwise(value) → {Future}

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.

Parameters:
Name Type Description
value CompositeFuture the value that eventually completes the mapped future
Source:
Returns:
the mapped future
Type
Future

otherwiseEmpty() → {Future}

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.

Source:
Returns:
the mapped future
Type
Future

recover(mapper) → {Future}

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.
Parameters:
Name Type Description
mapper function A function which takes the exception of a failure and returns a new future.
Source:
Returns:
A recovered future
Type
Future

result() → {CompositeFuture}

The result of the operation. This will be null if the operation failed.
Source:
Returns:
the result or null if the operation failed.
Type
CompositeFuture

resultAt(index) → {Object}

Returns the result of a wrapped future
Parameters:
Name Type Description
index number the wrapped future index
Source:
Returns:
Type
Object

setHandler(handler) → {CompositeFuture}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
CompositeFuture

size() → {number}

Source:
Returns:
the number of wrapped future
Type
number

succeeded(index) → {boolean}

Returns true if a wrapped future is succeeded
Parameters:
Name Type Description
index number the wrapped future index
Source:
Returns:
Type
boolean