org.oddjob.state
Class MirrorState

java.lang.Object
  extended by org.oddjob.framework.BaseComponent
      extended by org.oddjob.framework.BasePrimary
          extended by org.oddjob.state.MirrorState
All Implemented Interfaces:
Runnable, ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful, Stoppable

public class MirrorState
extends BasePrimary
implements Runnable, Stoppable, Resetable

Description

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

Field Summary
 
Fields inherited from class org.oddjob.framework.BaseComponent
iconHelper
 
Constructor Summary
MirrorState()
           
 
Method Summary
protected  void fireDestroyedState()
          Internal method to fire state.
protected  StateChanger<JobState> getStateChanger()
           
 boolean hardReset()
          Perform a hard reset.
 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()
           
 void stop()
          Stop executing.
 
Methods inherited from class org.oddjob.framework.BasePrimary
configure, getName, logger, logger, loggerName, save, setName, toString
 
Methods inherited from class org.oddjob.framework.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 Detail

MirrorState

public MirrorState()
Method Detail

stateHandler

protected JobStateHandler stateHandler()
Specified by:
stateHandler in class BaseComponent

getStateChanger

protected StateChanger<JobState> getStateChanger()

setJob

public void setJob(Stateful job)

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: Resetable
Perform a hard reset.

Specified by:
hardReset in interface Resetable
Returns:
true if successful.

softReset

public boolean softReset()
Description copied from interface: Resetable
Perform a soft reset.

Specified by:
softReset in interface Resetable
Returns:
true if successful.

onDestroy

public void onDestroy()
Description copied from class: BaseComponent
Subclasses override this method to clear up resources.

Overrides:
onDestroy in class BaseComponent

fireDestroyedState

protected void fireDestroyedState()
Internal method to fire state.

Specified by:
fireDestroyedState in class BaseComponent