org.springframework.statemachine.config

Class AbstractStateMachineFactory<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.config.AbstractStateMachineFactory<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, StateMachineFactory<S,E>

Direct Known Subclasses:

ObjectStateMachineFactory

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

Base StateMachineFactory implementation building StateMachines.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractStateMachineFactory(StateMachineModel<S,E> defaultStateMachineModel, StateMachineModelFactory<S,E> stateMachineModelFactory) Instantiates a new abstract state machine factory.

Method Summary

Modifier and Type	Method and Description
protected abstract RegionState<S,E>	buildRegionStateInternal(S id, java.util.Collection<Region<S,E>> regions, 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)
protected abstract State<S,E>	buildStateInternal(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, StateMachineModel<S,E> stateMachineModel)
protected abstract StateMachine<S,E>	buildStateMachineInternal(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, PseudoState<S,E> historyState, java.lang.Boolean contextEventsEnabled, org.springframework.beans.factory.BeanFactory beanFactory, org.springframework.core.task.TaskExecutor taskExecutor, org.springframework.scheduling.TaskScheduler taskScheduler, java.lang.String beanName, java.lang.String machineId, java.util.UUID uuid, StateMachineModel<S,E> stateMachineModel)
StateMachine<S,E>	getStateMachine() Build a new StateMachine instance.
StateMachine<S,E>	getStateMachine(java.lang.String machineId) Build a new StateMachine instance with a given machine id.
StateMachine<S,E>	getStateMachine(java.util.UUID uuid) Build a new StateMachine instance with a given machine uuid.
StateMachine<S,E>	getStateMachine(java.util.UUID uuid, java.lang.String machineId) Main constructor that create a StateMachine.
protected org.springframework.beans.factory.BeanFactory	resolveBeanFactory(StateMachineModel<S,E> stateMachineModel)
protected StateMachineModel<S,E>	resolveStateMachineModel(java.lang.String machineId)
protected org.springframework.core.task.TaskExecutor	resolveTaskExecutor(StateMachineModel<S,E> stateMachineModel)
protected org.springframework.scheduling.TaskScheduler	resolveTaskScheduler(StateMachineModel<S,E> stateMachineModel)
void	setBeanName(java.lang.String name)
void	setContextEventsEnabled(java.lang.Boolean contextEvents) Instructs this factory to enable application context events.
void	setHandleAutostartup(boolean handleAutostartup) Instructs this factory to handle auto-start flag manually by calling lifecycle start method.
void	setStateMachineMonitor(StateMachineMonitor<S,E> stateMachineMonitor) Set state machine monitor.

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

afterPropertiesSet, destroy, doDestroy, doStart, 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

AbstractStateMachineFactory

public AbstractStateMachineFactory(StateMachineModel<S,E> defaultStateMachineModel,
                                   StateMachineModelFactory<S,E> stateMachineModelFactory)

Instantiates a new abstract state machine factory.

Parameters:

defaultStateMachineModel - the default state machine model

stateMachineModelFactory - the state machine model factory

Method Detail

setBeanName

public void setBeanName(java.lang.String name)

Specified by:

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

getStateMachine

public StateMachine<S,E> getStateMachine()

Description copied from interface: StateMachineFactory

Build a new StateMachine instance.

Specified by:

getStateMachine in interface StateMachineFactory<S,E>

Returns:

a new state machine instance.

getStateMachine

public StateMachine<S,E> getStateMachine(java.lang.String machineId)

Description copied from interface: StateMachineFactory

Build a new StateMachine instance with a given machine id.

Specified by:

getStateMachine in interface StateMachineFactory<S,E>

Parameters:

machineId - the machine id

Returns:

a new state machine instance.

getStateMachine

public StateMachine<S,E> getStateMachine(java.util.UUID uuid)

Description copied from interface: StateMachineFactory

Build a new StateMachine instance with a given machine uuid.

Specified by:

getStateMachine in interface StateMachineFactory<S,E>

Parameters:

uuid - to be used internally

Returns:

a new state machine instance.

getStateMachine

public StateMachine<S,E> getStateMachine(java.util.UUID uuid,
                                         java.lang.String machineId)

Main constructor that create a StateMachine.

Parameters:

uuid - for internal usage. Can be null, in that case a random one will be generated.

machineId - represent a user Id, up to you to set what you want.

Returns:

a StateMachine

setHandleAutostartup

public void setHandleAutostartup(boolean handleAutostartup)

Instructs this factory to handle auto-start flag manually by calling lifecycle start method.

Parameters:

handleAutostartup - the new handle autostartup

setContextEventsEnabled

public void setContextEventsEnabled(java.lang.Boolean contextEvents)

Instructs this factory to enable application context events.

Parameters:

contextEvents - the new context events enabled

setStateMachineMonitor

public void setStateMachineMonitor(StateMachineMonitor<S,E> stateMachineMonitor)

Set state machine monitor.

Parameters:

stateMachineMonitor - the state machine monitor

resolveBeanFactory

protected org.springframework.beans.factory.BeanFactory resolveBeanFactory(StateMachineModel<S,E> stateMachineModel)

resolveTaskExecutor

protected org.springframework.core.task.TaskExecutor resolveTaskExecutor(StateMachineModel<S,E> stateMachineModel)

resolveTaskScheduler

protected org.springframework.scheduling.TaskScheduler resolveTaskScheduler(StateMachineModel<S,E> stateMachineModel)

resolveStateMachineModel

protected StateMachineModel<S,E> resolveStateMachineModel(java.lang.String machineId)

buildStateMachineInternal

protected abstract StateMachine<S,E> buildStateMachineInternal(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,
                                                               PseudoState<S,E> historyState,
                                                               java.lang.Boolean contextEventsEnabled,
                                                               org.springframework.beans.factory.BeanFactory beanFactory,
                                                               org.springframework.core.task.TaskExecutor taskExecutor,
                                                               org.springframework.scheduling.TaskScheduler taskScheduler,
                                                               java.lang.String beanName,
                                                               java.lang.String machineId,
                                                               java.util.UUID uuid,
                                                               StateMachineModel<S,E> stateMachineModel)

buildStateInternal

protected abstract State<S,E> buildStateInternal(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,
                                                 StateMachineModel<S,E> stateMachineModel)

buildRegionStateInternal

protected abstract RegionState<S,E> buildRegionStateInternal(S id,
                                                             java.util.Collection<Region<S,E>> regions,
                                                             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)