org.springframework.statemachine.support

Class DefaultStateMachineExecutor<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.support.DefaultStateMachineExecutor<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, StateMachineExecutor<S,E>

public class DefaultStateMachineExecutor<S,E>
extends LifecycleObjectSupport
implements StateMachineExecutor<S,E>

Default implementation of a StateMachineExecutor.

Author:

Janne Valkealahti

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.statemachine.support.StateMachineExecutor

StateMachineExecutor.StateMachineExecutorTransit<S,E>

Constructor Summary

Constructors

Constructor and Description

DefaultStateMachineExecutor(StateMachine<S,E> stateMachine, StateMachine<S,E> relayStateMachine, java.util.Collection<Transition<S,E>> transitions, java.util.Map<Trigger<S,E>,Transition<S,E>> triggerToTransitionMap, java.util.List<Transition<S,E>> triggerlessTransitions, Transition<S,E> initialTransition, org.springframework.messaging.Message<E> initialEvent, TransitionConflictPolicy transitionConflictPolicy) Instantiates a new default state machine executor.

Method Summary

Modifier and Type	Method and Description
void	addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor) Adds the state machine interceptor.
protected void	doStart() Subclasses may implement this method with the start behavior.
protected void	doStop() Subclasses may implement this method with the stop behavior.
void	execute() Execute StateMachineExecutor logic.
void	executeTriggerlessTransitions(StateContext<S,E> context, State<S,E> state) Execute and check all triggerless transitions.
java.util.concurrent.locks.Lock	getLock() Gets the execution lock.
void	queueDeferredEvent(org.springframework.messaging.Message<E> message) Queue deferred event.
void	queueEvent(org.springframework.messaging.Message<E> message) Queue event.
void	queueTrigger(Trigger<S,E> trigger, org.springframework.messaging.Message<E> message) Queue trigger.
void	setForwardedInitialEvent(org.springframework.messaging.Message<E> message) Set initial forwarded event.
void	setInitialEnabled(boolean enabled) Sets the if initial stage is enabled.
void	setStateMachineExecutorTransit(StateMachineExecutor.StateMachineExecutorTransit<S,E> stateMachineExecutorTransit) Sets the state machine executor transit.

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, toString, wait, wait, wait

Methods inherited from interface org.springframework.statemachine.support.StateMachineExecutor

start, stop

Constructor Detail

DefaultStateMachineExecutor

public DefaultStateMachineExecutor(StateMachine<S,E> stateMachine,
                                   StateMachine<S,E> relayStateMachine,
                                   java.util.Collection<Transition<S,E>> transitions,
                                   java.util.Map<Trigger<S,E>,Transition<S,E>> triggerToTransitionMap,
                                   java.util.List<Transition<S,E>> triggerlessTransitions,
                                   Transition<S,E> initialTransition,
                                   org.springframework.messaging.Message<E> initialEvent,
                                   TransitionConflictPolicy transitionConflictPolicy)

Instantiates a new default state machine executor.

Parameters:

stateMachine - the state machine

relayStateMachine - the relay state machine

transitions - the transitions

triggerToTransitionMap - the trigger to transition map

triggerlessTransitions - the triggerless transitions

initialTransition - the initial transition

initialEvent - the initial event

transitionConflictPolicy - the transition conflict policy

Method Detail

queueEvent

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

Description copied from interface: StateMachineExecutor

Queue event.

Specified by:

queueEvent in interface StateMachineExecutor<S,E>

Parameters:

message - the message

queueTrigger

public void queueTrigger(Trigger<S,E> trigger,
                         org.springframework.messaging.Message<E> message)

Description copied from interface: StateMachineExecutor

Queue trigger.

Specified by:

queueTrigger in interface StateMachineExecutor<S,E>

Parameters:

trigger - the trigger

message - the message

queueDeferredEvent

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

Description copied from interface: StateMachineExecutor

Queue deferred event.

Specified by:

queueDeferredEvent in interface StateMachineExecutor<S,E>

Parameters:

message - the message

execute

public void execute()

Description copied from interface: StateMachineExecutor

Execute StateMachineExecutor logic.

Specified by:

execute in interface StateMachineExecutor<S,E>

setStateMachineExecutorTransit

public void setStateMachineExecutorTransit(StateMachineExecutor.StateMachineExecutorTransit<S,E> stateMachineExecutorTransit)

Description copied from interface: StateMachineExecutor

Sets the state machine executor transit.

Specified by:

setStateMachineExecutorTransit in interface StateMachineExecutor<S,E>

Parameters:

stateMachineExecutorTransit - the state machine executor transit

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

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

setInitialEnabled

public void setInitialEnabled(boolean enabled)

Description copied from interface: StateMachineExecutor

Sets the if initial stage is enabled.

Specified by:

setInitialEnabled in interface StateMachineExecutor<S,E>

Parameters:

enabled - the new flag

setForwardedInitialEvent

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

Description copied from interface: StateMachineExecutor

Set initial forwarded event.

Specified by:

setForwardedInitialEvent in interface StateMachineExecutor<S,E>

Parameters:

message - the forwarded message

See Also:

StateMachineAccess.setForwardedInitialEvent(Message)

addStateMachineInterceptor

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

Description copied from interface: StateMachineExecutor

Adds the state machine interceptor.

Specified by:

addStateMachineInterceptor in interface StateMachineExecutor<S,E>

Parameters:

interceptor - the interceptor

getLock

public java.util.concurrent.locks.Lock getLock()

Description copied from interface: StateMachineExecutor

Gets the execution lock.

Specified by:

getLock in interface StateMachineExecutor<S,E>

Returns:

the execution lock

executeTriggerlessTransitions

public void executeTriggerlessTransitions(StateContext<S,E> context,
                                          State<S,E> state)

Description copied from interface: StateMachineExecutor

Execute and check all triggerless transitions.

Specified by:

executeTriggerlessTransitions in interface StateMachineExecutor<S,E>

Parameters:

context - the state context

state - the state