org.springframework.util.concurrent

Interface ListenableFuture<T>

All Superinterfaces:

java.util.concurrent.Future<T>

All Known Implementing Classes:

AbstractPromiseToListenableFutureAdapter, AsyncRestTemplate.ResponseExtractorFuture, AsyncResult, CompletableToListenableFutureAdapter, HttpComponentsAsyncClientHttpRequest.ClientHttpResponseFuture, ListenableFutureAdapter, ListenableFutureTask, OkHttpClientHttpRequest.OkHttpListenableFuture, PassThroughPromiseToListenableFutureAdapter, SettableListenableFuture

public interface ListenableFuture<T>
extends java.util.concurrent.Future<T>

Extends the Future interface with the capability to accept completion callbacks. If the future has already completed when the callback is added, the callback will be triggered immediately.

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

Since:

4.0

Author:

Arjen Poutsma, Sebastien Deleuze

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.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

addCallback

void addCallback(ListenableFutureCallback<? super T> callback)

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

Parameters:

callback - the callback to register

addCallback

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

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 addCallback(ListenableFutureCallback).

Parameters:

successCallback - the success callback to register

failureCallback - the failure callback to register

Since:

4.1