edu.rice.hj.runtime.forkjoin

Class FinishState

java.lang.Object

edu.rice.hj.runtime.forkjoin.FinishState

public class FinishState
extends Object

The state associated with a finish operation. Records the count of active activities associated with this finish, and the stack of exceptions thrown by activities associated with this finish that have already terminated abruptly. An activity maintains a stack of FinishStates.

Author:

Raj Barik, Vivek Sarkar

Constructor Summary

Constructors

Constructor and Description
FinishState(String creatorName) Create a new finish state for the given activity.

Method Summary

Modifier and Type	Method and Description
boolean	eurekaFound() Return whether the eureka event has already occurred.
List<Throwable>	exceptions() Create a new stack or return current one.
long	id() Returns the id of the FinishState.
String	name() Returns the name of the FinishState.
void	notifySubActivitySpawn() An activity created under this finish has been created.
void	notifySubActivityTermination() An activity created under this finish has terminated.
void	notifySubActivityTermination(Throwable throwable) An activity created under this finish has terminated abruptly.
void	pushException(Throwable throwable) Push an exception onto the stack.
void	registerEureka(edu.rice.hj.experimental.api.HjEureka<?> hjEureka) Registers a eureka with this FinishState.
protected edu.rice.hj.experimental.api.HjEureka<?>	retrieveEureka() Return the Eureka registered with this FinishState.
String	toString() Return a string to be used in Report messages.
void	waitForFinish() This method returns only when all spawned activity registered with this FinishState have terminated either normally or abruptly.

Methods inherited from class java.lang.Object

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

Constructor Detail

FinishState

public FinishState(String creatorName)

Create a new finish state for the given activity.

Parameters:

creatorName - The name of the activity creating the finish state.

Method Detail

id

public long id()

Returns the id of the FinishState.

Returns:

the id of the FinishState.

name

public String name()

Returns the name of the FinishState.

Returns:

the name of the FinishState.

registerEureka

public void registerEureka(edu.rice.hj.experimental.api.HjEureka<?> hjEureka)

Registers a eureka with this FinishState.

Parameters:

hjEureka - The eureka to register.

retrieveEureka

protected edu.rice.hj.experimental.api.HjEureka<?> retrieveEureka()

Return the Eureka registered with this FinishState.

Returns:

the Eureka registered with this FinishState.

eurekaFound

public boolean eurekaFound()

Return whether the eureka event has already occurred.

Returns:

whether the eureka event has already occurred

waitForFinish

public final void waitForFinish()

This method returns only when all spawned activity registered with this FinishState have terminated either normally or abruptly. Additionally, a notification is sent to the place where the activity reside when the activity is blocked and unblock.

notifySubActivitySpawn

public final void notifySubActivitySpawn()

An activity created under this finish has been created. Increment the count associated with the finish.

notifySubActivityTermination

public final void notifySubActivityTermination()

An activity created under this finish has terminated. Decrement the count associated with the finish and notify the parent activity if it is waiting.

notifySubActivityTermination

public final void notifySubActivityTermination(Throwable throwable)

An activity created under this finish has terminated abruptly. Record the exception, decrement the count associated with the finish and notify the parent activity if it is waiting.

Parameters:

throwable - -- The exception thrown by the activity that terminated abruptly.

pushException

public final void pushException(Throwable throwable)

Push an exception onto the stack. Do not decrement finishCount --- this exception was thrown by inline code, not a spawned activity.

Parameters:

throwable - Thrown exception

exceptions

public final List<Throwable> exceptions()

Create a new stack or return current one.

Returns:

the finish stack

toString

public final String toString()

Return a string to be used in Report messages.

Overrides:

toString in class Object