buzz.getcoco.iot

Class FiniteStateMachine<S extends FiniteStateMachine.State,E extends FiniteStateMachine.Event,A>

java.lang.Object

buzz.getcoco.iot.FiniteStateMachine<S,E,A>

Type Parameters:

S - type can be of any class which is an immediate subclass of FiniteStateMachine.State

E - type can be of any class which is an immediate subclass of FiniteStateMachine.Event

A - type of args for action callbacks

public class FiniteStateMachine<S extends FiniteStateMachine.State,E extends FiniteStateMachine.Event,A>
extends java.lang.Object

Finite State Machine manages states that an object can be based on the events in FiniteStateMachine.EventTable that trigger these state changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FiniteStateMachine.ActionCallback<A> A callback defining an action for an event.
static interface	FiniteStateMachine.EntryActionCallback<E,A> A callback defining an action upon entry to state.
static interface	FiniteStateMachine.Event A marker interface that defines a class that implements it to be an event that can cause a state change.
static class	FiniteStateMachine.EventTable<S extends FiniteStateMachine.State,E extends FiniteStateMachine.Event,A> An Event table encapsulates complete information about event such as previous state, next state and action callback etc.
static interface	FiniteStateMachine.ExitActionCallback<A> A callback defining an action upon exit from a state.
static interface	FiniteStateMachine.FetchTimeout An interface defining timeout for an event.
static interface	FiniteStateMachine.State A marker interface that defines a class that implements it to be a state of an object.
static class	FiniteStateMachine.StateTable<S extends FiniteStateMachine.State,E extends FiniteStateMachine.Event,A> State table encapsulates complete information about the state such as timeout, entry and exit callback actions etc.
static interface	FiniteStateMachine.TimerCallback<A> A callback defining an action upon timeout reached.

Constructor Summary

Constructors

Constructor and Description
FiniteStateMachine(S initialState, FiniteStateMachine.TimerCallback<A> timerCallback, java.util.List<FiniteStateMachine.EventTable<S,E,A>> eventTables, java.util.List<FiniteStateMachine.StateTable<S,E,A>> stateTables) Constructor for current class.

Method Summary

Modifier and Type	Method and Description
S	getCurrentState()
void	handleEvent(E event, A args) This function handles an event using information encapsulated in event table to change states of a finite state machine as defined.
void	unsafeSetState(S state) To forcefully set the state of this machine.

Methods inherited from class java.lang.Object

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

Constructor Detail

FiniteStateMachine

public FiniteStateMachine(S initialState,
                          FiniteStateMachine.TimerCallback<A> timerCallback,
                          java.util.List<FiniteStateMachine.EventTable<S,E,A>> eventTables,
                          java.util.List<FiniteStateMachine.StateTable<S,E,A>> stateTables)

Constructor for current class.

Parameters:

initialState - primary state from which event triggers initially

timerCallback - essential in triggering timer and set timeout conditions for the finite state machine

eventTables - List of all FiniteStateMachine.EventTable possible for the machine

stateTables - List of all FiniteStateMachine.StateTable possible for the machine

Method Detail

handleEvent

public void handleEvent(E event,
                        A args)

This function handles an event using information encapsulated in event table to change states of a finite state machine as defined.

Parameters:

event - Event under interest to be handled

args - args to trigger action callback for event

unsafeSetState

public void unsafeSetState(S state)

To forcefully set the state of this machine.

Parameters:

state - desired state

getCurrentState

public S getCurrentState()