com.basho.riak.client.core

Interface RiakFuture<V,T>

All Superinterfaces:

Future<V>

All Known Implementing Classes:

BigIntIndexQuery.BigIntQueryFuture, BinIndexQuery.BinQueryFuture, CoreFutureAdapter, DeleteOperation, DtFetchOperation, DtUpdateOperation, FetchBucketPropsOperation, FetchOperation, FutureOperation, IntIndexQuery.IntQueryFuture, ListBucketsOperation, ListenableFuture, ListKeysOperation, MapReduceOperation, PingOperation, RawIndexQuery.RawQueryFuture, ResetBucketPropsOperation, SearchOperation, SecondaryIndexQueryOperation, StoreBucketPropsOperation, StoreOperation, YzDeleteIndexOperation, YzFetchIndexOperation, YzGetSchemaOperation, YzPutIndexOperation, YzPutSchemaOperation

public interface RiakFuture<V,T>
extends Future<V>

The result of an asynchronous Riak operation.

All Riak operations are asynchronous. It means when you execute an operation on the cluster it will return immediately with no guarantee that the requested operation has been completed at the end of the call. Instead, you will be returned a RiakFuture instance which gives you the information about the result or status of the operation.

A RiakFuture is either uncompleted or completed. When an operation begins, a new future object is created. The new future is uncompleted initially - it is neither succeeded, failed, nor canceled because the operation is not finished yet. If the operation is finished either successfully, with failure, or by cancellation, the future is marked as completed with more specific information, such as the cause of the failure. Please note that even failure and cancellation belong to the completed state.

                                      +---------------------------+
                                      | Completed successfully    |
                                      +---------------------------+
                                 +---->      isDone() = true      |
 +--------------------------+    |    |   isSuccess() = true      |
 |        Uncompleted       |    |    +===========================+
 +--------------------------+    |    | Completed with failure    |
 |      isDone() = false    |    |    +---------------------------+
 |   isSuccess() = false    |----+---->   isDone() = true         |
 | isCancelled() = false    |    |    |    cause() = non-null     |
 |       cause() = null     |    |    +===========================+
 +--------------------------+    |    | Completed by cancellation |
                                 |    +---------------------------+
                                 +---->      isDone() = true      |
                                      | isCancelled() = true      |
                                      +---------------------------+
 

Since:

2.0

Author:

Brian Roach

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RiakFutureListener<V,T> listener) Add a listener to this RiakFuture.
void	await() Waits for this RiakFuture to be completed.
void	await(long timeout, TimeUnit unit) Waits for this RiakFuture to be completed, or times out.
boolean	cancel(boolean mayInterruptIfRunning)
Throwable	cause() Return information about the operation and why it failed.
V	get()
V	get(long timeout, TimeUnit unit)
T	getQueryInfo() Returns information related to the operation performed.
boolean	isCancelled()
boolean	isDone()
boolean	isSuccess() Determine if the operation was successful.
void	removeListener(RiakFutureListener<V,T> listener) Remove a listener from this RiakFuture.

Method Detail

cancel

boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

get

V get()
      throws InterruptedException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

get

V get(long timeout,
    TimeUnit unit)
      throws InterruptedException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

isCancelled

boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

isDone

boolean isDone()

Specified by:

isDone in interface Future<V>

await

void await()
           throws InterruptedException

Waits for this RiakFuture to be completed.

Throws:

InterruptedException

await

void await(long timeout,
         TimeUnit unit)
           throws InterruptedException

Waits for this RiakFuture to be completed, or times out.

Parameters:

timeout - the amount of time to wait before returning.

unit - the unit of time.

Throws:

InterruptedException

isSuccess

boolean isSuccess()

Determine if the operation was successful.

Returns:

true if completed and successful, false otherwise.

cause

Throwable cause()

Return information about the operation and why it failed.

Returns:

The exception thrown during the operation, or null if not set.

getQueryInfo

T getQueryInfo()

Returns information related to the operation performed.

Useful in async operations when you want to know what operation this future refers to.

Returns:

Information pertaining to the operation attached to this future.

addListener

void addListener(RiakFutureListener<V,T> listener)

Add a listener to this RiakFuture.

Parameters:

listener - a FiakFutureListener that will be notified when this RiakFuture completes.

removeListener

void removeListener(RiakFutureListener<V,T> listener)

Remove a listener from this RiakFuture.

Parameters:

listener - The listener to remove.