org.statefulj.fsm.model

Interface State<T>

Type Parameters:

T - The class of the Stateful Entity

All Known Implementing Classes:

StateImpl

public interface State<T>

Represents a State with the FSM. Holds a map of events and Transitions.

Author:

Andrew Hall

Method Summary

Modifier and Type	Method and Description
void	addTransition(String event, State<T> next) Add a deterministic Transition with no Action
void	addTransition(String event, State<T> next, Action<T> action) Add a deterministic Transition with an Action
void	addTransition(String event, Transition<T> transition) Add a Transition
String	getName() Name of the State.
Transition<T>	getTransition(String event) Returns the Transition for an Event
boolean	isBlocking() Whether this is a Blocking State.
boolean	isEndState() Whether this State is an End State
void	removeTransition(String event) Remove a Transition from the State
void	setBlocking(boolean isBlocking) Set whether or not this is a Blocking State

Method Detail

getName

String getName()

Name of the State. This value is persisted as the State value in the Stateful Entity.

Returns:

Name of the State

getTransition

Transition<T> getTransition(String event)

Returns the Transition for an Event

Parameters:

event - The event

Returns:

The Transition for this event

isEndState

boolean isEndState()

Whether this State is an End State

Returns:

if true, then this is an End State

isBlocking

boolean isBlocking()

Whether this is a Blocking State. If Blocking, event will not process unless there is an explicit Transition for the event. If blocked, the FSM will retry the event until the FSM transitions out of the blocked State

Returns:

if true, then State is a "blocking" state

setBlocking

void setBlocking(boolean isBlocking)

Set whether or not this is a Blocking State

Parameters:

isBlocking - if true, then this is a blocking State

removeTransition

void removeTransition(String event)

Remove a Transition from the State

Parameters:

event - Remove the transition for this Event

addTransition

void addTransition(String event,
                   Transition<T> transition)

Add a Transition

Parameters:

event - The event to add the Transition

transition - The Transition

addTransition

void addTransition(String event,
                   State<T> next,
                   Action<T> action)

Add a deterministic Transition with an Action

Parameters:

event - The event to add the Transition

next - The next State

action - The resulting Action

addTransition

void addTransition(String event,
                   State<T> next)

Add a deterministic Transition with no Action

Parameters:

event - The event to add the Transition

next - The next State