org.springframework.statemachine.support

Interface StateMachineExecutor<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Known Implementing Classes:

DefaultStateMachineExecutor

public interface StateMachineExecutor<S,E>

Interface for a StateMachine event executor.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StateMachineExecutor.StateMachineExecutorTransit<S,E> Callback interface when executor wants to handle transit.

Method Summary

Modifier and Type	Method and Description
void	addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor) Adds the state machine interceptor.
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.
void	start() Start executor.
void	stop() Stop executor.

Method Detail

queueEvent

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

Queue event.

Parameters:

message - the message

queueTrigger

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

Queue trigger.

Parameters:

trigger - the trigger

message - the message

queueDeferredEvent

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

Queue deferred event.

Parameters:

message - the message

executeTriggerlessTransitions

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

Execute and check all triggerless transitions.

Parameters:

context - the state context

state - the state

execute

void execute()

Execute StateMachineExecutor logic.

setInitialEnabled

void setInitialEnabled(boolean enabled)

Sets the if initial stage is enabled.

Parameters:

enabled - the new flag

start

void start()

Start executor.

See Also:

LifecycleObjectSupport.start()

stop

void stop()

Stop executor.

See Also:

LifecycleObjectSupport.stop()

setForwardedInitialEvent

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

Set initial forwarded event.

Parameters:

message - the forwarded message

See Also:

StateMachineAccess.setForwardedInitialEvent(Message)

setStateMachineExecutorTransit

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

Sets the state machine executor transit.

Parameters:

stateMachineExecutorTransit - the state machine executor transit

addStateMachineInterceptor

void addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor)

Adds the state machine interceptor.

Parameters:

interceptor - the interceptor

getLock

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

Gets the execution lock.

Returns:

the execution lock