org.springframework.scheduling.annotation

Class AsyncResult<V>

java.lang.Object

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

All Implemented Interfaces:

java.util.concurrent.Future<V>, ListenableFuture<V>

public class AsyncResult<V>
extends java.lang.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.

Since:

3.0

Author:

Juergen Hoeller

See Also:

Async

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)
V	get()
V	get(long timeout, java.util.concurrent.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 java.util.concurrent.Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

get

public V get()

Specified by:

get in interface java.util.concurrent.Future<V>

get

public V get(long timeout,
             java.util.concurrent.TimeUnit unit)

Specified by:

get in interface java.util.concurrent.Future<V>

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