CloseFuture (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.core.impl.CloseFuture

All Implemented Interfaces:

AsyncResult<Void>, Closeable, Future<Void>
```
public class CloseFuture
extends Object
implements Future<Void>, Closeable
```
An helper class for managing close operations.

Constructor Summary

Constructors
Constructor and Description

CloseFuture()

CloseFuture(Closeable resource)

Constructors
Constructor and Description
`CloseFuture()`
`CloseFuture(Closeable resource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Throwable`	`cause()` A Throwable describing failure.
`void`	`close(Promise<Void> promise)` Called by client
`<U> Future<U>`	`compose(Function<Void,Future<U>> successMapper, Function<Throwable,Future<U>> failureMapper)` Compose this future with a `successMapper` and `failureMapper` functions.
`<U> Future<Void>`	`eventually(Function<Void,Future<U>> mapper)` Compose this future with a `mapper` that will be always be called.
`boolean`	`failed()` Did it fail?
`void`	`init(Closeable closeable)`
`boolean`	`isClosed()`
`boolean`	`isComplete()` Has the future completed?
`<U> Future<U>`	`map(Function<Void,U> mapper)` Apply a `mapper` function on this future.
`<V> Future<V>`	`map(V value)` Map the result of a future to a specific `value`.
`Future<Void>`	`onComplete(Handler<AsyncResult<Void>> handler)` Add a handler to be notified of the result.
`Future<Void>`	`otherwise(Function<Throwable,Void> mapper)` Apply a `mapper` function on this future.
`Future<Void>`	`otherwise(Void value)` Map the failure of a future to a specific `value`.
`Void`	`result()` The result of the operation.
`boolean`	`succeeded()` Did it succeed?
`<U> Future<U>`	`transform(Function<AsyncResult<Void>,Future<U>> mapper)` Transform this future with a `mapper` functions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.core.Future
compose, failedFuture, failedFuture, flatMap, fromCompletionStage, fromCompletionStage, future, mapEmpty, onFailure, onSuccess, otherwiseEmpty, recover, succeededFuture, succeededFuture, toCompletionStage

- Constructor Detail
 - CloseFuture
```
public CloseFuture()
```
 - CloseFuture
```
public CloseFuture(Closeable resource)
```
- Method Detail
 - init
```
public void init(Closeable closeable)
```
 - close
```
public void close(Promise<Void> promise)
```
 Called by client
 
 Specified by:
 
 close in interface Closeable
 
 Parameters:
 
 promise - the promise to signal when close has completed
 - isClosed
```
public boolean isClosed()
```
 - isComplete
```
public boolean isComplete()
```
 Description copied from interface: Future
 
 Has the future completed?
 It's completed if it's either succeeded or failed.
 
 Specified by:
 
 isComplete in interface Future<Void>
 
 Returns:
 
 true if completed, false if not
 - onComplete
```
public Future<Void> onComplete(Handler<AsyncResult<Void>> handler)
```
 Description copied from interface: Future
 
 Add a handler to be notified of the result.
 
 Specified by:
 
 onComplete in interface Future<Void>
 
 Parameters:
 
 handler - the handler that will be called with the result
 
 Returns:
 
 a reference to this, so it can be used fluently
 - result
```
public Void result()
```
 Description copied from interface: Future
 
 The result of the operation. This will be null if the operation failed.
 
 Specified by:
 
 result in interface AsyncResult<Void>
 
 Specified by:
 
 result in interface Future<Void>
 
 Returns:
 
 the result or null if the operation failed.
 - cause
```
public Throwable cause()
```
 Description copied from interface: Future
 
 A Throwable describing failure. This will be null if the operation succeeded.
 
 Specified by:
 
 cause in interface AsyncResult<Void>
 
 Specified by:
 
 cause in interface Future<Void>
 
 Returns:
 
 the cause or null if the operation succeeded.
 - succeeded
```
public boolean succeeded()
```
 Description copied from interface: Future
 
 Did it succeed?
 
 Specified by:
 
 succeeded in interface AsyncResult<Void>
 
 Specified by:
 
 succeeded in interface Future<Void>
 
 Returns:
 
 true if it succeded or false otherwise
 - failed
```
public boolean failed()
```
 Description copied from interface: Future
 
 Did it fail?
 
 Specified by:
 
 failed in interface AsyncResult<Void>
 
 Specified by:
 
 failed in interface Future<Void>
 
 Returns:
 
 true if it failed or false otherwise
 - compose
```
public  Future compose(Function<Void,Future> successMapper,
 Function<Throwable,Future> failureMapper)
```
 Description copied from interface: Future
 
 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.
 
 Specified by:
 
 compose in interface Future<Void>
 
 Parameters:
 
 successMapper - the function mapping the success
 
 failureMapper - the function mapping the failure
 
 Returns:
 
 the composed future
 - eventually
```
public  Future<Void> eventually(Function<Void,Future> mapper)
```
 Description copied from interface: Future
 
 Compose this future with a mapper that will be always be called.
 When this future (the one on which eventually is called) completes, the mapper will be called and this mapper returns another future object. This returned future completion will complete the future returned by this method call with the original result of the future.
 The outcome of the future returned by the mapper will not influence the the nature of the returned future.
 
 Specified by:
 
 eventually in interface Future<Void>
 
 Parameters:
 
 mapper - the function returning the future.
 
 Returns:
 
 the composed future
 - transform
```
public  Future transform(Function<AsyncResult<Void>,Future> mapper)
```
 Description copied from interface: Future
 
 Transform this future with a mapper functions.
 When this future (the one on which transform is called) completes, the mapper will be called with the async result 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.
 
 Specified by:
 
 transform in interface Future<Void>
 
 Parameters:
 
 mapper - the function mapping the future
 
 Returns:
 
 the transformed future
 - map
```
public  Future map(Function<Void,U> mapper)
```
 Description copied from interface: 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.
 
 Specified by:
 
 map in interface AsyncResult<Void>
 
 Specified by:
 
 map in interface Future<Void>
 
 Parameters:
 
 mapper - the mapper function
 
 Returns:
 
 the mapped future
 - map
```
public <V> Future<V> map(V value)
```
 Description copied from interface: 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.
 
 Specified by:
 
 map in interface AsyncResult<Void>
 
 Specified by:
 
 map in interface Future<Void>
 
 Parameters:
 
 value - the value that eventually completes the mapped future
 
 Returns:
 
 the mapped future
 - otherwise
```
public Future<Void> otherwise(Function<Throwable,Void> mapper)
```
 Description copied from interface: Future
 
 Apply a mapper function on this future.
 When this future fails, 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 succeeds, the result will be propagated to the returned future and the mapper will not be called.
 
 Specified by:
 
 otherwise in interface AsyncResult<Void>
 
 Specified by:
 
 otherwise in interface Future<Void>
 
 Parameters:
 
 mapper - the mapper function
 
 Returns:
 
 the mapped future
 - otherwise
```
public Future<Void> otherwise(Void value)
```
 Description copied from interface: 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.
 
 Specified by:
 
 otherwise in interface AsyncResult<Void>
 
 Specified by:
 
 otherwise in interface Future<Void>
 
 Parameters:
 
 value - the value that eventually completes the mapped future
 
 Returns:
 
 the mapped future

Class CloseFuture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.core.Future

Constructor Detail

CloseFuture

CloseFuture

Method Detail

init

close

isClosed

isComplete

onComplete

result

cause

succeeded

failed

compose

eventually

transform

map

map

otherwise

otherwise