net.sourceforge.anotherfsm

Class Transition

java.lang.Object

net.sourceforge.anotherfsm.Transition

public class Transition
extends java.lang.Object

The transition in state machine.

Author:

Michal Turek

Constructor Summary

Constructors

Constructor and Description
Transition(State state, Event event) Create the object.
Transition(State source, Event event, State destination) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(TransitionListener listener) Add a new listener.
boolean	equals(java.lang.Object object) Compare the objects using internal fields.
State	getDestination() Get the transition destination state.
Event	getEvent() Get the transition event.
State	getSource() Get the source state.
int	hashCode() Get the hash code.
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

Constructor Detail

Transition

public Transition(State source,
          Event event,
          State destination)

Create the object.

Parameters:

source - the source state

event - the event

destination - the destination state

Transition

public Transition(State state,
          Event event)

Create the object. The loop transition, the source and destination states are the same.

 +---+
 | S |------+
 +---+      |
   ^        | A loop transition, 'S' is both source and destination state.
   |        |
   +--------+
 

Parameters:

state - the source and destination state

event - the event

Method Detail

getSource

public State getSource()

Get the source state.

Returns:

the transition source state

getEvent

public Event getEvent()

Get the transition event.

Returns:

the transition event

getDestination

public State getDestination()

Get the transition destination state.

Returns:

the transition destination state

addListener

public void addListener(TransitionListener listener)

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

Parameters:

listener - the listener

hashCode

public int hashCode()

Get the 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 transitions are unique.

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 internal fields are returned.

Overrides:

toString in class java.lang.Object

Returns:

the string representation