com.basho.riak.client.core

Class FutureOperation<T,U,S>

java.lang.Object

com.basho.riak.client.core.FutureOperation<T,U,S>

Type Parameters:

T - The type the operation returns

U - The protocol type returned

S - Query info type

All Implemented Interfaces:

RiakFuture<T,S>, Future<T>

Direct Known Subclasses:

DeleteOperation, DtFetchOperation, DtUpdateOperation, FetchBucketPropsOperation, FetchOperation, ListBucketsOperation, ListKeysOperation, MapReduceOperation, PingOperation, ResetBucketPropsOperation, SearchOperation, SecondaryIndexQueryOperation, StoreBucketPropsOperation, StoreOperation, YzDeleteIndexOperation, YzFetchIndexOperation, YzGetSchemaOperation, YzPutIndexOperation, YzPutSchemaOperation

public abstract class FutureOperation<T,U,S>
extends Object
implements RiakFuture<T,S>

Since:

2.0

Author:

Brian Roach

Constructor Summary

Constructors

Constructor and Description
FutureOperation()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RiakFutureListener<T,S> 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.
Object	channelMessage()
protected abstract T	convert(List<U> rawResponse)
protected abstract RiakMessage	createChannelMessage()
protected abstract U	decode(RiakMessage rawMessage)
protected boolean	done(U message) Detect when the streaming operation is finished
T	get()
T	get(long timeout, TimeUnit unit)
abstract S	getQueryInfo() Returns information related to the operation performed.
boolean	isCancelled()
boolean	isDone()
boolean	isSuccess() Determine if the operation was successful.
void	removeListener(RiakFutureListener<T,S> listener) Remove a listener from this RiakFuture.
void	setResponse(RiakMessage rawResponse)

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureOperation

public FutureOperation()

Method Detail

addListener

public void addListener(RiakFutureListener<T,S> listener)

Description copied from interface: RiakFuture

Add a listener to this RiakFuture.

Specified by:

addListener in interface RiakFuture<T,S>

Parameters:

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

removeListener

public void removeListener(RiakFutureListener<T,S> listener)

Description copied from interface: RiakFuture

Remove a listener from this RiakFuture.

Specified by:

removeListener in interface RiakFuture<T,S>

Parameters:

listener - The listener to remove.

setResponse

public final void setResponse(RiakMessage rawResponse)

done

protected boolean done(U message)

Detect when the streaming operation is finished

Parameters:

message - raw message

Returns:

returns true if this is the last message in the streaming operation

channelMessage

public final Object channelMessage()

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface RiakFuture<T,S>

Specified by:

cancel in interface Future<T>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface RiakFuture<T,S>

Specified by:

isCancelled in interface Future<T>

isDone

public final boolean isDone()

Specified by:

isDone in interface RiakFuture<T,S>

Specified by:

isDone in interface Future<T>

isSuccess

public final boolean isSuccess()

Description copied from interface: RiakFuture

Determine if the operation was successful.

Specified by:

isSuccess in interface RiakFuture<T,S>

Returns:

true if completed and successful, false otherwise.

cause

public final Throwable cause()

Description copied from interface: RiakFuture

Return information about the operation and why it failed.

Specified by:

cause in interface RiakFuture<T,S>

Returns:

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

get

public final T get()
            throws InterruptedException

Specified by:

get in interface RiakFuture<T,S>

Specified by:

get in interface Future<T>

Throws:

InterruptedException

get

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

Specified by:

get in interface RiakFuture<T,S>

Specified by:

get in interface Future<T>

Throws:

InterruptedException

await

public final void await()
                 throws InterruptedException

Description copied from interface: RiakFuture

Waits for this RiakFuture to be completed.

Specified by:

await in interface RiakFuture<T,S>

Throws:

InterruptedException

await

public final void await(long timeout,
         TimeUnit unit)
                 throws InterruptedException

Description copied from interface: RiakFuture

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

Specified by:

await in interface RiakFuture<T,S>

Parameters:

timeout - the amount of time to wait before returning.

unit - the unit of time.

Throws:

InterruptedException

convert

protected abstract T convert(List<U> rawResponse)

createChannelMessage

protected abstract RiakMessage createChannelMessage()

decode

protected abstract U decode(RiakMessage rawMessage)

getQueryInfo

public abstract S getQueryInfo()

Description copied from interface: RiakFuture

Returns information related to the operation performed.

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

Specified by:

getQueryInfo in interface RiakFuture<T,S>

Returns:

Information pertaining to the operation attached to this future.