org.springframework.statemachine.support

Class StateMachineObjectSupport<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.support.StateMachineObjectSupport<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

Direct Known Subclasses:

AbstractStateMachine

public abstract class StateMachineObjectSupport<S,E>
extends LifecycleObjectSupport
implements org.springframework.beans.factory.BeanNameAware

Support and helper class for base state machine implementation.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StateMachineObjectSupport.StateMachineListenerRelay This class is used to relay listener events from a submachines which works as its own listener context.

Constructor Summary

Constructors

Constructor and Description
StateMachineObjectSupport()

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Subclasses may implement this method with the start behavior.
protected java.lang.String	getBeanName() Returns a bean name known to context per contract with BeanNameAware.
protected CompositeStateMachineListener<S,E>	getStateListener()
protected StateMachineEventPublisher	getStateMachineEventPublisher() Gets the state machine event publisher.
protected StateMachineInterceptorList<S,E>	getStateMachineInterceptors()
protected CompositeStateMachineMonitor<S,E>	getStateMachineMonitor()
protected void	notifyActionMonitor(StateMachine<S,E> stateMachine, Action<S,E> action, long duration)
protected void	notifyEventNotAccepted(StateContext<S,E> stateContext)
protected void	notifyExtendedStateChanged(java.lang.Object key, java.lang.Object value, StateContext<S,E> stateContext)
protected void	notifyStateChanged(StateContext<S,E> stateContext)
protected void	notifyStateEntered(StateContext<S,E> stateContext)
protected void	notifyStateExited(StateContext<S,E> stateContext)
protected void	notifyStateMachineError(StateContext<S,E> stateContext)
protected void	notifyStateMachineStarted(StateContext<S,E> stateContext)
protected void	notifyStateMachineStopped(StateContext<S,E> stateContext)
protected void	notifyTransition(StateContext<S,E> stateContext)
protected void	notifyTransitionEnd(StateContext<S,E> stateContext)
protected void	notifyTransitionMonitor(StateMachine<S,E> stateMachine, Transition<S,E> transition, long duration)
protected void	notifyTransitionStart(StateContext<S,E> stateContext)
void	setBeanName(java.lang.String name)
void	setContextEventsEnabled(boolean contextEventsEnabled) Set if context application events are enabled.
void	setStateMachineEventPublisher(StateMachineEventPublisher stateMachineEventPublisher) Sets the state machine event publisher.
protected void	setStateMachineInterceptors(java.util.List<StateMachineInterceptor<S,E>> interceptors)
protected void	stateChangedInRelay()

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

afterPropertiesSet, destroy, doDestroy, doStop, 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, toString, wait, wait, wait

Constructor Detail

StateMachineObjectSupport

public StateMachineObjectSupport()

Method Detail

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 LifecycleObjectSupport

setBeanName

public void setBeanName(java.lang.String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getBeanName

protected java.lang.String getBeanName()

Returns a bean name known to context per contract with BeanNameAware.

Returns:

a bean name

getStateMachineEventPublisher

protected StateMachineEventPublisher getStateMachineEventPublisher()

Gets the state machine event publisher.

Returns:

the state machine event publisher

setStateMachineEventPublisher

public void setStateMachineEventPublisher(StateMachineEventPublisher stateMachineEventPublisher)

Sets the state machine event publisher.

Parameters:

stateMachineEventPublisher - the new state machine event publisher

setContextEventsEnabled

public void setContextEventsEnabled(boolean contextEventsEnabled)

Set if context application events are enabled. Events are enabled by default. Set this to false if you don't want state machine to send application context events.

Parameters:

contextEventsEnabled - the enabled flag

getStateListener

protected CompositeStateMachineListener<S,E> getStateListener()

getStateMachineMonitor

protected CompositeStateMachineMonitor<S,E> getStateMachineMonitor()

notifyStateChanged

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

notifyStateEntered

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

notifyStateExited

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

notifyEventNotAccepted

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

notifyTransitionStart

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

notifyTransition

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

notifyTransitionEnd

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

notifyStateMachineStarted

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

notifyStateMachineStopped

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

notifyStateMachineError

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

notifyExtendedStateChanged

protected void notifyExtendedStateChanged(java.lang.Object key,
                                          java.lang.Object value,
                                          StateContext<S,E> stateContext)

notifyTransitionMonitor

protected void notifyTransitionMonitor(StateMachine<S,E> stateMachine,
                                       Transition<S,E> transition,
                                       long duration)

notifyActionMonitor

protected void notifyActionMonitor(StateMachine<S,E> stateMachine,
                                   Action<S,E> action,
                                   long duration)

stateChangedInRelay

protected void stateChangedInRelay()

getStateMachineInterceptors

protected StateMachineInterceptorList<S,E> getStateMachineInterceptors()

setStateMachineInterceptors

protected void setStateMachineInterceptors(java.util.List<StateMachineInterceptor<S,E>> interceptors)