org.statefulj.fsm

Class FSM<T>

java.lang.Object

org.statefulj.fsm.FSM<T>

Direct Known Subclasses:

FSM

public class FSM<T>
extends Object

The FSM is responsible for the processing the event with the current State and persisting the State with the composite Persister

Author:

Andrew Hall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSM.FSMBuilder<T> Fluid FSM builder

Constructor Summary

Constructors

Constructor and Description
FSM(Persister<T> persister) FSM Constructor with the Persister responsible for setting the State on the Entity
FSM(String name) FSM Constructor with the name of the FSM
FSM(String name, Persister<T> persister) FSM Constructor with the name of the FSM and Persister responsible for setting the State on the Entity
FSM(String name, Persister<T> persister, int retryAttempts, int retryInterval) FSM Constructor

Method Summary

Modifier and Type	Method and Description
protected void	executeAction(Action<T> action, T stateful, String event, String from, String to, Object... args)
State<T>	getCurrentState(T obj)
String	getName()
Persister<T>	getPersister()
int	getRetryAttempts()
int	getRetryInterval()
protected Transition<T>	getTransition(String event, State<T> current)
State<T>	onEvent(T stateful, String event, Object... args) Process event.
protected void	setCurrent(T stateful, State<T> current, State<T> next)
void	setName(String name)
void	setPersister(Persister<T> persister)
void	setRetryAttempts(int retries)
void	setRetryInterval(int retryInterval)
protected State<T>	transition(T stateful, State<T> current, String event, Transition<T> transition, Object... args)

Methods inherited from class java.lang.Object

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

Constructor Detail

FSM

public FSM(String name)

FSM Constructor with the name of the FSM

Parameters:

name - Name associated with the FSM

FSM

public FSM(Persister<T> persister)

FSM Constructor with the Persister responsible for setting the State on the Entity

Parameters:

persister - Persister responsible for setting the State on the Entity

FSM

public FSM(String name,
           Persister<T> persister)

FSM Constructor with the name of the FSM and Persister responsible for setting the State on the Entity

Parameters:

name - Name associated with the FSM

persister - Persister responsible for setting the State on the Entity

FSM

public FSM(String name,
           Persister<T> persister,
           int retryAttempts,
           int retryInterval)

FSM Constructor

Parameters:

name - Name associated with the FSM

persister - Persister responsible for setting the State on the Entity

retryAttempts - Number of Retry Attempts. A value of -1 indicates unlimited Attempts

retryInterval - Time between Retry Attempts in milliseconds

Method Detail

onEvent

public State<T> onEvent(T stateful,
                        String event,
                        Object... args)
                 throws TooBusyException

Process event. Will handle all retry attempts. If attempts exceed maximum retries, it will throw a TooBusyException.

Parameters:

stateful - The Stateful Entity

event - The Event

args - Optional parameters to pass into the Action

Returns:

The current State

Throws:

TooBusyException - Exception indicating that we've exceeded the number of RetryAttempts

getRetryAttempts

public int getRetryAttempts()

setRetryAttempts

public void setRetryAttempts(int retries)

getRetryInterval

public int getRetryInterval()

setRetryInterval

public void setRetryInterval(int retryInterval)

getPersister

public Persister<T> getPersister()

setPersister

public void setPersister(Persister<T> persister)

getName

public String getName()

setName

public void setName(String name)

getCurrentState

public State<T> getCurrentState(T obj)

getTransition

protected Transition<T> getTransition(String event,
                                      State<T> current)

transition

protected State<T> transition(T stateful,
                              State<T> current,
                              String event,
                              Transition<T> transition,
                              Object... args)
                       throws RetryException

Throws:

RetryException

setCurrent

protected void setCurrent(T stateful,
                          State<T> current,
                          State<T> next)
                   throws StaleStateException

Throws:

StaleStateException

executeAction

protected void executeAction(Action<T> action,
                             T stateful,
                             String event,
                             String from,
                             String to,
                             Object... args)
                      throws RetryException

Throws:

RetryException