org.springframework.statemachine.transition

Interface Transition<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Known Implementing Classes:

AbstractExternalTransition, AbstractInternalTransition, AbstractLocalTransition, AbstractTransition, DefaultExternalTransition, DefaultInternalTransition, DefaultLocalTransition, InitialTransition

public interface Transition<S,E>

Transition is something what a state machine associates with a state changes.

Author:

Janne Valkealahti

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener<S,E> listener) Adds the action listener.
void	executeTransitionActions(StateContext<S,E> context) Execute transition actions.
java.util.Collection<Action<S,E>>	getActions() Gets the transition actions.
Guard<S,E>	getGuard() Gets the guard of this transition.
TransitionKind	getKind() Gets the transition kind.
SecurityRule	getSecurityRule() Gets the security rule.
State<S,E>	getSource() Gets the source state of this transition.
State<S,E>	getTarget() Gets the target state of this transition.
Trigger<S,E>	getTrigger() Gets the transition trigger.
void	removeActionListener(ActionListener<S,E> listener) Removes the action listener.
boolean	transit(StateContext<S,E> context) Transit this transition with a give state context.

Method Detail

transit

boolean transit(StateContext<S,E> context)

Transit this transition with a give state context.

Parameters:

context - the state context

Returns:

true, if transition happened, false otherwise

executeTransitionActions

void executeTransitionActions(StateContext<S,E> context)

Execute transition actions.

Parameters:

context - the state context

getSource

State<S,E> getSource()

Gets the source state of this transition.

Returns:

the source state

getTarget

State<S,E> getTarget()

Gets the target state of this transition.

Returns:

the target state

getGuard

Guard<S,E> getGuard()

Gets the guard of this transition.

Returns:

the guard

getActions

java.util.Collection<Action<S,E>> getActions()

Gets the transition actions.

Returns:

the transition actions

getTrigger

Trigger<S,E> getTrigger()

Gets the transition trigger.

Returns:

the transition trigger

getKind

TransitionKind getKind()

Gets the transition kind.

Returns:

the transition kind

getSecurityRule

SecurityRule getSecurityRule()

Gets the security rule.

Returns:

the security rule

addActionListener

void addActionListener(ActionListener<S,E> listener)

Adds the action listener.

Parameters:

listener - the listener

removeActionListener

void removeActionListener(ActionListener<S,E> listener)

Removes the action listener.

Parameters:

listener - the listener