org.springframework.statemachine.transition

Class AbstractTransition<S,E>

java.lang.Object

org.springframework.statemachine.transition.AbstractTransition<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

Transition<S,E>

Direct Known Subclasses:

AbstractExternalTransition, AbstractInternalTransition, AbstractLocalTransition, InitialTransition

public abstract class AbstractTransition<S,E>
extends java.lang.Object
implements Transition<S,E>

Base implementation of a Transition.

Author:

Janne Valkealahti

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<Action<S,E>>	actions
protected State<S,E>	target

Constructor Summary

Constructors

Constructor and Description
AbstractTransition(State<S,E> source, State<S,E> target, java.util.Collection<Action<S,E>> actions, E event, TransitionKind kind, Guard<S,E> guard, Trigger<S,E> trigger) Instantiates a new abstract transition.
AbstractTransition(State<S,E> source, State<S,E> target, java.util.Collection<Action<S,E>> actions, E event, TransitionKind kind, Guard<S,E> guard, Trigger<S,E> trigger, SecurityRule securityRule) Instantiates a new abstract transition.

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.
java.lang.String	toString()
boolean	transit(StateContext<S,E> context) Transit this transition with a give state context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

target

protected final State<S,E> target

actions

protected final java.util.Collection<Action<S,E>> actions

Constructor Detail

AbstractTransition

public AbstractTransition(State<S,E> source,
                          State<S,E> target,
                          java.util.Collection<Action<S,E>> actions,
                          E event,
                          TransitionKind kind,
                          Guard<S,E> guard,
                          Trigger<S,E> trigger)

Instantiates a new abstract transition.

Parameters:

source - the source

target - the target

actions - the actions

event - the event

kind - the kind

guard - the guard

trigger - the trigger

AbstractTransition

public AbstractTransition(State<S,E> source,
                          State<S,E> target,
                          java.util.Collection<Action<S,E>> actions,
                          E event,
                          TransitionKind kind,
                          Guard<S,E> guard,
                          Trigger<S,E> trigger,
                          SecurityRule securityRule)

Instantiates a new abstract transition.

Parameters:

source - the source

target - the target

actions - the actions

event - the event

kind - the kind

guard - the guard

trigger - the trigger

securityRule - the security rule

Method Detail

getSource

public State<S,E> getSource()

Description copied from interface: Transition

Gets the source state of this transition.

Specified by:

getSource in interface Transition<S,E>

Returns:

the source state

getTrigger

public Trigger<S,E> getTrigger()

Description copied from interface: Transition

Gets the transition trigger.

Specified by:

getTrigger in interface Transition<S,E>

Returns:

the transition trigger

transit

public boolean transit(StateContext<S,E> context)

Description copied from interface: Transition

Transit this transition with a give state context.

Specified by:

transit in interface Transition<S,E>

Parameters:

context - the state context

Returns:

true, if transition happened, false otherwise

getGuard

public Guard<S,E> getGuard()

Description copied from interface: Transition

Gets the guard of this transition.

Specified by:

getGuard in interface Transition<S,E>

Returns:

the guard

getKind

public TransitionKind getKind()

Description copied from interface: Transition

Gets the transition kind.

Specified by:

getKind in interface Transition<S,E>

Returns:

the transition kind

getSecurityRule

public SecurityRule getSecurityRule()

Description copied from interface: Transition

Gets the security rule.

Specified by:

getSecurityRule in interface Transition<S,E>

Returns:

the security rule

getTarget

public State<S,E> getTarget()

Description copied from interface: Transition

Gets the target state of this transition.

Specified by:

getTarget in interface Transition<S,E>

Returns:

the target state

getActions

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

Description copied from interface: Transition

Gets the transition actions.

Specified by:

getActions in interface Transition<S,E>

Returns:

the transition actions

addActionListener

public void addActionListener(ActionListener<S,E> listener)

Description copied from interface: Transition

Adds the action listener.

Specified by:

addActionListener in interface Transition<S,E>

Parameters:

listener - the listener

removeActionListener

public void removeActionListener(ActionListener<S,E> listener)

Description copied from interface: Transition

Removes the action listener.

Specified by:

removeActionListener in interface Transition<S,E>

Parameters:

listener - the listener

executeTransitionActions

public final void executeTransitionActions(StateContext<S,E> context)

Description copied from interface: Transition

Execute transition actions.

Specified by:

executeTransitionActions in interface Transition<S,E>

Parameters:

context - the state context

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object