com.allanbank.mongodb.client

Class FutureCallback<V>

java.lang.Object

com.allanbank.mongodb.client.FutureCallback<V>

Type Parameters:

V - The type for the set value.

All Implemented Interfaces:

Callback<V>, ListenableFuture<V>, Future<V>

Direct Known Subclasses:

FutureReplyCallback

public class FutureCallback<V>
extends Object
implements ListenableFuture<V>, Callback<V>

Implementation of a Callback and ListenableFuture interfaces. Used to convert a Callback into a ListenableFuture for returning to callers.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static Log	LOG Logger to log exceptions caught when running myPendingListeners.
static long	SPIN_TIME_NS Amount of time to spin before yielding.

Constructor Summary

Constructors

Constructor and Description
FutureCallback() Create a new FutureCallback.
FutureCallback(LockType lockType) Create a new FutureCallback.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Runnable runnable, Executor executor) Add a Runnable to be executed once the future is completed via the provided executable.
void	callback(V result) Called when the MongoDB operation has completed with the result of the operation.
boolean	cancel(boolean mayInterruptIfRunning)
void	exception(Throwable thrown) Called when the operation fails due to an exception.
protected void	execute() Runs this execution list, executing all existing pairs.
V	get()
V	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Log LOG

Logger to log exceptions caught when running myPendingListeners.

SPIN_TIME_NS

public static final long SPIN_TIME_NS

Amount of time to spin before yielding. Set to 1/100 of a millisecond.

Constructor Detail

FutureCallback

public FutureCallback()

Create a new FutureCallback.

FutureCallback

public FutureCallback(LockType lockType)

Create a new FutureCallback.

Parameters:

lockType - The type of lock to use when waiting for the future to be fulfilled.

Method Detail

addListener

public void addListener(Runnable runnable,
               Executor executor)

Add a Runnable to be executed once the future is completed via the provided executable.

The order that Runnables are executed is unspecified.

Specified by:

addListener in interface ListenableFuture<V>

Parameters:

runnable - The myRunnable to execute.

executor - Executor to use with the myRunnable.

callback

public void callback(V result)

Called when the MongoDB operation has completed with the result of the operation.

Sets the value for the future and triggers any pending get() to return.

Specified by:

callback in interface Callback<V>

Parameters:

result - The result of the operation.

See Also:

Callback.callback(V)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

If not cancelled and the callback has not completed then cancels the future, triggers the return of any pending get() and returns true. Otherwise returns false. This does not stop the related MongoDB invocation.

Specified by:

cancel in interface Future<V>

See Also:

Future.cancel(boolean)

exception

public void exception(Throwable thrown)

Called when the operation fails due to an exception.

Sets the exception for the future and triggers any pending get() to throw a ExecutionException.

Specified by:

exception in interface Callback<V>

Parameters:

thrown - The thrown exception.

See Also:

Callback.exception(java.lang.Throwable)

get

public V get()
      throws InterruptedException,
             ExecutionException

Returns the value set via the Callback.

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

See Also:

Future.get()

get

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

Specified by:

get in interface Future<V>

Throws:

InterruptedException

TimeoutException

ExecutionException

isCancelled

public boolean isCancelled()

Returns true if cancel(boolean) has been called.

Specified by:

isCancelled in interface Future<V>

See Also:

Future.isCancelled()

isDone

public boolean isDone()

True if a value has been set via the the Callback interface or the Future has been cancelled.

Specified by:

isDone in interface Future<V>

See Also:

Future.isDone()

execute

protected void execute()

Runs this execution list, executing all existing pairs.

All callers of this method will drain the list of listeners.