org.oddjob.state

Class Resets

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

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

org.oddjob.state.Resets

All Implemented Interfaces:

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

public class Resets
extends StructuralJob<java.lang.Object>

Description

Captures Reset actions propagating down a job tree and either hardens soft resets to hard resets or softens hard resets to soft resets before passing them on to the child job.

Execute and Stop actions are cascaded as normal to the child job.

See also the ResetJob job.

Example

Examples elsewhere.

• See the EqualsState example. The resets are required because retry only sends a soft reset on retry and it must be hardened to reset the ExistsJob.

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
Resets()

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.
boolean	hardReset() Perform a hard reset on the job.
boolean	isHarden()
boolean	isSoften()
void	setHarden(boolean harden)
void	setJob(java.lang.Object job)
void	setSoften(boolean soften)
boolean	softReset() Perform a soft reset on the job.

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

addStructuralListener, fireDestroyedState, force, getStateChanger, iconHelper, isStop, onDestroy, onHardReset, onReset, onSoftReset, onStop, postStop, removeStructuralListener, run, startChildStateReflector, stateHandler, stop, stopChildStateReflector, waitForChildrenOnStop

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

Resets

public Resets()

Method Detail

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.

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

isHarden

public boolean isHarden()

setHarden

public void setHarden(boolean harden)

isSoften

public boolean isSoften()

setSoften

public void setSoften(boolean soften)

setJob

public void setJob(java.lang.Object job)

Property: job

Description: The job to pass resets on to.

Required: Yes.

hardReset

public boolean hardReset()

Description copied from class: StructuralJob

Perform a hard reset on the job.

Specified by:

hardReset in interface Resettable

Overrides:

hardReset in class StructuralJob<java.lang.Object>

Returns:

true if successful.

softReset

public boolean softReset()

Description copied from class: StructuralJob

Perform a soft reset on the job.

Specified by:

softReset in interface Resettable

Overrides:

softReset in class StructuralJob<java.lang.Object>

Returns:

true if successful.