com.basho.riak.client.api.commands

Class ImmediateCoreFutureAdapter<T2,S2,T,S>

java.lang.Object

com.basho.riak.client.api.commands.ListenableFuture<T2,S2>

com.basho.riak.client.api.commands.CoreFutureAdapter<T2,S2,T,S>

com.basho.riak.client.api.commands.ImmediateCoreFutureAdapter<T2,S2,T,S>

Type Parameters:

T - The core response type.

S - The core query info type.

T2 - The converted response type.

S2 - The converted query info type.

All Implemented Interfaces:

RiakFuture<T2,S2>, RiakFutureListener<T,S>, Future<T2>

Direct Known Subclasses:

ImmediateCoreFutureAdapter.SameQueryInfo

public abstract class ImmediateCoreFutureAdapter<T2,S2,T,S>
extends CoreFutureAdapter<T2,S2,T,S>

Used when the converted response is available before the core future is complete.

Since:

2.1.0

Author:

Alex Moore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmediateCoreFutureAdapter.SameQueryInfo<T2,S,T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmediateCoreFutureAdapter(RiakFuture<T,S> coreFuture, T2 immediateResponse)

Method Summary

Modifier and Type	Method and Description
protected abstract S2	convertQueryInfo(S coreQueryInfo)
protected T2	convertResponse(T unused)
T2	get() Waits for this RiakFuture to be completed if necessary and returns the response if available.
T2	get(long timeout, TimeUnit unit) Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
T2	getNow() Return the result without blocking or throwing an exception.

Methods inherited from class com.basho.riak.client.api.commands.CoreFutureAdapter

await, await, cancel, cause, getQueryInfo, handle, isCancelled, isDone, isSuccess

Methods inherited from class com.basho.riak.client.api.commands.ListenableFuture

addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmediateCoreFutureAdapter

protected ImmediateCoreFutureAdapter(RiakFuture<T,S> coreFuture,
                                     T2 immediateResponse)

Method Detail

get

public T2 get()
       throws InterruptedException,
              ExecutionException

Description copied from interface: RiakFuture

Waits for this RiakFuture to be completed if necessary and returns the response if available.

Specified by:

get in interface RiakFuture<T2,S2>

Specified by:

get in interface Future<T2>

Overrides:

get in class CoreFutureAdapter<T2,S2,T,S>

Returns:

The response from the operation.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ExecutionException - if the computation threw an exception

get

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

Description copied from interface: RiakFuture

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Note that the timeout value here is how long you are willing to wait for this RiakFuture to complete. If you wish to set a timeout on the command itself, use the timeout() method provided in the command's associated builder.

Specified by:

get in interface RiakFuture<T2,S2>

Specified by:

get in interface Future<T2>

Overrides:

get in class CoreFutureAdapter<T2,S2,T,S>

Parameters:

timeout - the amount of time to wait before returning.

unit - the unit of time.

Returns:

the response, or null if not completed or failed.

Throws:

InterruptedException - if the current thread was interrupted while waiting.

ExecutionException - if the computation threw an exception.

TimeoutException - if the wait timed out.

getNow

public T2 getNow()

Description copied from interface: RiakFuture

Return the result without blocking or throwing an exception. If the future is not yet done or has failed this will return null. As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with RiakFuture.isDone() and not rely on the returned null value.

Specified by:

getNow in interface RiakFuture<T2,S2>

Overrides:

getNow in class CoreFutureAdapter<T2,S2,T,S>

Returns:

The response, or null if the future is not yet completed or failed.

See Also:

RiakFuture.isDone(), RiakFuture.isSuccess()

convertResponse

protected T2 convertResponse(T unused)

Specified by:

convertResponse in class CoreFutureAdapter<T2,S2,T,S>

convertQueryInfo

protected abstract S2 convertQueryInfo(S coreQueryInfo)

Specified by:

convertQueryInfo in class CoreFutureAdapter<T2,S2,T,S>