org.springframework.util.concurrent

Class SettableListenableFuture<T>

java.lang.Object

org.springframework.util.concurrent.SettableListenableFuture<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

OkHttpClientHttpRequest.OkHttpListenableFuture

public class SettableListenableFuture<T>
extends java.lang.Object
implements ListenableFuture<T>

A ListenableFuture whose value can be set via set(Object) or setException(Throwable). It may also be cancelled.

Inspired by com.google.common.util.concurrent.SettableFuture.

Since:

4.1

Author:

Mattias Severson, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SettableListenableFuture.SettableTask<T>

Field Summary

Fields

Modifier and Type	Field and Description
private ListenableFutureTask<T>	listenableFuture
private SettableListenableFuture.SettableTask<T>	settableTask

Constructor Summary

Constructors

Constructor and Description
SettableListenableFuture()

Method Summary

Modifier and Type	Method and Description
void	addCallback(ListenableFutureCallback<? super T> callback) Registers the given callback to this ListenableFuture.
void	addCallback(SuccessCallback<? super T> successCallback, FailureCallback failureCallback) Registers the given success and failure callbacks to this ListenableFuture.
boolean	cancel(boolean mayInterruptIfRunning)
T	get() Retrieve the value.
T	get(long timeout, java.util.concurrent.TimeUnit unit) Retrieve the value.
protected void	interruptTask() Subclasses can override this method to implement interruption of the future's computation.
boolean	isCancelled()
boolean	isDone()
boolean	set(T value) Set the value of this future.
boolean	setException(java.lang.Throwable exception) Set the exception of this future.

Methods inherited from class java.lang.Object

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

Field Detail

settableTask

private final SettableListenableFuture.SettableTask<T> settableTask

listenableFuture

private final ListenableFutureTask<T> listenableFuture

Constructor Detail

SettableListenableFuture

public SettableListenableFuture()

Method Detail

set

public boolean set(T value)

Set the value of this future. This method will return true if the value was set successfully, or false if the future has already been set or cancelled.

Parameters:

value - the value that will be set.

Returns:

true if the value was successfully set, else false.

setException

public boolean setException(java.lang.Throwable exception)

Set the exception of this future. This method will return true if the exception was set successfully, or false if the future has already been set or cancelled.

Parameters:

exception - the value that will be set.

Returns:

true if the exception was successfully set, else false.

addCallback

public void addCallback(ListenableFutureCallback<? super T> 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<T>

Parameters:

callback - the callback to register

addCallback

public void addCallback(SuccessCallback<? super T> 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<T>

Parameters:

successCallback - the success callback to register

failureCallback - the failure callback to register

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<T>

isCancelled

public boolean isCancelled()

Specified by:

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

isDone

public boolean isDone()

Specified by:

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

get

public T get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Retrieve the value.

Will return the value if it has been set via set(Object), throw an ExecutionException if it has been set via setException(Throwable) or throw a CancellationException if it has been cancelled.

Specified by:

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

Returns:

The value associated with this future.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public T get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Retrieve the value.

Will return the value if it has been set via set(Object), throw an ExecutionException if it has been set via setException(Throwable) or throw a CancellationException if it has been cancelled.

Specified by:

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

Parameters:

timeout - the maximum time to wait.

unit - the time unit of the timeout argument.

Returns:

The value associated with this future.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

interruptTask

protected void interruptTask()

Subclasses can override this method to implement interruption of the future's computation. The method is invoked automatically by a successful call to cancel(true).

The default implementation does nothing.