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

complete(result)

Set the result. Any handler will be called, if there is one, and the future will be marked as completed.
Parameters:
Name Type Description
result CompositeFuture the result
Source:

completer() → {function}

Source:
Returns:
an handler completing this future
Type
function

compose(handler, next) → {Future}

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.

Parameters:
Name Type Description
handler function the handler
next Future the next future
Source:
Returns:
the next future, used for chaining
Type
Future

fail(failureMessage)

Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.
Parameters:
Name Type Description
failureMessage string the failure message
Source:

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

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(value) → {Future}

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.

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

mapEmpty() → {Future}

Map the result of a future to null.

This is a conveniency for future.map((T) null) or future.map((Void) null).

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

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

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 todo 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

tryComplete(result) → {boolean}

Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.
Parameters:
Name Type Description
result CompositeFuture the result
Source:
Returns:
false when the future is already completed
Type
boolean

tryFail(failureMessage) → {boolean}

Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.
Parameters:
Name Type Description
failureMessage string the failure message
Source:
Returns:
false when the future is already completed
Type
boolean