org.gridgain.grid.util.future

Class GridCompoundFuture<T,R>

java.lang.Object

java.util.concurrent.locks.AbstractOwnableSynchronizer

java.util.concurrent.locks.AbstractQueuedSynchronizer

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

org.gridgain.grid.util.future.GridCompoundFuture<T,R>

All Implemented Interfaces:

Externalizable, Serializable, GridFuture<R>

Direct Known Subclasses:

GridCompoundIdentityFuture, GridDhtForceKeysFuture

public class GridCompoundFuture<T,R>
extends GridFutureAdapter<R>

Future composed of multiple inner futures.

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
GridCompoundFuture() Empty constructor required for Externalizable.
GridCompoundFuture(GridKernalContext ctx)
GridCompoundFuture(GridKernalContext ctx, GridReducer<T,R> rdc)
GridCompoundFuture(GridKernalContext ctx, GridReducer<T,R> rdc, Iterable<GridFuture<T>> futs)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(GridFuture<T> fut) Adds a future to this compound future.
void	addAll(GridFuture<T>... futs) Adds futures to this compound future.
void	addAll(Iterable<GridFuture<T>> futs) Adds futures to this compound future.
boolean	cancel() Default no-op implementation that always returns false.
Collection<GridFuture<T>>	futures() Gets collection of futures.
boolean	hasPending() Checks if there are pending futures.
void	ignoreChildFailures(Class<? extends Throwable>... ignoreChildFailures)
boolean	initialized()
void	markInitialized() Mark this future as initialized.
Collection<GridFuture<T>>	pending() Gets pending (unfinished) futures.
GridReducer<T,R>	reducer() Gets optional reducer.
void	reducer(GridReducer<T,R> rdc) Sets optional reducer.
String	toString()

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

chain, checkValid, concurrentNotify, concurrentNotify, duration, endTime, error, get, get, get, get0, isCancelled, 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

GridCompoundFuture

public GridCompoundFuture()

Empty constructor required for Externalizable.

GridCompoundFuture

public GridCompoundFuture(GridKernalContext ctx)

Parameters:

ctx - Context.

GridCompoundFuture

public GridCompoundFuture(GridKernalContext ctx,
                  @Nullable
                  GridReducer<T,R> rdc)

Parameters:

ctx - Context.

rdc - Reducer.

GridCompoundFuture

public GridCompoundFuture(GridKernalContext ctx,
                  @Nullable
                  GridReducer<T,R> rdc,
                  @Nullable
                  Iterable<GridFuture<T>> futs)

Parameters:

ctx - Context.

rdc - Reducer to add.

futs - Futures to add.

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<R>

Overrides:

cancel in class GridFutureAdapter<R>

Returns:

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

Throws:

GridException - If cancellation failed.

futures

public Collection<GridFuture<T>> futures()

Gets collection of futures.

Returns:

Collection of futures.

pending

public Collection<GridFuture<T>> pending()

Gets pending (unfinished) futures.

Returns:

Pending futures.

ignoreChildFailures

public void ignoreChildFailures(Class<? extends Throwable>... ignoreChildFailures)

Parameters:

ignoreChildFailures - Flag indicating whether compound future should ignore child futures failures.

hasPending

public boolean hasPending()

Checks if there are pending futures. This is not the same as GridFutureAdapter.isDone() because child classes may override GridFutureAdapter.onDone(Object, Throwable) call and delay completion.

Returns:

True if there are pending futures.

initialized

public boolean initialized()

Returns:

True if this future was initialized. Initialization happens when markInitialized() method is called on future.

add

public void add(GridFuture<T> fut)

Adds a future to this compound future.

Parameters:

fut - Future to add.

addAll

public void addAll(@Nullable
          GridFuture<T>... futs)

Adds futures to this compound future.

Parameters:

futs - Futures to add.

addAll

public void addAll(@Nullable
          Iterable<GridFuture<T>> futs)

Adds futures to this compound future.

Parameters:

futs - Futures to add.

reducer

@Nullable
public GridReducer<T,R> reducer()

Gets optional reducer.

Returns:

Optional reducer.

reducer

public void reducer(@Nullable
           GridReducer<T,R> rdc)

Sets optional reducer.

Parameters:

rdc - Optional reducer.

markInitialized

public void markInitialized()

Mark this future as initialized.

toString

public String toString()

Overrides:

toString in class GridFutureAdapter<R>