Modifier and Type	Class and Description
private static enum	FutureAdapter.State

Modifier and Type	Field and Description
private final Future<S>	adaptee
private final Object	mutex
private Object	result
private FutureAdapter.State	state

Access	Constructor and Description
protected	FutureAdapter(Future<S> the future to delegate to adaptee) Constructs a new `FutureAdapter` with the given adaptee.

Method Summary

Modifier and Type	Method and Description
protected abstract T	Returns: the adapted result adapt(S adapteeResult) Adapts the given adaptee's result into T.
pack-priv final T	adaptInternal(S adapteeResult)
public boolean	cancel(boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public T	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public T	get(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
protected Future<S>	getAdaptee() Returns the adaptee.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

adaptee	back to summary
private final Future<S> adaptee

mutex	back to summary
private final Object mutex

result	back to summary
private Object result Annotations @Nullable

state	back to summary
private FutureAdapter.State state

Constructor Detail

FutureAdapter back to summary

FutureAdapter	back to summary
protected FutureAdapter(Future<S> adaptee) Constructs a new `FutureAdapter` with the given adaptee. Parameters adaptee:Future<S> the future to delegate to

protected FutureAdapter(Future<S> adaptee)

Constructs a new FutureAdapter with the given adaptee.

Parameters

adaptee:Future<S>: the future to delegate to

Method Detail

adapt	back to summary
protected abstract T adapt(S adapteeResult) throws ExecutionException Adapts the given adaptee's result into T. Returns:T the adapted result Annotations @Nullable

adapt

back to summary

protected abstract T adapt(S adapteeResult) throws ExecutionException

Adapts the given adaptee's result into T.

Returns:T

the adapted result

Annotations

@Nullable

adaptInternal	back to summary
pack-priv final T adaptInternal(S adapteeResult) throws ExecutionException Annotations @SuppressWarnings:unchecked @Nullable

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Parameters mayInterruptIfRunning:boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete Returns:boolean `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters

mayInterruptIfRunning:boolean: true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override

get	back to summary
public T get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:T the computed result Annotations @Override @Nullable Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public T get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:T

the computed result

Annotations

@Override
@Nullable

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception

get	back to summary
public T get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:T the computed result Annotations @Override @Nullable Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out

get

back to summary

public T get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:T

the computed result

Annotations

@Override
@Nullable

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out

getAdaptee	back to summary
protected Future<S> getAdaptee() Returns the adaptee.

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

org.springframework.util.concurrent back to summary

private final Enum FutureAdapter.State

Class Inheritance

extends Enum<FutureAdapter.State>

java.lang.Object
java.lang.Enum
org.springframework.util.concurrent.FutureAdapter.State

Field Summary

Modifier and Type	Field and Description
public static final FutureAdapter.State	FAILURE
public static final FutureAdapter.State	NEW
public static final FutureAdapter.State	SUCCESS

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static FutureAdapter.State	valueOf(String name)
public static FutureAdapter.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FAILURE	back to summary
public static final FutureAdapter.State FAILURE

NEW	back to summary
public static final FutureAdapter.State NEW

SUCCESS	back to summary
public static final FutureAdapter.State SUCCESS

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static FutureAdapter.State valueOf(String name)

values	back to summary
public static FutureAdapter.State[] values()

public abstract Class FutureAdapter<T, S>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum FutureAdapter.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail