org.springframework.statemachine.state

Class ObjectState<S,E>

java.lang.Object

org.springframework.statemachine.state.AbstractState<S,E>

org.springframework.statemachine.state.AbstractSimpleState<S,E>

org.springframework.statemachine.state.ObjectState<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

State<S,E>

Direct Known Subclasses:

EnumState

public class ObjectState<S,E>
extends AbstractSimpleState<S,E>

A State implementation where state and event is object based.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
ObjectState(S id) Instantiates a new object state.
ObjectState(S id, java.util.Collection<E> deferred) Instantiates a new object state.
ObjectState(S id, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions) Instantiates a new object state.
ObjectState(S id, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, PseudoState<S,E> pseudoState) Instantiates a new object state.
ObjectState(S id, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, PseudoState<S,E> pseudoState, java.util.Collection<Region<S,E>> regions) Instantiates a new object state.
ObjectState(S id, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, PseudoState<S,E> pseudoState, StateMachine<S,E> submachine) Instantiates a new object state.
ObjectState(S id, PseudoState<S,E> pseudoState) Instantiates a new object state.

Method Summary

Modifier and Type	Method and Description
void	entry(StateContext<S,E> context) Initiate an entry sequence for the state.
void	exit(StateContext<S,E> context) Initiate an exit sequence for the state.
java.lang.String	toString()

Methods inherited from class org.springframework.statemachine.state.AbstractSimpleState

getIds, getStates

Methods inherited from class org.springframework.statemachine.state.AbstractState

addStateListener, getDeferredEvents, getEntryActions, getExitActions, getId, getPseudoState, getRegions, getSubmachine, getTriggers, isComposite, isOrthogonal, isSimple, isSubmachineState, removeStateListener, sendEvent, setTriggers, shouldDefer

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectState

public ObjectState(S id)

Instantiates a new object state.

Parameters:

id - the id

ObjectState

public ObjectState(S id,
                   PseudoState<S,E> pseudoState)

Instantiates a new object state.

Parameters:

id - the id

pseudoState - the pseudo state

ObjectState

public ObjectState(S id,
                   java.util.Collection<E> deferred)

Instantiates a new object state.

Parameters:

id - the id

deferred - the deferred

ObjectState

public ObjectState(S id,
                   java.util.Collection<E> deferred,
                   java.util.Collection<? extends Action<S,E>> entryActions,
                   java.util.Collection<? extends Action<S,E>> exitActions)

Instantiates a new object state.

Parameters:

id - the id

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

ObjectState

public ObjectState(S id,
                   java.util.Collection<E> deferred,
                   java.util.Collection<? extends Action<S,E>> entryActions,
                   java.util.Collection<? extends Action<S,E>> exitActions,
                   PseudoState<S,E> pseudoState)

Instantiates a new object state.

Parameters:

id - the id

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

ObjectState

public ObjectState(S id,
                   java.util.Collection<E> deferred,
                   java.util.Collection<? extends Action<S,E>> entryActions,
                   java.util.Collection<? extends Action<S,E>> exitActions,
                   PseudoState<S,E> pseudoState,
                   java.util.Collection<Region<S,E>> regions)

Instantiates a new object state.

Parameters:

id - the id

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

regions - the regions

ObjectState

public ObjectState(S id,
                   java.util.Collection<E> deferred,
                   java.util.Collection<? extends Action<S,E>> entryActions,
                   java.util.Collection<? extends Action<S,E>> exitActions,
                   PseudoState<S,E> pseudoState,
                   StateMachine<S,E> submachine)

Instantiates a new object state.

Parameters:

id - the id

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

submachine - the submachine

Method Detail

exit

public void exit(StateContext<S,E> context)

Description copied from interface: State

Initiate an exit sequence for the state.

Specified by:

exit in interface State<S,E>

Overrides:

exit in class AbstractState<S,E>

Parameters:

context - the state context

entry

public void entry(StateContext<S,E> context)

Description copied from interface: State

Initiate an entry sequence for the state.

Specified by:

entry in interface State<S,E>

Overrides:

entry in class AbstractState<S,E>

Parameters:

context - the state context

toString

public java.lang.String toString()

Overrides:

toString in class AbstractState<S,E>