com.tangosol.util.fsm

Class Transition<S extends Enum<S>>

java.lang.Object

com.tangosol.util.fsm.Transition<S>

Type Parameters:

S - the type of the state of the FiniteStateMachine

public class Transition<S extends Enum<S>>
extends Object

A Transition represents a transition in a FiniteStateMachine from one or more possible states to a desired state.

Since:

Coherence 12.2.1

Author:

Brian Oliver

Constructor Summary

Constructors

Constructor and Description
Transition(String sName, EnumSet<S> statesFrom, S stateTo) Constructs a Transition (without an TransitionAction).
Transition(String sName, EnumSet<S> statesFrom, S stateTo, TransitionAction<S> action) Constructs a Transition.
Transition(String sName, S stateFrom, S stateTo) Constructs a Transition (without an TransitionAction).
Transition(String sName, S stateFrom, S stateTo, TransitionAction<S> action) Constructs a Transition.

Method Summary

Modifier and Type	Method and Description
TransitionAction<S>	getAction() Obtains the TransitionAction to be performed for the Transition.
S	getEndingState() Obtains the state to which the FiniteStateMachine will be in once this Transition has occurred.
String	getName() Obtains the name of the Transition.
boolean	isStartingState(S state) Determines if the specified state is one of the possible starting states for the Transition.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Transition

public Transition(String sName,
                  EnumSet<S> statesFrom,
                  S stateTo)

Constructs a Transition (without an TransitionAction).

Parameters:

sName - the name of the Transition (used for display and logging purposes)

statesFrom - the set of states from which this Transition may occur

stateTo - the state once the TransitionAction has been successfully performed

Transition

public Transition(String sName,
                  S stateFrom,
                  S stateTo)

Constructs a Transition (without an TransitionAction).

Parameters:

sName - the name of the Transition (used for display and logging purposes)

stateFrom - the state from which this Transition may occur

stateTo - the state once the TransitionAction has been successfully performed

Transition

public Transition(String sName,
                  EnumSet<S> statesFrom,
                  S stateTo,
                  TransitionAction<S> action)

Constructs a Transition.

Parameters:

sName - the name of the Transition (used for display and logging purposes)

statesFrom - the set of states from which this Transition may occur

stateTo - the state once the TransitionAction has been successfully performed

action - the TransitionAction to be perform for the Transition

Transition

public Transition(String sName,
                  S stateFrom,
                  S stateTo,
                  TransitionAction<S> action)

Constructs a Transition.

Parameters:

sName - the name of the Transition (used for display and logging purposes)

stateFrom - the state from which this Transition may occur

stateTo - the state once the TransitionAction has been successfully performed

action - the TransitionAction to be perform for the Transition

Method Detail

getName

public String getName()

Obtains the name of the Transition.

Returns:

the name of the Transition

isStartingState

public boolean isStartingState(S state)

Determines if the specified state is one of the possible starting states for the Transition.

Parameters:

state - the state to check

Returns:

true if the specified state is one of the starting states for the Transition

getAction

public TransitionAction<S> getAction()

Obtains the TransitionAction to be performed for the Transition.

Returns:

the TransitionAction for the transition

getEndingState

public S getEndingState()

Obtains the state to which the FiniteStateMachine will be in once this Transition has occurred.

Returns:

the state of the FiniteStateMachine after this Transition has occurred

toString

public String toString()

Overrides:

toString in class Object