Package org.elasticsearch.action.support

Class ListenableActionFuture<T>

java.lang.Object

org.elasticsearch.common.util.concurrent.BaseFuture<T>

org.elasticsearch.action.support.AdapterActionFuture<T,T>

org.elasticsearch.action.support.ListenableActionFuture<T>

All Implemented Interfaces:

Future<T>, ActionFuture<T>, ActionListener<T>

public class ListenableActionFuture<T>
extends AdapterActionFuture<T,T>

A Future and ActionListener against which which other ActionListeners can be registered later, to support fanning-out a result to a dynamic collection of listeners.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.ActionListener

ActionListener.Delegating<Response,DelegateResponse>, ActionListener.DelegatingActionListener<T>, ActionListener.DelegatingFailureActionListener<T,R>, ActionListener.MappedActionListener<Response,MappedResponse>, ActionListener.RunAfterActionListener<T>, ActionListener.RunBeforeActionListener<T>

Constructor Summary

Constructors

Constructor	Description
ListenableActionFuture()

Method Summary

Modifier and Type	Method	Description
void	addListener(ActionListener<T> listener)	Registers an ActionListener to be notified when this future is completed.
protected T	convert(T listenerResponse)
protected void	done(boolean success)	Called when the BaseFuture is completed.

Methods inherited from class org.elasticsearch.action.support.AdapterActionFuture

actionGet, actionGet, actionGet, actionGet, actionGet, onFailure, onResponse

Methods inherited from class org.elasticsearch.common.util.concurrent.BaseFuture

blockingAllowed, cancel, get, get, interruptTask, isCancelled, isDone, set, setException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateResponse, map

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Constructor Details

ListenableActionFuture

public ListenableActionFuture()

Method Details

addListener

public void addListener(ActionListener<T> listener)

Registers an ActionListener to be notified when this future is completed. If the future is already completed then the listener is notified immediately, on the calling thread. If not, the listener is notified on the thread that completes the listener.

done

protected void done(boolean success)

Description copied from class: BaseFuture

Called when the BaseFuture is completed. The success boolean indicates if the BaseFuture was successfully completed (the value is true). In the cases the BaseFuture was completed with an error or cancelled the value is false.

Overrides:

done in class BaseFuture<T>

Parameters:

success - indicates if the BaseFuture was completed with success (true); in other cases it equals to false

convert

protected T convert(T listenerResponse)

Specified by:

convert in class AdapterActionFuture<T,T>