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

Field Summary

Fields

Modifier and Type	Field and Description
private State	destination The destination state.
private Event	event The event.
private java.util.List<TransitionListener>	listeners The listeners.
private State	source The source state.
private static java.lang.String	TR The delimiter for string representation.

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.
(package private) static java.lang.String	format(Event matchedEvent, Event eventToProcess) Helper method to format transition parameters to the string representation.
(package private) static java.lang.String	format(State source, Event event) Helper method to format transition parameters to the string representation.
(package private) static java.lang.String	format(State source, Event matchedEvent, Event eventToProcess) Helper method to format transition parameters to the string representation.
(package private) static java.lang.String	format(State source, Event matchedEvent, Event eventToProcess, State destination) Helper method to format transition parameters to the string representation.
(package private) static java.lang.String	format(State source, Event event, State destination) Helper method to format transition parameters to the string representation.
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.
(package private) void	notifyTransition(State source, Event event, State destination) The transition was processed, 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

TR

private static final java.lang.String TR

The delimiter for string representation.

See Also:

Constant Field Values

source

private final State source

The source state.

event

private final Event event

The event.

destination

private final State destination

The destination state.

listeners

private final java.util.List<TransitionListener> listeners

The listeners.

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

notifyTransition

void notifyTransition(State source,
                    Event event,
                    State destination)

The transition was processed, notify listeners. Internal use only.

Parameters:

source - the source state

event - the event

destination - the destination state

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

format

static java.lang.String format(State source,
                      Event event,
                      State destination)

Helper method to format transition parameters to the string representation.

Parameters:

source - the source state

event - the input event

destination - the destination state

Returns:

the string representation

format

static java.lang.String format(State source,
                      Event matchedEvent,
                      Event eventToProcess,
                      State destination)

Helper method to format transition parameters to the string representation.

Parameters:

source - the source state

matchedEvent - the input event that matched

eventToProcess - the event that will be processed

destination - the destination state

Returns:

the string representation

format

static java.lang.String format(State source,
                      Event event)

Helper method to format transition parameters to the string representation.

Parameters:

source - the source state

event - the input event

Returns:

the string representation

format

static java.lang.String format(State source,
                      Event matchedEvent,
                      Event eventToProcess)

Helper method to format transition parameters to the string representation.

Parameters:

source - the source state

matchedEvent - the input event that matched

eventToProcess - the event that will be processed

Returns:

the string representation

format

static java.lang.String format(Event matchedEvent,
                      Event eventToProcess)

Helper method to format transition parameters to the string representation.

Parameters:

matchedEvent - the input event that matched

eventToProcess - the event that will be processed

Returns:

the string representation