org.springframework.statemachine.state

Class StateMachineState<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

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

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

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, State<S,E>

public class StateMachineState<S,E>
extends AbstractState<S,E>

A State implementation where state is wrapped in a substatemachine.

Author:

Janne Valkealahti

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
StateMachineState(S id, StateMachine<S,E> submachine) Instantiates a new state machine state.
StateMachineState(S id, StateMachine<S,E> submachine, java.util.Collection<E> deferred) Instantiates a new state machine state.
StateMachineState(S id, StateMachine<S,E> submachine, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions) Instantiates a new state machine state.
StateMachineState(S id, StateMachine<S,E> submachine, 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 state machine state.
StateMachineState(S id, StateMachine<S,E> submachine, PseudoState<S,E> pseudoState) Instantiates a new state machine 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.util.Collection<S>	getIds() Gets the state identifiers.
java.util.Collection<State<S,E>>	getStates() Gets all possible states this state knows about including itself and substates.
boolean	sendEvent(org.springframework.messaging.Message<E> event) Send an event E wrapped with a Message to the state.
boolean	shouldDefer(org.springframework.messaging.Message<E> event) Checks if state wants to defer an event.
java.lang.String	toString()

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

addActionListener, addStateListener, armTriggers, cancelStateActions, disarmTriggers, doStart, doStop, executeAction, getDeferredEvents, getEntryActions, getExitActions, getId, getPseudoState, getRegions, getStateActions, getSubmachine, getTriggers, isComposite, isOrthogonal, isSimple, isSubmachineState, notifyStateOnComplete, removeActionListener, removeStateListener, scheduleAction, scheduleStateActions, setStateDoActionPolicy, setStateDoActionPolicyTimeout, setTriggers

Methods inherited from class org.springframework.statemachine.support.LifecycleObjectSupport

afterPropertiesSet, destroy, doDestroy, getBeanFactory, getPhase, getTaskExecutor, getTaskScheduler, isAutoStartup, isRunning, onInit, setAutoStartup, setBeanFactory, setPhase, setTaskExecutor, setTaskScheduler, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineState

public StateMachineState(S id,
                         StateMachine<S,E> submachine)

Instantiates a new state machine state.

Parameters:

id - the state identifier

submachine - the submachine

StateMachineState

public StateMachineState(S id,
                         StateMachine<S,E> submachine,
                         java.util.Collection<E> deferred)

Instantiates a new state machine state.

Parameters:

id - the state identifier

submachine - the submachine

deferred - the deferred

StateMachineState

public StateMachineState(S id,
                         StateMachine<S,E> submachine,
                         PseudoState<S,E> pseudoState)

Instantiates a new state machine state.

Parameters:

id - the state identifier

submachine - the submachine

pseudoState - the pseudo state

StateMachineState

public StateMachineState(S id,
                         StateMachine<S,E> submachine,
                         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 state machine state.

Parameters:

id - the state identifier

submachine - the submachine

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

StateMachineState

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

Instantiates a new state machine state.

Parameters:

id - the state identifier

submachine - the submachine

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

Method Detail

getIds

public java.util.Collection<S> getIds()

Description copied from interface: State

Gets the state identifiers. Usually returned collection contains only one identifier except in a case where state is an orthogonal.

Specified by:

getIds in interface State<S,E>

Specified by:

getIds in class AbstractState<S,E>

Returns:

the state identifiers

getStates

public java.util.Collection<State<S,E>> getStates()

Description copied from interface: State

Gets all possible states this state knows about including itself and substates.

Specified by:

getStates in interface State<S,E>

Specified by:

getStates in class AbstractState<S,E>

Returns:

all state including itself and nested states

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

sendEvent

public boolean sendEvent(org.springframework.messaging.Message<E> event)

Description copied from interface: State

Send an event E wrapped with a Message to the state.

Specified by:

sendEvent in interface State<S,E>

Overrides:

sendEvent in class AbstractState<S,E>

Parameters:

event - the wrapped event to send

Returns:

true if event was accepted

shouldDefer

public boolean shouldDefer(org.springframework.messaging.Message<E> event)

Description copied from interface: State

Checks if state wants to defer an event.

Specified by:

shouldDefer in interface State<S,E>

Overrides:

shouldDefer in class AbstractState<S,E>

Parameters:

event - the wrapped event

Returns:

true if event should be deferred

toString

public java.lang.String toString()

Overrides:

toString in class AbstractState<S,E>