org.springframework.statemachine.support

Class AbstractStateMachine<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.support.StateMachineObjectSupport<S,E>

org.springframework.statemachine.support.AbstractStateMachine<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.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, StateMachineAccess<S,E>, Region<S,E>, StateMachine<S,E>

Direct Known Subclasses:

ObjectStateMachine

public abstract class AbstractStateMachine<S,E>
extends StateMachineObjectSupport<S,E>
implements StateMachine<S,E>, StateMachineAccess<S,E>

Base implementation of a StateMachine loosely modelled from UML state machine.

Author:

Janne Valkealahti

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.statemachine.support.StateMachineObjectSupport

StateMachineObjectSupport.StateMachineListenerRelay

Constructor Summary

Constructors

Constructor and Description
AbstractStateMachine(java.util.Collection<State<S,E>> states, java.util.Collection<Transition<S,E>> transitions, State<S,E> initialState) Instantiates a new abstract state machine.
AbstractStateMachine(java.util.Collection<State<S,E>> states, java.util.Collection<Transition<S,E>> transitions, State<S,E> initialState, ExtendedState extendedState) Instantiates a new abstract state machine.
AbstractStateMachine(java.util.Collection<State<S,E>> states, java.util.Collection<Transition<S,E>> transitions, State<S,E> initialState, Transition<S,E> initialTransition, org.springframework.messaging.Message<E> initialEvent, ExtendedState extendedState, java.util.UUID uuid) Instantiates a new abstract state machine.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptEvent(org.springframework.messaging.Message<E> message)
void	addStateListener(StateMachineListener<S,E> listener) Adds the state listener.
void	addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor) Adds the state machine interceptor.
void	addStateMachineMonitor(StateMachineMonitor<S,E> monitor) Adds the state machine monitor.
protected void	doDestroy()
protected void	doStart() Subclasses may implement this method with the start behavior.
protected void	doStop() Subclasses may implement this method with the stop behavior.
ExtendedState	getExtendedState() Gets the state machine extended state.
PseudoState<S,E>	getHistoryState()
java.lang.String	getId() Gets the region and state machine id.
State<S,E>	getInitialState() Gets the initial state S.
State<S,E>	getState() Gets the current State.
StateMachineAccessor<S,E>	getStateMachineAccessor() Gets the state machine accessor.
java.util.Collection<State<S,E>>	getStates() Gets the States defined in this machine.
java.util.Collection<Transition<S,E>>	getTransitions() Gets a Transitions for this region.
java.util.UUID	getUuid() Gets the region and state machine unique id.
boolean	hasStateMachineError() Checks for state machine error.
boolean	isComplete() Checks if region complete.
protected void	notifyEventNotAccepted(StateContext<S,E> stateContext)
protected void	onInit() Subclasses may implement this for initialization logic.
void	removeStateListener(StateMachineListener<S,E> listener) Removes the state listener.
void	resetStateMachine(StateMachineContext<S,E> stateMachineContext) Reset state machine.
boolean	sendEvent(E event) Send an event E to the region.
boolean	sendEvent(org.springframework.messaging.Message<E> event) Send an event E wrapped with a Message to the region.
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setForwardedInitialEvent(org.springframework.messaging.Message<E> message) Set initial forwarded event which is used for passing in event and its headers for actions executed when sub state is entered via initial transition.
void	setHistoryState(PseudoState<S,E> history)
void	setId(java.lang.String id) Sets the machine id.
void	setInitialEnabled(boolean enabled) Sets if initial state is enabled when a state machine is using sub states.
void	setParentMachine(StateMachine<S,E> parentMachine) Sets the parent machine.
void	setRelay(StateMachine<S,E> stateMachine) Sets the relay state machine.
void	setStateMachineError(java.lang.Exception exception) Sets the state machine error.
protected void	stateChangedInRelay()
java.lang.String	toString()

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

getBeanName, getStateListener, getStateMachineEventPublisher, getStateMachineInterceptors, getStateMachineMonitor, notifyActionMonitor, notifyExtendedStateChanged, notifyStateChanged, notifyStateEntered, notifyStateExited, notifyStateMachineError, notifyStateMachineStarted, notifyStateMachineStopped, notifyTransition, notifyTransitionEnd, notifyTransitionMonitor, notifyTransitionStart, setBeanName, setContextEventsEnabled, setStateMachineEventPublisher, setStateMachineInterceptors

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.statemachine.region.Region

start, stop

Constructor Detail

AbstractStateMachine

public AbstractStateMachine(java.util.Collection<State<S,E>> states,
                            java.util.Collection<Transition<S,E>> transitions,
                            State<S,E> initialState)

Instantiates a new abstract state machine.

Parameters:

states - the states of this machine

transitions - the transitions of this machine

initialState - the initial state of this machine

AbstractStateMachine

public AbstractStateMachine(java.util.Collection<State<S,E>> states,
                            java.util.Collection<Transition<S,E>> transitions,
                            State<S,E> initialState,
                            ExtendedState extendedState)

Instantiates a new abstract state machine.

Parameters:

states - the states of this machine

transitions - the transitions of this machine

initialState - the initial state of this machine

extendedState - the extended state of this machine

AbstractStateMachine

public AbstractStateMachine(java.util.Collection<State<S,E>> states,
                            java.util.Collection<Transition<S,E>> transitions,
                            State<S,E> initialState,
                            Transition<S,E> initialTransition,
                            org.springframework.messaging.Message<E> initialEvent,
                            ExtendedState extendedState,
                            java.util.UUID uuid)

Instantiates a new abstract state machine.

Parameters:

states - the states of this machine

transitions - the transitions of this machine

initialState - the initial state of this machine

initialTransition - the initial transition

initialEvent - the initial event of this machine

extendedState - the extended state of this machine

uuid - the given uuid for this machine

Method Detail

getState

public State<S,E> getState()

Description copied from interface: Region

Gets the current State.

Specified by:

getState in interface Region<S,E>

Returns:

current state

getInitialState

public State<S,E> getInitialState()

Description copied from interface: StateMachine

Gets the initial state S.

Specified by:

getInitialState in interface StateMachine<S,E>

Returns:

initial state

getExtendedState

public ExtendedState getExtendedState()

Description copied from interface: StateMachine

Gets the state machine extended state.

Specified by:

getExtendedState in interface StateMachine<S,E>

Returns:

extended state

setHistoryState

public void setHistoryState(PseudoState<S,E> history)

Parameters:

history - to set internal history state.

getHistoryState

public PseudoState<S,E> getHistoryState()

Returns:

history state attribute.

sendEvent

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

Description copied from interface: Region

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

Specified by:

sendEvent in interface Region<S,E>

Parameters:

event - the wrapped event to send

Returns:

true if event was accepted

notifyEventNotAccepted

protected void notifyEventNotAccepted(StateContext<S,E> stateContext)

Overrides:

notifyEventNotAccepted in class StateMachineObjectSupport<S,E>

sendEvent

public boolean sendEvent(E event)

Description copied from interface: Region

Send an event E to the region.

Specified by:

sendEvent in interface Region<S,E>

Parameters:

event - the event to send

Returns:

true if event was accepted

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: LifecycleObjectSupport

Subclasses may implement this for initialization logic. Called during the InitializingBean phase. Implementor should always call super method not to break initialization chain.

Overrides:

onInit in class LifecycleObjectSupport

Throws:

java.lang.Exception - exception

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Overrides:

setBeanFactory in class LifecycleObjectSupport

Throws:

org.springframework.beans.BeansException

doStart

protected void doStart()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the start behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStart in class StateMachineObjectSupport<S,E>

doStop

protected void doStop()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the stop behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStop in class LifecycleObjectSupport

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class LifecycleObjectSupport

setStateMachineError

public void setStateMachineError(java.lang.Exception exception)

Description copied from interface: StateMachine

Sets the state machine error.

Specified by:

setStateMachineError in interface StateMachine<S,E>

Parameters:

exception - the new state machine error

hasStateMachineError

public boolean hasStateMachineError()

Description copied from interface: StateMachine

Checks for state machine error.

Specified by:

hasStateMachineError in interface StateMachine<S,E>

Returns:

true, if error has been set

addStateListener

public void addStateListener(StateMachineListener<S,E> listener)

Description copied from interface: Region

Adds the state listener.

Specified by:

addStateListener in interface Region<S,E>

Parameters:

listener - the listener

removeStateListener

public void removeStateListener(StateMachineListener<S,E> listener)

Description copied from interface: Region

Removes the state listener.

Specified by:

removeStateListener in interface Region<S,E>

Parameters:

listener - the listener

isComplete

public boolean isComplete()

Description copied from interface: Region

Checks if region complete. Region is considered to be completed if it has reached its end state and no further event processing is happening.

Specified by:

isComplete in interface Region<S,E>

Returns:

true, if complete

getStates

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

Gets the States defined in this machine. Returned collection is an unmodifiable copy because states in a state machine are immutable.

Specified by:

getStates in interface Region<S,E>

Returns:

immutable copy of existing states

getTransitions

public java.util.Collection<Transition<S,E>> getTransitions()

Description copied from interface: Region

Gets a Transitions for this region.

Specified by:

getTransitions in interface Region<S,E>

Returns:

immutable copy of transitions

setInitialEnabled

public void setInitialEnabled(boolean enabled)

Description copied from interface: StateMachineAccess

Sets if initial state is enabled when a state machine is using sub states.

Specified by:

setInitialEnabled in interface StateMachineAccess<S,E>

Parameters:

enabled - the new initial enabled

getStateMachineAccessor

public StateMachineAccessor<S,E> getStateMachineAccessor()

Description copied from interface: StateMachine

Gets the state machine accessor.

Specified by:

getStateMachineAccessor in interface StateMachine<S,E>

Returns:

the state machine accessor

setRelay

public void setRelay(StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineAccess

Sets the relay state machine.

Specified by:

setRelay in interface StateMachineAccess<S,E>

Parameters:

stateMachine - the state machine

setParentMachine

public void setParentMachine(StateMachine<S,E> parentMachine)

Description copied from interface: StateMachineAccess

Sets the parent machine.

Specified by:

setParentMachine in interface StateMachineAccess<S,E>

Parameters:

parentMachine - the state machine

stateChangedInRelay

protected void stateChangedInRelay()

Overrides:

stateChangedInRelay in class StateMachineObjectSupport<S,E>

setForwardedInitialEvent

public void setForwardedInitialEvent(org.springframework.messaging.Message<E> message)

Description copied from interface: StateMachineAccess

Set initial forwarded event which is used for passing in event and its headers for actions executed when sub state is entered via initial transition.

Specified by:

setForwardedInitialEvent in interface StateMachineAccess<S,E>

Parameters:

message - the forwarded message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

resetStateMachine

public void resetStateMachine(StateMachineContext<S,E> stateMachineContext)

Description copied from interface: StateMachineAccess

Reset state machine.

Specified by:

resetStateMachine in interface StateMachineAccess<S,E>

Parameters:

stateMachineContext - the state machine context

addStateMachineInterceptor

public void addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor)

Description copied from interface: StateMachineAccess

Adds the state machine interceptor.

Specified by:

addStateMachineInterceptor in interface StateMachineAccess<S,E>

Parameters:

interceptor - the interceptor

addStateMachineMonitor

public void addStateMachineMonitor(StateMachineMonitor<S,E> monitor)

Description copied from interface: StateMachineAccess

Adds the state machine monitor.

Specified by:

addStateMachineMonitor in interface StateMachineAccess<S,E>

Parameters:

monitor - the monitor

getUuid

public java.util.UUID getUuid()

Description copied from interface: Region

Gets the region and state machine unique id.

Specified by:

getUuid in interface Region<S,E>

Returns:

the region and state machine unique id

getId

public java.lang.String getId()

Description copied from interface: Region

Gets the region and state machine id. This identifier is provided for users disposal and can be set from a various ways to build a machines.

Specified by:

getId in interface Region<S,E>

Returns:

the region and state machine id

setId

public void setId(java.lang.String id)

Sets the machine id.

Parameters:

id - the new machine id

acceptEvent

protected boolean acceptEvent(org.springframework.messaging.Message<E> message)