StateMachine

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

org.jboss.util.state
Class StateMachine

java.lang.Object
  org.jboss.util.state.StateMachine

The representation of a finite state machine.

Constructor Summary
`StateMachine(java.util.Set states, State (src) startState)` Create a state machine given its states and start state.
`StateMachine(java.util.Set states, State (src) startState, java.lang.String description)` Create a state machine given its states and start state.

Method Summary
`java.lang.Object`	`clone()` Make a copy of the StateMachine maintaining the current state.
`State (src)`	`getCurrentState()` Get the current state of the state machine.
`java.lang.String`	`getDescription()` Get the state machine description.
`State (src)`	`getStartState()` Get the start state of the state machine.
`java.util.Set`	`getStates()` Get the states of the state machine.
`State (src)`	`nextState(java.lang.String actionName)` Transition to the next state given the name of a valid transition.
`State (src)`	`reset()` Reset the state machine back to the start state
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Constructor Detail

public StateMachine(java.util.Set states,
                    State (src)  startState)

Create a state machine given its states and start state.
Parameters:: states - - Set for the state machine; startState - - the starting state

public StateMachine(java.util.Set states,
                    State (src)  startState,
                    java.lang.String description)

Create a state machine given its states and start state.
Parameters:: states - - Set for the state machine; startState - - the starting state; description - - an optional description of the state machine

Method Detail

public java.lang.Object clone()

Make a copy of the StateMachine maintaining the current state.

public java.lang.String getDescription()

Get the state machine description.

public State (src)  getCurrentState()

Get the current state of the state machine.

public State (src)  getStartState()

Get the start state of the state machine.

public java.util.Set getStates()

Get the states of the state machine.

public State (src)  nextState(java.lang.String actionName)
                throws IllegalTransitionException (src)

Transition to the next state given the name of a valid transition.

Parameters:: actionName - - the name of transition that is valid for the current state.
Returns:
Throws:: IllegalTransitionException (src)