Package org.oddjob.state

Class MirrorState

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.state.MirrorState

All Implemented Interfaces:

Runnable, ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable

public class MirrorState
extends BasePrimary
implements Runnable, Stoppable, Resettable

Author:

Rob Gordon

Description

When run this job mirrors the state of the given job. It continues to do so until it's stopped.

Constructor Summary

Constructors

Constructor	Description
MirrorState()

Method Summary

Modifier and Type	Method	Description
protected void	fireDestroyedState()	Internal method to fire state.
protected StateChanger<JobState>	getStateChanger()
boolean	hardReset()	Perform a hard reset.
protected IconHelper	iconHelper()	Subclasses must provide a IconHelper.
void	onDestroy()	Subclasses override this method to clear up resources.
void	run()
void	setJob(Stateful job)
boolean	softReset()	Perform a soft reset.
protected JobStateHandler	stateHandler()	Subclasses must provide a StateHandler.
void	stop()	Stop executing.

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

Constructor Details

MirrorState

public MirrorState()

Method Details

stateHandler

protected JobStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

getStateChanger

protected StateChanger<JobState> getStateChanger()

setJob

public void setJob(Stateful job)

Reference Property:

job

Description

A reference to the job to mirror.

Required:

Yes.

run

public void run()

Specified by:

run in interface Runnable

stop

public void stop()

Description copied from interface: Stoppable

Stop executing. This method should not return until the Stoppable has actually stopped.

Specified by:

stop in interface Stoppable

hardReset

public boolean hardReset()

Description copied from interface: Resettable

Perform a hard reset.

Specified by:

hardReset in interface Resettable

Returns:

true if successful.

softReset

public boolean softReset()

Description copied from interface: Resettable

Perform a soft reset.

Specified by:

softReset in interface Resettable

Returns:

true if successful.

onDestroy

public void onDestroy()

Description copied from class: BaseComponent

Subclasses override this method to clear up resources. This is called by the framework before child elements have been destroyed.

Overrides:

onDestroy in class BaseComponent

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent