org.springframework.statemachine.state

Class AbstractSimpleState<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

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

org.springframework.statemachine.state.AbstractSimpleState<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>

Direct Known Subclasses:

ObjectState

public abstract class AbstractSimpleState<S,E>
extends AbstractState<S,E>

Base implementation of a State having a single state identifier.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleState(S id) Instantiates a new abstract simple state.
AbstractSimpleState(S id, java.util.Collection<E> deferred) Instantiates a new abstract simple state.
AbstractSimpleState(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 abstract simple state.
AbstractSimpleState(S id, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, java.util.Collection<? extends Action<S,E>> stateActions, PseudoState<S,E> pseudoState, java.util.Collection<Region<S,E>> regions, StateMachine<S,E> submachine) Instantiates a new abstract simple state.
AbstractSimpleState(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 abstract simple state.
AbstractSimpleState(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 abstract simple state.
AbstractSimpleState(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 abstract simple state.
AbstractSimpleState(S id, PseudoState<S,E> pseudoState) Instantiates a new abstract simple state.

Method Summary

Modifier and Type	Method and Description
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.

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

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

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

AbstractSimpleState

public AbstractSimpleState(S id)

Instantiates a new abstract simple state.

Parameters:

id - the state identifier

AbstractSimpleState

public AbstractSimpleState(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 abstract simple state.

Parameters:

id - the state identifier

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

AbstractSimpleState

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

Instantiates a new abstract simple state.

Parameters:

id - the state identifier

deferred - the deferred

AbstractSimpleState

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

Instantiates a new abstract simple state.

Parameters:

id - the state identifier

pseudoState - the pseudo state

AbstractSimpleState

public AbstractSimpleState(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 abstract simple state.

Parameters:

id - the state identifier

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

regions - the regions

AbstractSimpleState

public AbstractSimpleState(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 abstract simple state.

Parameters:

id - the state identifier

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

submachine - the submachine

AbstractSimpleState

public AbstractSimpleState(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 abstract simple state.

Parameters:

id - the state identifier

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

pseudoState - the pseudo state

AbstractSimpleState

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

Instantiates a new abstract simple state.

Parameters:

id - the id

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

stateActions - the state actions

pseudoState - the pseudo state

regions - the regions

submachine - the submachine

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