org.elasticsearch.action

Interface ActionFuture<T>

All Superinterfaces:

Future<T>

All Known Subinterfaces:

ListenableActionFuture<T>

All Known Implementing Classes:

AbstractListenableActionFuture, AdapterActionFuture, PlainActionFuture, PlainListenableActionFuture

public interface ActionFuture<T>
extends Future<T>

An extension to Future allowing for simplified "get" operations.

Method Summary

Modifier and Type	Method and Description
T	actionGet() Similar to Future.get(), just catching the InterruptedException and throwing an ElasticsearchIllegalStateException instead.
T	actionGet(long timeoutMillis) Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an ElasticsearchIllegalStateException instead.
T	actionGet(long timeout, TimeUnit unit) Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an ElasticsearchIllegalStateException instead.
T	actionGet(String timeout) Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an ElasticsearchIllegalStateException instead.
T	actionGet(TimeValue timeout) Similar to Future.get(long, java.util.concurrent.TimeUnit), just catching the InterruptedException and throwing an ElasticsearchIllegalStateException instead.
Throwable	getRootFailure() The root (possibly) wrapped failure.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

actionGet

T actionGet()
     throws ElasticsearchException

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

Note, the actual cause is unwrapped to the actual failure (for example, unwrapped from RemoteTransportException. The root failure is still accessible using getRootFailure().

Throws:

ElasticsearchException

actionGet

T actionGet(String timeout)
     throws ElasticsearchException

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

Note, the actual cause is unwrapped to the actual failure (for example, unwrapped from RemoteTransportException. The root failure is still accessible using getRootFailure().

Throws:

ElasticsearchException

actionGet

T actionGet(long timeoutMillis)
     throws ElasticsearchException

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

Note, the actual cause is unwrapped to the actual failure (for example, unwrapped from RemoteTransportException. The root failure is still accessible using getRootFailure().

Parameters:

timeoutMillis - Timeout in millis

Throws:

ElasticsearchException

actionGet

T actionGet(long timeout,
            TimeUnit unit)
     throws ElasticsearchException

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

Note, the actual cause is unwrapped to the actual failure (for example, unwrapped from RemoteTransportException. The root failure is still accessible using getRootFailure().

Throws:

ElasticsearchException

actionGet

T actionGet(TimeValue timeout)
     throws ElasticsearchException

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

Note, the actual cause is unwrapped to the actual failure (for example, unwrapped from RemoteTransportException. The root failure is still accessible using getRootFailure().

Throws:

ElasticsearchException

getRootFailure

@Nullable
Throwable getRootFailure()

The root (possibly) wrapped failure.