edu.rice.hj.runtime.baseruntime

Class ParallelDataDrivenFuture<ValueType>

java.lang.Object

edu.rice.hj.runtime.baseruntime.ParallelFuture<ValueType>

edu.rice.hj.runtime.baseruntime.ParallelDataDrivenFuture<ValueType>

Type Parameters:

ValueType - The type of the value to wrap

All Implemented Interfaces:

HjDataDrivenFuture<ValueType>, HjFuture<ValueType>

public final class ParallelDataDrivenFuture<ValueType>
extends ParallelFuture<ValueType>
implements HjDataDrivenFuture<ValueType>

Parallel implementation of a HjDataDrivenFuture

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested classes/interfaces inherited from class edu.rice.hj.runtime.baseruntime.ParallelFuture

ParallelFuture.EventType, ParallelFuture.ExecutionState

Nested classes/interfaces inherited from interface edu.rice.hj.api.HjFuture

HjFuture.CancelledException

Field Summary

Fields inherited from class edu.rice.hj.runtime.baseruntime.ParallelFuture

activity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParallelDataDrivenFuture(boolean allowDuplicatePuts) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Attempts to cancel execution of this task.
static <ValueType> ParallelDataDrivenFuture<ValueType>	factory() Factory method.
static <ValueType> ParallelDataDrivenFuture<ValueType>	factory(boolean allowDuplicatePuts) Factory method.
ValueType	get() Returns the value wrapped in the futureNb.
ValueType	safeGet() Returns the value wrapped in the Future.
protected void	throwPutFailedException(ValueType newValue) throwPutFailedException.

Methods inherited from class edu.rice.hj.runtime.baseruntime.ParallelFuture

attachListener, failed, failed, id, isCancelled, markStart, preReleaseCallback, put, resolved, retrieveValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.rice.hj.api.HjDataDrivenFuture

failed, put

Methods inherited from interface edu.rice.hj.api.HjFuture

failed, resolved

Constructor Detail

ParallelDataDrivenFuture

protected ParallelDataDrivenFuture(boolean allowDuplicatePuts)

Constructor.

Method Detail

factory

public static <ValueType> ParallelDataDrivenFuture<ValueType> factory()

Factory method.

Type Parameters:

ValueType - The type of the value to wrap

Returns:

a new instance of the DDF.

factory

public static <ValueType> ParallelDataDrivenFuture<ValueType> factory(boolean allowDuplicatePuts)

Factory method.

Type Parameters:

ValueType - The type of the value to wrap

Returns:

a new instance of the DDF.

get

public ValueType get()
              throws SuspendableException

Returns the value wrapped in the futureNb.

If the futureNb task has not completed as yet, the task performing the get() operation blocks until the result of the futureNb becomes available.

Specified by:

get in interface HjDataDrivenFuture<ValueType>

Specified by:

get in interface HjFuture<ValueType>

Overrides:

get in class ParallelFuture<ValueType>

Returns:

The value wrapped in the futureNb.

Throws:

SuspendableException

safeGet

public ValueType safeGet()

Returns the value wrapped in the Future.

It is illegal to perform a safeGet() operation on an empty Future (i.e. one that has not yet been resolved).

Specified by:

safeGet in interface HjDataDrivenFuture<ValueType>

Specified by:

safeGet in interface HjFuture<ValueType>

Overrides:

safeGet in class ParallelFuture<ValueType>

Returns:

The value wrapped in the futureNb.

cancel

public boolean cancel()

Attempts to cancel execution of this task. If this task has not started when cancel is called, this task should never run its body. If the task has already started, then the task will not be interrupted and the task will run to completion.

Specified by:

cancel in interface HjDataDrivenFuture<ValueType>

Specified by:

cancel in interface HjFuture<ValueType>

Overrides:

cancel in class ParallelFuture<ValueType>

Returns:

false if the task could not be cancelled, typically because it has already completed normally or is being executed; true otherwise

throwPutFailedException

protected void throwPutFailedException(ValueType newValue)

throwPutFailedException.

Overrides:

throwPutFailedException in class ParallelFuture<ValueType>

Parameters:

newValue - The value attempted to put into the futureNb