org.jboss.util.state

Class State

java.lang.Object

org.jboss.util.state.State

public class State
extends java.lang.Object

The respresentation of a state in a state machine.

Version:

$Revision$

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap	allowedTransitions HashMap
private java.lang.Object	data Arbitrary state data
private java.lang.String	name The name of the state

Constructor Summary

Constructors

Constructor and Description
State(java.lang.String name)
State(java.lang.String name, java.util.Map transitions)

Method Summary

Modifier and Type	Method and Description
State	addTransition(Transition transition) Add a transition to the allowed transition map.
java.lang.Object	getData()
java.lang.String	getName() Get the state name.
Transition	getTransition(java.lang.String name) Lookup an allowed transition given its name.
java.util.Map	getTransitions() Get the Map of allowed transitions for this state.
boolean	isAcceptState() An accept state is indicated by no transitions
void	setData(java.lang.Object data)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

The name of the state

allowedTransitions

private java.util.HashMap allowedTransitions

HashMap

data

private java.lang.Object data

Arbitrary state data

Constructor Detail

State

public State(java.lang.String name)

State

public State(java.lang.String name,
             java.util.Map transitions)

Method Detail

getName

public java.lang.String getName()

Get the state name.

Returns:

the name of the state.

getData

public java.lang.Object getData()

setData

public void setData(java.lang.Object data)

isAcceptState

public boolean isAcceptState()

An accept state is indicated by no transitions

Returns:

true if this is an accept state, false otherwise.

addTransition

public State addTransition(Transition transition)

Add a transition to the allowed transition map.

Parameters:

transition -

Returns:

this to allow chained addTransition calls

getTransition

public Transition getTransition(java.lang.String name)

Lookup an allowed transition given its name.

Parameters:

name - - the name of a valid transition from this state.

Returns:

the valid transition if it exists, null otherwise.

getTransitions

public java.util.Map getTransitions()

Get the Map of allowed transitions for this state.

Returns:

the allowed transitions map.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object