HabaneroActivity (hjlib-cooperative 0.1.5-SNAPSHOT API)

java.lang.Object
- edu.rice.hj.runtime.baseruntime.HabaneroActivity

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

RunnableActivity, SuspendableActivity
```
public abstract class HabaneroActivity
extends Object
implements Runnable
```
The representation of an HJ asynchronous activity. The activity is run by some worker thread and is always attached to some finish scope. As an activity terminates it decrements the count on its finish scope. The finish scopes can also be stacked up as an activity launches multiple finish blocks, the finish scopes are then popped off as they terminate.

Author:

Vincent Cave (vincent.cave@rice.edu), Shams Imam (shams@rice.edu)

Field Summary

Fields
Modifier and Type	Field and Description
`protected RuntimeException`	`executionException` Exception that occurred while executing the activity
`protected FinishState`	`launchedFinishState` TODO The FinishState of this activity. !
`protected ActivityListeners.ActivityListenerList`	`listenerList` AcitivityListener registered with this activity
`protected FinishState`	`rootFinishState` TODO The FinishState up in the invocation tree within which this activity is being executed.

Constructor Summary

Constructors
Modifier Constructor and Description

protected HabaneroActivity(String activityName, HjPlace hjPlace)
Constructor for HabaneroActivity.

Constructors
Modifier	Constructor and Description
`protected`	`HabaneroActivity(String activityName, HjPlace hjPlace)` Constructor for HabaneroActivity.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`checkSuspendableOperation()` Validates the use of a suspendable operation by this activity.
`protected abstract boolean`	`completedExecution()` Return true if the task completed execution, else return false if the task was suspended.
`FinishState`	`currentFinishState()` Return the current FinishState being run by the activity.
`protected abstract void`	`executeTask()`
`HabaneroActivity`	`finalizeActivitySpawn(HabaneroActivity childActivity)` finalizeActivitySpawn.
`void`	`finalizeTermination()` finalizeTermination.
`void`	`finalizeTermination(Throwable throwable)` finalizeTermination.
`protected void`	`finalizeTerminationCleanup(Throwable throwable)` finalizeTerminationCleanup.
`protected void`	`handleException(Throwable throwable)`
`long`	`id()` Returns the id of the activity.
`void`	`join()` The method is marked as synchronized as it invokes the wait() method.
`String`	`name()` Returns the name of the activity.
`protected FinishState`	`newFinishState()` A factory method for a finish state.
`void`	`notifyActivitySpawn(HabaneroActivity childActivity)` notifyActivitySpawn.
`void`	`notifyResumption()` notifyResumption.
`void`	`notifySuspension()` notifySuspension.
`HjPlace`	`place()` Returns the place of the activity.
`abstract void`	`prepareToRunInFinish()` prepareToRunInFinish.
`void`	`pushException(Throwable throwable)` pushException.
`void`	`registerListener(ActivityListeners.ActivityListener activityListener)` registerListener.
`protected FinishState`	`retrieveTargetFinishState()`
`void`	`run()` This is the method (indirectly) executed when the task is run by the executor service.
`void`	`setRootActivityFinishState(FinishState root)` Used by a parent activity on its child activity to update the finish state
`protected abstract boolean`	`shouldBypassExecution()` Returns true if the activity should be skipped as it has already been executed.
`FinishState`	`startFinish()` This method is invoked when a new finish scope is encountered.
`void`	`stopFinish()` This method is invoked when a finish scope is being exited.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - rootFinishState
```
protected FinishState rootFinishState
```
    TODO The FinishState up in the invocation tree within which this activity is being executed.
  - launchedFinishState
```
protected FinishState launchedFinishState
```
    TODO The FinishState of this activity. != null if this activity has started a finish.
  - listenerList
```
protected final ActivityListeners.ActivityListenerList listenerList
```
    AcitivityListener registered with this activity
  - executionException
```
protected RuntimeException executionException
```
    Exception that occurred while executing the activity
- Constructor Detail
  - HabaneroActivity
```
protected HabaneroActivity(String activityName,
                           HjPlace hjPlace)
```
    Constructor for HabaneroActivity.
    
    Parameters:
    
    activityName - The name of the activity
- Method Detail
  - id
```
public long id()
```
    Returns the id of the activity.
    
    Returns:
    
    the id of the activity.
  - name
```
public String name()
```
    Returns the name of the activity.
    
    Returns:
    
    the name of the activity.
  - place
```
public HjPlace place()
```
    Returns the place of the activity.
    
    Returns:
    
    the place of the activity.
  - currentFinishState
```
public final FinishState currentFinishState()
```
    Return the current FinishState being run by the activity.
    
    Returns:
    
    the current FinishState being run by the activity.
  - registerListener
```
public final void registerListener(ActivityListeners.ActivityListener activityListener)
```
    registerListener.
    
    Parameters:
    
    activityListener - The listener to register
  - run
```
public final void run()
```
    This is the method (indirectly) executed when the task is run by the executor service.
    
    Specified by:
    
    run in interface Runnable
    
    See Also:
    
    Runnable.run()
  - completedExecution
```
protected abstract boolean completedExecution()
```
    Return true if the task completed execution, else return false if the task was suspended.
    
    Returns:
    
    true if the task completed execution, else return false if the task was suspended.
  - checkSuspendableOperation
```
protected abstract void checkSuspendableOperation()
```
    Validates the use of a suspendable operation by this activity.
  - shouldBypassExecution
```
protected abstract boolean shouldBypassExecution()
```
    Returns true if the activity should be skipped as it has already been executed.
    
    Returns:
    
    true if the activity should be skipped as it has already been executed.
  - prepareToRunInFinish
```
public abstract void prepareToRunInFinish()
```
    prepareToRunInFinish.
  - executeTask
```
protected abstract void executeTask()
```
  - handleException
```
protected void handleException(Throwable throwable)
```
  - finalizeActivitySpawn
```
public HabaneroActivity finalizeActivitySpawn(HabaneroActivity childActivity)
```
    finalizeActivitySpawn.
    
    Parameters:
    
    childActivity - The child activity being spawned
    
    Returns:
    
    a HabaneroActivity object.
  - retrieveTargetFinishState
```
protected FinishState retrieveTargetFinishState()
```
  - finalizeTermination
```
public void finalizeTermination()
```
    finalizeTermination.
  - finalizeTermination
```
public void finalizeTermination(Throwable throwable)
```
    finalizeTermination.
    
    Parameters:
    
    throwable - The exception thrown while executing the body of the activity.
  - finalizeTerminationCleanup
```
protected void finalizeTerminationCleanup(Throwable throwable)
```
    finalizeTerminationCleanup.
  - pushException
```
public final void pushException(Throwable throwable)
```
    pushException.
    
    Parameters:
    
    throwable - The exception that occurred while executing this activity
  - notifyActivitySpawn
```
public void notifyActivitySpawn(HabaneroActivity childActivity)
```
    notifyActivitySpawn.
    
    Parameters:
    
    childActivity - a HabaneroActivity object.
  - notifySuspension
```
public void notifySuspension()
```
    notifySuspension.
  - notifyResumption
```
public void notifyResumption()
```
    notifyResumption.
  - newFinishState
```
protected final FinishState newFinishState()
```
    A factory method for a finish state.
    
    Returns:
    
    A new finish state.
  - setRootActivityFinishState
```
public final void setRootActivityFinishState(FinishState root)
```
    Used by a parent activity on its child activity to update the finish state
    
    Parameters:
    
    root - The root finish state of the activity
  - startFinish
```
public final FinishState startFinish()
```
    This method is invoked when a new finish scope is encountered.
    
    Returns:
    
    a FinishState object.
  - stopFinish
```
public final void stopFinish()
                      throws SuspendableException
```
    This method is invoked when a finish scope is being exited.
    
    Throws:
    
    SuspendableException
  - join
```
public final void join()
                throws InterruptedException
```
    The method is marked as synchronized as it invokes the wait() method.
    
    Throws:
    
    InterruptedException - if any thread interrupted the current thread before or while the current thread was waiting for a notification.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HabaneroActivity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rootFinishState

launchedFinishState

listenerList

executionException

Constructor Detail

HabaneroActivity

Method Detail

id

name

place

currentFinishState

registerListener

run

completedExecution

checkSuspendableOperation

shouldBypassExecution

prepareToRunInFinish

executeTask

handleException

finalizeActivitySpawn

retrieveTargetFinishState

finalizeTermination

finalizeTermination

finalizeTerminationCleanup

pushException

notifyActivitySpawn

notifySuspension

notifyResumption

newFinishState

setRootActivityFinishState

startFinish

stopFinish

join

toString