net.sourceforge.anotherfsm

Class State

java.lang.Object

net.sourceforge.anotherfsm.State

public class State
extends java.lang.Object

The state in state machine.

Author:

Michal Turek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	State.Type The type of the states.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<StateListener>	listeners The listeners.
private java.lang.String	name The name of the state.
private State.Type	type The type of the state.

Constructor Summary

Constructors

Constructor and Description
State(java.lang.String name) Create the object.
State(java.lang.String name, State.Type type) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(StateListener listener) Add a new listener.
boolean	equals(java.lang.Object object) Compare the objects using internal fields.
java.lang.String	getName() Get name of the state.
State.Type	getType() Get type of the state.
int	hashCode() Get the hash code.
boolean	isFinalState() Chect the state is final.
(package private) void	notifyEnter(boolean loopTransition, State previous, Event event, State current) The state was entered, notify listeners.
(package private) void	notifyExit(boolean loopTransition, State current, Event event, State next) The state was exited, notify listeners.
java.lang.String	toString() The string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

The name of the state.

type

private final State.Type type

The type of the state.

listeners

private final java.util.List<StateListener> listeners

The listeners.

Constructor Detail

State

public State(java.lang.String name)

Create the object.

Parameters:

name - the name of the state

State

public State(java.lang.String name,
     State.Type type)

Create the object.

Parameters:

name - the name of the state

type - the type of the state

Method Detail

addListener

public void addListener(StateListener listener)

Add a new listener. The method is not thread safe.

Parameters:

listener - the listener

notifyEnter

void notifyEnter(boolean loopTransition,
               State previous,
               Event event,
               State current)

The state was entered, notify listeners. Internal use only.

Parameters:

loopTransition - this transition is a loop transition

previous - the previous state

event - the event

current - the current state

notifyExit

void notifyExit(boolean loopTransition,
              State current,
              Event event,
              State next)

The state was exited, notify listeners. Internal use only.

Parameters:

loopTransition - this transition is a loop transition

current - the current state

event - the event

next - the next state

getName

public java.lang.String getName()

Get name of the state.

Returns:

the name

getType

public State.Type getType()

Get type of the state.

Returns:

the type

isFinalState

public boolean isFinalState()

Chect the state is final.

Returns:

the flag

hashCode

public int hashCode()

Get the hash code. Only name of the state is used for creating hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object object)

Compare the objects using internal fields. FSM uses this method while building the state machine to ensure all states are unique. Only the name of the states is used during the comparison.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object

Returns:

true if the objects are same, otherwise false

See Also:

Processor.process(Event)

toString

public java.lang.String toString()

The string representation of the object. It is expected the name of the state is returned.

Overrides:

toString in class java.lang.Object

Returns:

the string representation