Vert.x 4.5.13 · io.vertx.core.impl.future.SucceededFuture

Modifier and Type	Field and Description
public static final SucceededFuture<T>	EMPTY Stateless instance of empty results that can be shared safely.
private final T	result

Access	Constructor and Description
public	SucceededFuture(T the result result) Create a future that has already succeeded
public	SucceededFuture(ContextInternal the context context, T the result result) Create a future that has already succeeded

Method Summary

Modifier and Type	Method and Description
public void	addListener(Listener<T> the listener listener) Implements io.vertx.core.impl.future.FutureInternal.addListener. Add a listener to the future result.
public Throwable	cause() Implements io.vertx.core.Future.cause. A Throwable describing failure.
public boolean	failed() Implements io.vertx.core.Future.failed. Did it fail?
public boolean	isComplete() Implements io.vertx.core.Future.isComplete. Has the future completed?
public <V> Future<V>	map(V the value that eventually completes the mapped future value) Overrides io.vertx.core.impl.future.FutureBase.map. Implements io.vertx.core.Future.map. Map the result of a future to a specific `value`.
public Future<T>	onComplete(Handler<AsyncResult<T>> the handler that will be called with the result handler) Implements io.vertx.core.Future.onComplete. Add a handler to be notified of the result.
public Future<T>	onFailure(Handler<Throwable> the handler that will be called with the failed result handler) Overrides default io.vertx.core.Future.onFailure. Add a handler to be notified of the failed result.
public Future<T>	onSuccess(Handler<T> the handler that will be called with the succeeded result handler) Overrides default io.vertx.core.Future.onSuccess. Add a handler to be notified of the succeeded result.
public Future<T>	otherwise(Function<Throwable, T> the mapper function mapper) Overrides io.vertx.core.impl.future.FutureBase.otherwise, io.vertx.core.impl.future.FutureBase.otherwise. Implements io.vertx.core.Future.otherwise, io.vertx.core.Future.otherwise. Apply a `mapper` function on this future.
public Future<T>	otherwise(T the value that eventually completes the mapped future value) Overrides io.vertx.core.impl.future.FutureBase.otherwise. Implements io.vertx.core.Future.otherwise. Map the failure of a future to a specific `value`.
public void	removeListener(Listener<T> the listener listener) Implements io.vertx.core.impl.future.FutureInternal.removeListener. Remove a listener to the future result.
public T	result() Implements io.vertx.core.Future.result. The result of the operation.
public boolean	succeeded() Implements io.vertx.core.Future.succeeded. Did it succeed?
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from io.vertx.core.impl.future.FutureBase:: compose context emitFailure emitSuccess eventually expecting map timeout transform

EMPTY	back to summary
public static final SucceededFuture<T> EMPTY Stateless instance of empty results that can be shared safely.

result	back to summary
private final T result

SucceededFuture	back to summary
public SucceededFuture(T result) Create a future that has already succeeded Parameters result:T the result

SucceededFuture	back to summary
public SucceededFuture(ContextInternal context, T result) Create a future that has already succeeded Parameters context:ContextInternal the context result:T the result

Method Detail

addListener	back to summary
public void addListener(Listener<T> listener) Implements io.vertx.core.impl.future.FutureInternal.addListener. Doc from io.vertx.core.impl.future.FutureInternal.addListener. Add a listener to the future result. Parameters listener:Listener<T> the listener Annotations @Override

addListener

back to summary

public void addListener(Listener<T> listener)

Implements io.vertx.core.impl.future.FutureInternal.addListener.

Doc from io.vertx.core.impl.future.FutureInternal.addListener.

Add a listener to the future result.

Parameters

listener:Listener<T>: the listener

Annotations

@Override

cause	back to summary
public Throwable cause() Implements io.vertx.core.Future.cause. Doc from io.vertx.core.Future.cause. A Throwable describing failure. This will be null if the operation succeeded. Returns:Throwable the cause or null if the operation succeeded. Annotations @Override

cause

back to summary

public Throwable cause()

Implements io.vertx.core.Future.cause.

Doc from io.vertx.core.Future.cause.

A Throwable describing failure. This will be null if the operation succeeded.

Returns:Throwable

the cause or null if the operation succeeded.

Annotations

@Override

failed	back to summary
public boolean failed() Implements io.vertx.core.Future.failed. Doc from io.vertx.core.Future.failed. Did it fail? Returns:boolean true if it failed or false otherwise Annotations @Override

failed

back to summary

public boolean failed()

Implements io.vertx.core.Future.failed.

Doc from io.vertx.core.Future.failed.

Did it fail?

Returns:boolean

true if it failed or false otherwise

Annotations

@Override

isComplete	back to summary
public boolean isComplete() Implements io.vertx.core.Future.isComplete. Doc from io.vertx.core.Future.isComplete. Has the future completed? It's completed if it's either succeeded or failed. Returns:boolean true if completed, false if not Annotations @Override

isComplete

back to summary

public boolean isComplete()

Implements io.vertx.core.Future.isComplete.

Doc from io.vertx.core.Future.isComplete.

Has the future completed?

It's completed if it's either succeeded or failed.

Returns:boolean

true if completed, false if not

Annotations

@Override

map back to summary

map	back to summary
public <V> Future<V> map(V value) Overrides io.vertx.core.impl.future.FutureBase.map. Implements io.vertx.core.Future.map. Doc from io.vertx.core.Future.map. 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 value:V the value that eventually completes the mapped future Returns:Future<V> the mapped future Annotations @Override

public <V> Future<V> map(V value)

Overrides io.vertx.core.impl.future.FutureBase.map.

Implements io.vertx.core.Future.map.

Doc from io.vertx.core.Future.map.

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

value:V: the value that eventually completes the mapped future

Returns:Future<V>

the mapped future

Annotations

@Override

onComplete back to summary

onComplete	back to summary
public Future<T> onComplete(Handler<AsyncResult<T>> handler) Implements io.vertx.core.Future.onComplete. Doc from io.vertx.core.Future.onComplete. Add a handler to be notified of the result. Warning this is a terminal operation. If several `handler`s are registered, there is no guarantee that they will be invoked in order of registration. Parameters handler:Handler<AsyncResult<T>> the handler that will be called with the result Returns:Future<T> a reference to this, so it can be used fluently Annotations @Override

public Future<T> onComplete(Handler<AsyncResult<T>> handler)

Implements io.vertx.core.Future.onComplete.

Doc from io.vertx.core.Future.onComplete.

Add a handler to be notified of the result.

Warning

this is a terminal operation. If several handlers are registered, there is no guarantee that they will be invoked in order of registration.

Parameters

handler:Handler<AsyncResult<T>>: the handler that will be called with the result

Returns:Future<T>

a reference to this, so it can be used fluently

Annotations

@Override

onFailure back to summary

onFailure	back to summary
public Future<T> onFailure(Handler<Throwable> handler) Overrides default io.vertx.core.Future.onFailure. Doc from io.vertx.core.Future.onFailure. Add a handler to be notified of the failed result. Warning this is a terminal operation. If several `handler`s are registered, there is no guarantee that they will be invoked in order of registration. Parameters handler:Handler<Throwable> the handler that will be called with the failed result Returns:Future<T> a reference to this, so it can be used fluently Annotations @Override

public Future<T> onFailure(Handler<Throwable> handler)

Overrides default io.vertx.core.Future.onFailure.

Doc from io.vertx.core.Future.onFailure.

Add a handler to be notified of the failed result.

Warning

this is a terminal operation. If several handlers are registered, there is no guarantee that they will be invoked in order of registration.

Parameters

handler:Handler<Throwable>: the handler that will be called with the failed result

Returns:Future<T>

a reference to this, so it can be used fluently

Annotations

@Override

onSuccess back to summary

onSuccess	back to summary
public Future<T> onSuccess(Handler<T> handler) Overrides default io.vertx.core.Future.onSuccess. Doc from io.vertx.core.Future.onSuccess. Add a handler to be notified of the succeeded result. Warning this is a terminal operation. If several `handler`s are registered, there is no guarantee that they will be invoked in order of registration. Parameters handler:Handler<T> the handler that will be called with the succeeded result Returns:Future<T> a reference to this, so it can be used fluently Annotations @Override

public Future<T> onSuccess(Handler<T> handler)

Overrides default io.vertx.core.Future.onSuccess.

Doc from io.vertx.core.Future.onSuccess.

Add a handler to be notified of the succeeded result.

Warning

this is a terminal operation. If several handlers are registered, there is no guarantee that they will be invoked in order of registration.

Parameters

handler:Handler<T>: the handler that will be called with the succeeded result

Returns:Future<T>

a reference to this, so it can be used fluently

Annotations

@Override

otherwise back to summary

otherwise	back to summary
public Future<T> otherwise(Function<Throwable, T> mapper) Overrides io.vertx.core.impl.future.FutureBase.otherwise, io.vertx.core.impl.future.FutureBase.otherwise. Implements io.vertx.core.Future.otherwise, io.vertx.core.Future.otherwise. Doc from io.vertx.core.Future.otherwise. 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. Parameters mapper:Function<Throwable, T> the mapper function Returns:Future<T> the mapped future Annotations @Override

public Future<T> otherwise(Function<Throwable, T> mapper)

Overrides io.vertx.core.impl.future.FutureBase.otherwise, io.vertx.core.impl.future.FutureBase.otherwise.

Implements io.vertx.core.Future.otherwise, io.vertx.core.Future.otherwise.

Doc from io.vertx.core.Future.otherwise.

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.

Parameters

mapper:Function<Throwable, T>: the mapper function

Returns:Future<T>

the mapped future

Annotations

@Override

otherwise back to summary

otherwise	back to summary
public Future<T> otherwise(T value) Overrides io.vertx.core.impl.future.FutureBase.otherwise. Implements io.vertx.core.Future.otherwise. Doc from io.vertx.core.Future.otherwise. 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 value:T the value that eventually completes the mapped future Returns:Future<T> the mapped future Annotations @Override

public Future<T> otherwise(T value)

Overrides io.vertx.core.impl.future.FutureBase.otherwise.

Implements io.vertx.core.Future.otherwise.

Doc from io.vertx.core.Future.otherwise.

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

value:T: the value that eventually completes the mapped future

Returns:Future<T>

the mapped future

Annotations

@Override

removeListener	back to summary
public void removeListener(Listener<T> listener) Implements io.vertx.core.impl.future.FutureInternal.removeListener. Doc from io.vertx.core.impl.future.FutureInternal.removeListener. Remove a listener to the future result. Parameters listener:Listener<T> the listener Annotations @Override

removeListener

back to summary

public void removeListener(Listener<T> listener)

Implements io.vertx.core.impl.future.FutureInternal.removeListener.

Doc from io.vertx.core.impl.future.FutureInternal.removeListener.

Remove a listener to the future result.

Parameters

listener:Listener<T>: the listener

Annotations

@Override

result	back to summary
public T result() Implements io.vertx.core.Future.result. Doc from io.vertx.core.Future.result. The result of the operation. This will be null if the operation failed. Returns:T the result or null if the operation failed. Annotations @Override

result

back to summary

public T result()

Implements io.vertx.core.Future.result.

Doc from io.vertx.core.Future.result.

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

Returns:T

the result or null if the operation failed.

Annotations

@Override

succeeded	back to summary
public boolean succeeded() Implements io.vertx.core.Future.succeeded. Doc from io.vertx.core.Future.succeeded. Did it succeed? Returns:boolean true if it succeded or false otherwise Annotations @Override

succeeded

back to summary

public boolean succeeded()

Implements io.vertx.core.Future.succeeded.

Doc from io.vertx.core.Future.succeeded.

Did it succeed?

Returns:boolean

true if it succeded or false otherwise

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class SucceededFuture<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail