org.springframework.scheduling.annotation

Class AsyncResult<V>

java.lang.Object

org.springframework.scheduling.annotation.AsyncResult<V>

All Implemented Interfaces:

Future<V>, ListenableFuture<V>

public class AsyncResult<V>
extends Object
implements ListenableFuture<V>

A pass-through Future handle that can be used for method signatures which are declared with a Future return type for asynchronous execution.

As of Spring 4.1, this class implements ListenableFuture, not just plain Future, along with the corresponding support in @Async processing.

As of Spring 4.2, this class also supports passing execution exceptions back to the caller.

Since:

3.0

Author:

Juergen Hoeller

See Also:

Async, forValue(Object), forExecutionException(Throwable)

Constructor Summary

Constructors

Constructor and Description
AsyncResult(V value) Create a new AsyncResult holder.

Method Summary

Modifier and Type	Method and Description
void	addCallback(ListenableFutureCallback<? super V> callback) Registers the given callback to this ListenableFuture.
void	addCallback(SuccessCallback<? super V> successCallback, FailureCallback failureCallback) Registers the given success and failure callbacks to this ListenableFuture.
boolean	cancel(boolean mayInterruptIfRunning)
static <V> ListenableFuture<V>	forExecutionException(Throwable ex) Create a new async result which exposes the given exception as an ExecutionException from Future.get().
static <V> ListenableFuture<V>	forValue(V value) Create a new async result which exposes the given value from Future.get().
V	get()
V	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncResult

public AsyncResult(V value)

Create a new AsyncResult holder.

Parameters:

value - the value to pass through

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

get

public V get()
      throws ExecutionException

Specified by:

get in interface Future<V>

Throws:

ExecutionException

get

public V get(long timeout,
             TimeUnit unit)
      throws ExecutionException

Specified by:

get in interface Future<V>

Throws:

ExecutionException

addCallback

public void addCallback(ListenableFutureCallback<? super V> callback)

Description copied from interface: ListenableFuture

Registers the given callback to this ListenableFuture. The callback will be triggered when this Future is complete or, if it is already complete, immediately.

Specified by:

addCallback in interface ListenableFuture<V>

Parameters:

callback - the callback to register

addCallback

public void addCallback(SuccessCallback<? super V> successCallback,
                        FailureCallback failureCallback)

Description copied from interface: ListenableFuture

Registers the given success and failure callbacks to this ListenableFuture. The callback will be triggered when this Future is complete or, if it is already complete immediately. This is a Java 8 lambdas compliant alternative to ListenableFuture.addCallback(ListenableFutureCallback).

Specified by:

addCallback in interface ListenableFuture<V>

Parameters:

successCallback - the success callback to register

failureCallback - the failure callback to register

forValue

public static <V> ListenableFuture<V> forValue(V value)

Create a new async result which exposes the given value from Future.get().

Parameters:

value - the value to expose

Since:

4.2

See Also:

Future.get()

forExecutionException

public static <V> ListenableFuture<V> forExecutionException(Throwable ex)

Create a new async result which exposes the given exception as an ExecutionException from Future.get().

Parameters:

ex - the exception to expose (either an pre-built ExecutionException or a cause to be wrapped in an ExecutionException)

Since:

4.2

See Also:

ExecutionException