new Future()
- Source:
Methods
cause() → {todo}
- Source:
Returns:
- Type
- todo
compose(mapper) → {Future}
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:
- Type
- Future
failed() → {boolean}
- Source:
Returns:
- Type
- boolean
getHandler() → {function}
- Source:
Returns:
- Type
- function
isComplete() → {boolean}
It's completed if it's either succeeded or failed.
- Source:
Returns:
- Type
- boolean
map(value) → {Future}
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:
- Type
- Future
mapEmpty() → {Future}
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:
- Type
- Future
otherwise(value) → {Future}
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 |
Object | the value that eventually completes the mapped future |
- Source:
Returns:
- Type
- Future
otherwiseEmpty() → {Future}
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:
- Type
- Future
recover(mapper) → {Future}
Parameters:
| Name | Type | Description |
|---|---|---|
mapper |
function | A function which takes the exception of a failure and returns a new future. |
- Source:
Returns:
- Type
- Future
result() → {Object}
- Source:
Returns:
- Type
- Object
setHandler(handler) → {Future}
If the future has already been completed it will be called immediately. Otherwise it will be called when the future is completed.
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function | the Handler that will be called with the result |
- Source:
Returns:
- Type
- Future
succeeded() → {boolean}
- Source:
Returns:
- Type
- boolean