Package org.apache.mina.statemachine

Class State

java.lang.Object

org.apache.mina.statemachine.State

public class State
extends java.lang.Object

Represents a state in a StateMachine. Normally you wouldn't create instances of this class directly but rather use the State annotation to define your states and then let StateMachineFactory create a StateMachine for you.

States inherits Transitions from their parent. A State can override any of the parents Transitions. When an Event is processed the Transitions of the current State will be searched for a Transition which can handle the event. If none is found the State's parent will be searched and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	State.TransitionHolder

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	id	The state ID
private java.util.List<SelfTransition>	onEntries	The list of entry transitions on a state
private java.util.List<SelfTransition>	onExits	The list of exit transition from a state
private State	parent	The parent state
private java.util.List<State.TransitionHolder>	transitionHolders
private java.util.List<Transition>	transitions	The list of transitions for this state

Constructor Summary

Constructors

Constructor	Description
State(java.lang.String id)	Creates a new State with the specified id.
State(java.lang.String id, State parent)	Creates a new State with the specified id and parent.

Method Summary

Modifier and Type	Method	Description
(package private) State	addOnEntrySelfTransaction(SelfTransition onEntrySelfTransaction)	Adds an entry SelfTransition to this State
(package private) State	addOnExitSelfTransaction(SelfTransition onExitSelfTransaction)	Adds an exit SelfTransition to this State
State	addTransition(Transition transition)	Adds an outgoing Transition to this State with weight 0.
State	addTransition(Transition transition, int weight)	Adds an outgoing Transition to this State with the specified weight.
boolean	equals(java.lang.Object o)
java.lang.String	getId()
java.util.List<SelfTransition>	getOnEntrySelfTransitions()
java.util.List<SelfTransition>	getOnExitSelfTransitions()
State	getParent()
java.util.List<Transition>	getTransitions()
int	hashCode()
java.lang.String	toString()
private void	updateTransitions()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

private final java.lang.String id

The state ID

parent

private final State parent

The parent state

transitionHolders

private java.util.List<State.TransitionHolder> transitionHolders

transitions

private java.util.List<Transition> transitions

The list of transitions for this state

onEntries

private java.util.List<SelfTransition> onEntries

The list of entry transitions on a state

onExits

private java.util.List<SelfTransition> onExits

The list of exit transition from a state

Constructor Detail

State

public State(java.lang.String id)

Creates a new State with the specified id.

Parameters:

id - the unique id of this State.

State

public State(java.lang.String id,
             State parent)

Creates a new State with the specified id and parent.

Parameters:

id - the unique id of this State.

parent - the parent State.

Method Detail

getId

public java.lang.String getId()

Returns:

the id of this State.

getParent

public State getParent()

Returns:

the parent or null if this State has no parent.

getTransitions

public java.util.List<Transition> getTransitions()

Returns:

an unmodifiable List of Transitions going out from this State.

getOnEntrySelfTransitions

public java.util.List<SelfTransition> getOnEntrySelfTransitions()

Returns:

an unmodifiable List of entry SelfTransitions

getOnExitSelfTransitions

public java.util.List<SelfTransition> getOnExitSelfTransitions()

Returns:

an unmodifiable List of exit SelfTransitions

addOnEntrySelfTransaction

State addOnEntrySelfTransaction(SelfTransition onEntrySelfTransaction)

Adds an entry SelfTransition to this State

Parameters:

selfTransition - the SelfTransition to add.

Returns:

this State.

addOnExitSelfTransaction

State addOnExitSelfTransaction(SelfTransition onExitSelfTransaction)

Adds an exit SelfTransition to this State

Parameters:

selfTransition - the SelfTransition to add.

Returns:

this State.

updateTransitions

private void updateTransitions()

addTransition

public State addTransition(Transition transition)

Adds an outgoing Transition to this State with weight 0.

Parameters:

transition - the Transition to add.

Returns:

this State.

See Also:

addTransition(Transition, int)

addTransition

public State addTransition(Transition transition,
                           int weight)

Adds an outgoing Transition to this State with the specified weight. The higher the weight the less important a Transition is. If two Transitions match the same Event the Transition with the lower weight will be executed.

Parameters:

transition - the Transition to add.

weight - The weight of this transition

Returns:

this State.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object