io.vertx.core.impl

Class FailedFuture<T>

java.lang.Object

io.vertx.core.impl.FailedFuture<T>

All Implemented Interfaces:

AsyncResult<T>, Future<T>, Handler<AsyncResult<T>>, Promise<T>

public class FailedFuture<T>
extends Object
implements Future<T>, Promise<T>

Author:

Julien Viet

Field Summary

Fields inherited from interface io.vertx.core.Future

factory

Method Summary

Modifier and Type	Method and Description
Throwable	cause() A Throwable describing failure.
void	complete() Set a null result.
void	complete(T result) Set the result.
void	fail(String failureMessage) Try to set the failure.
void	fail(Throwable cause) Set the failure.
boolean	failed() Did it fail?
Future<T>	future()
void	handle(AsyncResult<T> asyncResult) Succeed or fail this future with the AsyncResult event.
boolean	isComplete() Has the future completed?
Future<T>	onComplete(Handler<AsyncResult<T>> handler) Add a handler to be notified of the result.
T	result() The result of the operation.
boolean	succeeded() Did it succeed?
String	toString()
boolean	tryComplete() Try to set the result.
boolean	tryComplete(T result) Set the failure.
boolean	tryFail(String failureMessage) Try to set the failure.
boolean	tryFail(Throwable cause) Try to set the failure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.core.Future

completer, compose, compose, compose, failedFuture, failedFuture, flatMap, fromCompletionStage, fromCompletionStage, future, future, map, map, mapEmpty, onFailure, onSuccess, otherwise, otherwise, otherwiseEmpty, recover, setHandler, succeededFuture, succeededFuture, toCompletionStage

Methods inherited from interface io.vertx.core.Promise

promise

Method Detail

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

Returns:

true if completed, false if not

onComplete

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

Description copied from interface: Future

Add a handler to be notified of the result.

Specified by:

onComplete in interface Future<T>

Parameters:

handler - the handler that will be called with the result

Returns:

a reference to this, so it can be used fluently

complete

public void complete(T result)

Description copied from interface: Future

Set the result. Any handler will be called, if there is one, and the future will be marked as completed.

Specified by:

complete in interface Future<T>

Specified by:

complete in interface Promise<T>

Parameters:

result - the result

complete

public void complete()

Description copied from interface: Future

Set a null result. Any handler will be called, if there is one, and the future will be marked as completed.

Specified by:

complete in interface Future<T>

Specified by:

complete in interface Promise<T>

fail

public void fail(Throwable cause)

Description copied from interface: Future

Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.

Specified by:

fail in interface Future<T>

Specified by:

fail in interface Promise<T>

Parameters:

cause - the failure cause

fail

public void fail(String failureMessage)

Description copied from interface: Future

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.

Specified by:

fail in interface Future<T>

Specified by:

fail in interface Promise<T>

Parameters:

failureMessage - the failure message

tryComplete

public boolean tryComplete(T result)

Description copied from interface: Future

Set the failure. Any handler will be called, if there is one, and the future will be marked as completed.

Specified by:

tryComplete in interface Future<T>

Specified by:

tryComplete in interface Promise<T>

Parameters:

result - the result

Returns:

false when the future is already completed

tryComplete

public boolean tryComplete()

Description copied from interface: Future

Try to set the result. When it happens, any handler will be called, if there is one, and the future will be marked as completed.

Specified by:

tryComplete in interface Future<T>

Specified by:

tryComplete in interface Promise<T>

Returns:

false when the future is already completed

tryFail

public boolean tryFail(Throwable cause)

Description copied from interface: Future

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.

Specified by:

tryFail in interface Future<T>

Specified by:

tryFail in interface Promise<T>

Parameters:

cause - the failure cause

Returns:

false when the future is already completed

tryFail

public boolean tryFail(String failureMessage)

Description copied from interface: Future

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.

Specified by:

tryFail in interface Future<T>

Specified by:

tryFail in interface Promise<T>

Parameters:

failureMessage - the failure message

Returns:

false when the future is already completed

result

public T 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<T>

Specified by:

result in interface Future<T>

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

Specified by:

cause in interface Future<T>

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

Specified by:

succeeded in interface Future<T>

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

Specified by:

failed in interface Future<T>

Returns:

true if it failed or false otherwise

handle

public void handle(AsyncResult<T> asyncResult)

Description copied from interface: Future

Succeed or fail this future with the AsyncResult event.

Specified by:

handle in interface Future<T>

Specified by:

handle in interface Handler<AsyncResult<T>>

Specified by:

handle in interface Promise<T>

Parameters:

asyncResult - the async result to handle

future

public Future<T> future()

Specified by:

future in interface Promise<T>

Returns:

the Future associated with this promise, it can be used to be aware of the promise completion

toString

public String toString()

Overrides:

toString in class Object