org.gridgain.grid.util.future

Class GridEmbeddedFuture<A,B>

java.lang.Object

java.util.concurrent.locks.AbstractOwnableSynchronizer

java.util.concurrent.locks.AbstractQueuedSynchronizer

org.gridgain.grid.util.future.GridFutureAdapter<A>

org.gridgain.grid.util.future.GridEmbeddedFuture<A,B>

All Implemented Interfaces:

Externalizable, Serializable, GridFuture<A>

Direct Known Subclasses:

GridDhtEmbeddedFuture

public class GridEmbeddedFuture<A,B>
extends GridFutureAdapter<A>

Future which waits for embedded future to complete and then asynchronously executes provided closure with embedded future result.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

AbstractQueuedSynchronizer.ConditionObject

Field Summary

Fields inherited from class org.gridgain.grid.util.future.GridFutureAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridEmbeddedFuture() Empty constructor required by Externalizable.
GridEmbeddedFuture(boolean syncNotify, GridFuture<B> embedded, GridBiClosure<B,Exception,GridFuture<A>> c, GridKernalContext ctx) Embeds futures.
GridEmbeddedFuture(GridFuture<B> embedded, GridBiClosure<B,Exception,GridFuture<A>> c, GridKernalContext ctx) Embeds futures.
GridEmbeddedFuture(GridKernalContext ctx, GridFuture<B> embedded, GridBiClosure<B,Exception,A> c)
GridEmbeddedFuture(GridKernalContext ctx, GridFuture<B> embedded, GridBiClosure<B,Exception,GridFuture<A>> c1, GridBiClosure<A,Exception,A> c2) Embeds futures.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Default no-op implementation that always returns false.
boolean	isCancelled() Returns true if this computation was cancelled before it completed normally.
String	toString()

Methods inherited from class org.gridgain.grid.util.future.GridFutureAdapter

chain, checkValid, concurrentNotify, concurrentNotify, duration, endTime, error, get, get, get, get0, isDone, isFailed, isValid, listenAsync, onCancelled, onDone, onDone, onDone, onDone, readExternal, result, startTime, stopListenAsync, syncNotify, syncNotify, tryAcquireShared, tryReleaseShared, writeExternal

Methods inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

acquire, acquireInterruptibly, acquireShared, acquireSharedInterruptibly, compareAndSetState, getExclusiveQueuedThreads, getFirstQueuedThread, getQueuedThreads, getQueueLength, getSharedQueuedThreads, getState, getWaitingThreads, getWaitQueueLength, hasContended, hasQueuedPredecessors, hasQueuedThreads, hasWaiters, isHeldExclusively, isQueued, owns, release, releaseShared, setState, tryAcquire, tryAcquireNanos, tryAcquireSharedNanos, tryRelease

Methods inherited from class java.util.concurrent.locks.AbstractOwnableSynchronizer

getExclusiveOwnerThread, setExclusiveOwnerThread

Methods inherited from class java.lang.Object

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

Constructor Detail

GridEmbeddedFuture

public GridEmbeddedFuture()

Empty constructor required by Externalizable.

GridEmbeddedFuture

public GridEmbeddedFuture(GridKernalContext ctx,
                  GridFuture<B> embedded,
                  GridBiClosure<B,Exception,A> c)

Parameters:

ctx - Context.

embedded - Embedded future.

c - Closure to execute upon completion of embedded future.

GridEmbeddedFuture

public GridEmbeddedFuture(boolean syncNotify,
                  GridFuture<B> embedded,
                  GridBiClosure<B,Exception,GridFuture<A>> c,
                  GridKernalContext ctx)

Embeds futures. Specific change order of arguments to avoid conflicts.

Parameters:

syncNotify - Synchronous notify flag.

embedded - Closure.

c - Closure which runs upon completion of embedded closure and which returns another future.

ctx - Context.

GridEmbeddedFuture

public GridEmbeddedFuture(GridFuture<B> embedded,
                  GridBiClosure<B,Exception,GridFuture<A>> c,
                  GridKernalContext ctx)

Embeds futures. Specific change order of arguments to avoid conflicts.

Parameters:

ctx - Context.

embedded - Closure.

c - Closure which runs upon completion of embedded closure and which returns another future.

GridEmbeddedFuture

public GridEmbeddedFuture(GridKernalContext ctx,
                  GridFuture<B> embedded,
                  GridBiClosure<B,Exception,GridFuture<A>> c1,
                  GridBiClosure<A,Exception,A> c2)

Embeds futures.

Parameters:

ctx - Context.

embedded - Future.

c1 - Closure which runs upon completion of embedded future and which returns another future.

c2 - Closure will runs upon completion of future returned by c1 closure.

Method Detail

cancel

public boolean cancel()
               throws GridException

Default no-op implementation that always returns false. Futures that do support cancellation should override this method and call GridFutureAdapter.onCancelled() callback explicitly if cancellation indeed did happen.

Specified by:

cancel in interface GridFuture<A>

Overrides:

cancel in class GridFutureAdapter<A>

Returns:

True if future was canceled (i.e. was not finished prior to this call).

Throws:

GridException - If cancellation failed.

isCancelled

public boolean isCancelled()

Returns true if this computation was cancelled before it completed normally.

Specified by:

isCancelled in interface GridFuture<A>

Overrides:

isCancelled in class GridFutureAdapter<A>

Returns:

True if this computation was cancelled before it completed normally.

toString

public String toString()

Overrides:

toString in class GridFutureAdapter<A>