org.oddjob.events

Class EventJobBase<T>

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.StructuralJob<java.lang.Object>

org.oddjob.events.EventJobBase<T>

Type Parameters:

T - The type of the event or trigger.

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful, Stoppable, Structural

Direct Known Subclasses:

Trigger, When

public abstract class EventJobBase<T>
extends StructuralJob<java.lang.Object>

Base class for Jobs that react to events.

See Also:

Serialized Form

Author:

Rob Gordon.

Field Summary

Fields inherited from class org.oddjob.framework.extend.StructuralJob

childHelper, destroy, stop, structuralState

Constructor Summary

Constructors

Constructor and Description
EventJobBase()

Method Summary

Modifier and Type	Method and Description
protected void	execute() Execute this job.
protected StateOperator	getInitialStateOp() Subclasses must provide the StateOperator that will decide how to evaluate the children's state.
EventOf<T>	getTrigger()
protected void	onStop() Allow sub classes to do something on stop.
protected void	postStop() Subclasses can override to perform actions once children have stopped.
void	setExecutorService(java.util.concurrent.ExecutorService executorService)
void	setJobs(int index, java.lang.Object child) Add a child job.
protected void	setTrigger(EventOf<T> trigger)
protected void	startChildStateReflector() Start the child state reflector.

Methods inherited from class org.oddjob.framework.extend.StructuralJob

addStructuralListener, fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onHardReset, onReset, onSoftReset, removeStructuralListener, run, softReset, stateHandler, stop, stopChildStateReflector

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

EventJobBase

public EventJobBase()

Method Detail

setExecutorService

@Inject
public void setExecutorService(java.util.concurrent.ExecutorService executorService)

getInitialStateOp

protected StateOperator getInitialStateOp()

Description copied from class: StructuralJob

Subclasses must provide the StateOperator that will decide how to evaluate the children's state.

Specified by:

getInitialStateOp in class StructuralJob<java.lang.Object>

Returns:

A State Operator. Must not be null.

startChildStateReflector

protected void startChildStateReflector()

Description copied from class: StructuralJob

Start the child state reflector. Sub classes override this if they need to start the child state reflector at a different time.

Overrides:

startChildStateReflector in class StructuralJob<java.lang.Object>

execute

protected void execute()
                throws java.lang.Throwable

Description copied from class: StructuralJob

Execute this job.

Specified by:

execute in class StructuralJob<java.lang.Object>

Throws:

java.lang.Exception - If the unexpected occurs.

java.lang.Throwable

onStop

protected void onStop()

Description copied from class: StructuralJob

Allow sub classes to do something on stop.

Overrides:

onStop in class StructuralJob<java.lang.Object>

postStop

protected void postStop()
                 throws FailedToStopException

Description copied from class: StructuralJob

Subclasses can override to perform actions once children have stopped.

Overrides:

postStop in class StructuralJob<java.lang.Object>

Throws:

FailedToStopException

setTrigger

protected void setTrigger(EventOf<T> trigger)

getTrigger

public EventOf<T> getTrigger()

setJobs

public void setJobs(int index,
                    java.lang.Object child)

Add a child job.

Property: jobs

Description: The child jobs.

Required: No, but pointless if missing.

Parameters:

child - A child