Vert.x 4.5.13 · io.vertx.core.AsyncResult · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Throwable	Returns: the cause or null if the operation succeeded. cause() A Throwable describing failure.
public boolean	Returns: true if it failed or false otherwise failed() Did it fail?
public default <U> AsyncResult<U>	Returns: the mapped async result map(Function<T, U> the mapper function mapper) Apply a `mapper` function on this async result.
public default <V> AsyncResult<V>	Returns: the mapped async result map(V the value that eventually completes the mapped async result value) Map the result of this async result to a specific `value`.
public default <V> AsyncResult<V>	Returns: the mapped async result mapEmpty() Map the result of this async result to `null`.
public default AsyncResult<T>	Returns: the mapped async result otherwise(Function<Throwable, T> the mapper function mapper) Apply a `mapper` function on this async result.
public default AsyncResult<T>	Returns: the mapped async result otherwise(T the value that eventually completes the mapped async result value) Map the failure of this async result to a specific `value`.
public default AsyncResult<T>	Returns: the mapped async result otherwiseEmpty() Map the failure of this async result to `null`.
public T	Returns: the result or null if the operation failed. result() The result of the operation.
public boolean	Returns: true if it succeded or false otherwise succeeded() Did it succeed?

Method Detail

cause	back to summary
public Throwable cause() A Throwable describing failure. This will be null if the operation succeeded. Returns:Throwable the cause or null if the operation succeeded.

cause

back to summary

public Throwable cause()

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

Returns:Throwable: the cause or null if the operation succeeded.

failed	back to summary
public boolean failed() Did it fail? Returns:boolean true if it failed or false otherwise

failed

back to summary

public boolean failed()

Did it fail?

Returns:boolean: true if it failed or false otherwise

map back to summary

map	back to summary
public default <U> AsyncResult<U> map(Function<T, U> mapper) Apply a `mapper` function on this async result. The `mapper` is called with the completed value and this mapper returns a value. This value will complete the result returned by this method call. When this async result is failed, the failure will be propagated to the returned async result and the `mapper` will not be called. Parameters mapper:Function<T, U> the mapper function Returns:AsyncResult<U> the mapped async result

public default <U> AsyncResult<U> map(Function<T, U> mapper)

Apply a mapper function on this async result.

The mapper is called with the completed value and this mapper returns a value. This value will complete the result returned by this method call.

When this async result is failed, the failure will be propagated to the returned async result and the mapper will not be called.

Parameters

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

Returns:AsyncResult<U>

the mapped async result

map back to summary

map	back to summary
public default <V> AsyncResult<V> map(V value) Map the result of this async result to a specific `value`. When this async result succeeds, this `value` will succeeed the async result returned by this method call. When this async result fails, the failure will be propagated to the returned async result. Parameters value:V the value that eventually completes the mapped async result Returns:AsyncResult<V> the mapped async result

public default <V> AsyncResult<V> map(V value)

Map the result of this async result to a specific value.

When this async result succeeds, this value will succeeed the async result returned by this method call.

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

Parameters

value:V: the value that eventually completes the mapped async result

Returns:AsyncResult<V>

the mapped async result

mapEmpty back to summary

mapEmpty	back to summary
public default <V> AsyncResult<V> mapEmpty() Map the result of this async result to `null`. This is a convenience for `asyncResult.map((T) null)` or `asyncResult.map((Void) null)`. When this async result succeeds, `null` will succeeed the async result returned by this method call. When this async result fails, the failure will be propagated to the returned async result. Returns:AsyncResult<V> the mapped async result

public default <V> AsyncResult<V> mapEmpty()

Map the result of this async result to null.

This is a convenience for asyncResult.map((T) null) or asyncResult.map((Void) null).

When this async result succeeds, null will succeeed the async result returned by this method call.

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

Returns:AsyncResult<V>: the mapped async result

otherwise back to summary

otherwise	back to summary
public default AsyncResult<T> otherwise(Function<Throwable, T> mapper) Apply a `mapper` function on this async result. The `mapper` is called with the failure and this mapper returns a value. This value will complete the result returned by this method call. When this async result is succeeded, the value will be propagated to the returned async result and the `mapper` will not be called. Parameters mapper:Function<Throwable, T> the mapper function Returns:AsyncResult<T> the mapped async result

public default AsyncResult<T> otherwise(Function<Throwable, T> mapper)

Apply a mapper function on this async result.

The mapper is called with the failure and this mapper returns a value. This value will complete the result returned by this method call.

When this async result is succeeded, the value will be propagated to the returned async result and the mapper will not be called.

Parameters

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

Returns:AsyncResult<T>

the mapped async result

otherwise back to summary

otherwise	back to summary
public default AsyncResult<T> otherwise(T value) Map the failure of this async result to a specific `value`. When this async result fails, this `value` will succeeed the async result returned by this method call. When this async succeeds, the result will be propagated to the returned async result. Parameters value:T the value that eventually completes the mapped async result Returns:AsyncResult<T> the mapped async result

public default AsyncResult<T> otherwise(T value)

Map the failure of this async result to a specific value.

When this async result fails, this value will succeeed the async result returned by this method call.

When this async succeeds, the result will be propagated to the returned async result.

Parameters

value:T: the value that eventually completes the mapped async result

Returns:AsyncResult<T>

the mapped async result

otherwiseEmpty back to summary

otherwiseEmpty	back to summary
public default AsyncResult<T> otherwiseEmpty() Map the failure of this async result to `null`. This is a convenience for `asyncResult.otherwise((T) null)`. When this async result fails, the `null` will succeeed the async result returned by this method call. When this async succeeds, the result will be propagated to the returned async result. Returns:AsyncResult<T> the mapped async result

public default AsyncResult<T> otherwiseEmpty()

Map the failure of this async result to null.

This is a convenience for asyncResult.otherwise((T) null).

When this async result fails, the null will succeeed the async result returned by this method call.

When this async succeeds, the result will be propagated to the returned async result.

Returns:AsyncResult<T>: the mapped async result

result	back to summary
public T result() The result of the operation. This will be null if the operation failed. Returns:T the result or null if the operation failed.

result

back to summary

public T result()

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

Returns:T: the result or null if the operation failed.

succeeded	back to summary
public boolean succeeded() Did it succeed? Returns:boolean true if it succeded or false otherwise

succeeded

back to summary

public boolean succeeded()

Did it succeed?

Returns:boolean: true if it succeded or false otherwise

public Interface AsyncResult<T>

Method Summary

Method Detail