Module org.elasticsearch.server

Package org.elasticsearch.action.support

Class PlainActionFuture<T>

java.lang.Object

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

All Implemented Interfaces:

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

public class PlainActionFuture<T>
extends Object
implements ActionFuture<T>, ActionListener<T>

Constructor Summary

Constructors

Constructor	Description
PlainActionFuture()

Method Summary

Modifier and Type	Method	Description
T	actionGet()	Similar to Future.get(), just catching the InterruptedException and throwing an IllegalStateException instead.
T	actionGet(long timeout, TimeUnit unit)	Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an IllegalStateException instead.
T	actionGet(TimeValue timeout)	Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an IllegalStateException instead.
T	actionResult()	Return the result of this future, if it has been completed successfully, or unwrap and throw the exception with which it was completed exceptionally.
protected boolean	blockingAllowed()
boolean	cancel(boolean mayInterruptIfRunning)
protected void	done(boolean success)	Called when the PlainActionFuture<Object> is completed.
T	get()
T	get(long timeout, TimeUnit unit)
static <T, E extends Exception> T	get(CheckedConsumer<PlainActionFuture<T>,E> e)
static <T, E extends Exception> T	get(CheckedConsumer<PlainActionFuture<T>,E> e, long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
void	onFailure(Exception e)	A failure caused by an exception at some phase of the task.
void	onResponse(T result)	Handle action response.
T	result()	Return the result of this future, similarly to FutureUtils.get(java.util.concurrent.Future<T>) with a zero timeout except that this method ignores the interrupted status of the calling thread.
protected final boolean	set(T value)	Subclasses should invoke this method to set the result of the computation to value.

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, delegateFailureAndWrap, delegateResponse, map, safeMap

Constructor Details

PlainActionFuture

public PlainActionFuture()

Method Details

onResponse

public void onResponse(@Nullable
 T result)

Description copied from interface: ActionListener

Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.

Specified by:

onResponse in interface ActionListener<T>

onFailure

public void onFailure(Exception e)

Description copied from interface: ActionListener

A failure caused by an exception at some phase of the task.

Specified by:

onFailure in interface ActionListener<T>

get

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

The default PlainActionFuture implementation throws InterruptedException if the current thread is interrupted before or during the call, even if the value is already available.

Specified by:

get in interface Future<T>

Throws:

InterruptedException - if the current thread was interrupted before or during the call (optional but recommended).

CancellationException

TimeoutException

ExecutionException

get

public T get()
      throws InterruptedException,
ExecutionException

The default PlainActionFuture<Object> implementation throws InterruptedException if the current thread is interrupted before or during the call, even if the value is already available.

Specified by:

get in interface Future<T>

Throws:

InterruptedException - if the current thread was interrupted before or during the call (optional but recommended).

CancellationException

ExecutionException

blockingAllowed

protected boolean blockingAllowed()

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

set

protected final boolean set(@Nullable
 T value)

Subclasses should invoke this method to set the result of the computation to value. This will set the state of the future to PlainActionFuture.Sync.COMPLETED and call done(boolean) if the state was successfully changed.

Parameters:

value - the value that was the result of the task.

Returns:

true if the state was successfully changed.

done

protected void done(boolean success)

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

Parameters:

success - indicates if the PlainActionFuture<Object> was completed with success (true); in other cases it equals false

actionGet

public T actionGet()

Description copied from interface: ActionFuture

Similar to Future.get(), just catching the InterruptedException and throwing an IllegalStateException instead. Also catches ExecutionException and throws the actual cause instead.

Specified by:

actionGet in interface ActionFuture<T>

actionGet

public T actionGet(TimeValue timeout)

Description copied from interface: ActionFuture

Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an IllegalStateException instead. Also catches ExecutionException and throws the actual cause instead.

Specified by:

actionGet in interface ActionFuture<T>

actionGet

public T actionGet(long timeout,
 TimeUnit unit)

Description copied from interface: ActionFuture

Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an IllegalStateException instead. Also catches ExecutionException and throws the actual cause instead.

Specified by:

actionGet in interface ActionFuture<T>

result

public T result()

Return the result of this future, similarly to FutureUtils.get(java.util.concurrent.Future<T>) with a zero timeout except that this method ignores the interrupted status of the calling thread.

As with FutureUtils.get(java.util.concurrent.Future<T>), if the future completed exceptionally with a RuntimeException then this method throws that exception, but if the future completed exceptionally with an exception that is not a RuntimeException then this method throws an UncategorizedExecutionException whose cause is an ExecutionException whose cause is the completing exception.

It is not valid to call this method if the future is incomplete.

Returns:

the result of this future, if it has been completed successfully.

Throws:

RuntimeException - if this future was completed exceptionally, wrapping checked exceptions as described above.

CancellationException - if this future was cancelled.

actionResult

public T actionResult()

Return the result of this future, if it has been completed successfully, or unwrap and throw the exception with which it was completed exceptionally. It is not valid to call this method if the future is incomplete.

get

public static <T,
E extends Exception> T get(CheckedConsumer<PlainActionFuture<T>,E> e)
                                     throws E

Throws:

E extends Exception

get

public static <T,
E extends Exception> T get(CheckedConsumer<PlainActionFuture<T>,E> e,
 long timeout,
 TimeUnit unit)
                                     throws E

Throws:

E extends Exception