org.hypergraphdb.util

Class AggregateFuture<T>

java.lang.Object

org.hypergraphdb.util.AggregateFuture<T>

All Implemented Interfaces:

Future<List<T>>

public class AggregateFuture<T>
extends Object
implements Future<List<T>>

An AggregateFuture encapsulates several Future into a single one. The result of an aggregate future is the list of results of all its components in the order in which they were added.

Constructor Summary

Constructors

Constructor and Description
AggregateFuture(Future<T>... futures) Construct from a set of futures which is copied internally.
AggregateFuture(List<Future<T>> components) Construct from a non-null list of components which is copied internally.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Canceling an aggregate future succeeds only if canceling all of its components succeeds.
List<T>	get()
List<T>	get(long timeout, TimeUnit unit)
boolean	isCancelled() An aggregate is canceled iff at least one of its components is canceled.
boolean	isDone() An aggregate is done iff all of its components are done.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateFuture

public AggregateFuture(Future<T>... futures)

Construct from a set of futures which is copied internally.

AggregateFuture

public AggregateFuture(List<Future<T>> components)

Construct from a non-null list of components which is copied internally.

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Canceling an aggregate future succeeds only if canceling all of its components succeeds. Note that during the process some components may be canceled while others not which would lead to an inconsistent state.

Specified by:

cancel in interface Future<List<T>>

get

public List<T> get()
            throws InterruptedException,
                   ExecutionException

Specified by:

get in interface Future<List<T>>

Throws:

InterruptedException

ExecutionException

get

public List<T> get(long timeout,
          TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Specified by:

get in interface Future<List<T>>

Throws:

InterruptedException

ExecutionException

TimeoutException

isCancelled

public boolean isCancelled()

An aggregate is canceled iff at least one of its components is canceled.

Specified by:

isCancelled in interface Future<List<T>>

isDone

public boolean isDone()

An aggregate is done iff all of its components are done.

Specified by:

isDone in interface Future<List<T>>