org.eclipse.net4j.util.fsm
Class FiniteStateMachine<STATE extends Enum<?>,EVENT extends Enum<?>,SUBJECT>

java.lang.Object
  org.eclipse.net4j.util.event.Notifier
      org.eclipse.net4j.util.lifecycle.Lifecycle
          org.eclipse.net4j.util.fsm.FiniteStateMachine<STATE,EVENT,SUBJECT>

All Implemented Interfaces:

INotifier, ILifecycle, ILifecycle.DeferrableActivation

Direct Known Subclasses:

Negotiator

public abstract class FiniteStateMachine<STATE extends Enum<?>,EVENT extends Enum<?>,SUBJECT>

extends Lifecycle

A finite state machine that is based on a matrix of transitions.

A finite state machine can fire the following events:

• FiniteStateMachine.StateChangedEvent after state changes of a subject.

IGNORE

public static final ITransition IGNORE

FAIL

public static final ITransition FAIL

FiniteStateMachine

public FiniteStateMachine(Class<STATE> stateEnum,
                          Class<EVENT> eventEnum,
                          ITransition<STATE,EVENT,SUBJECT,?> defaultTransition)

FiniteStateMachine

public FiniteStateMachine(Class<STATE> stateEnum,
                          Class<EVENT> eventEnum)

getStates

public final STATE[] getStates()

getEvents

public final EVENT[] getEvents()

getTransition

public final ITransition<STATE,EVENT,SUBJECT,?> getTransition(STATE state,
                                                              EVENT event)

init

public final void init(STATE state,
                       EVENT event,
                       STATE targetState)

init

public final void init(STATE state,
                       EVENT event,
                       ITransition<STATE,EVENT,SUBJECT,?> transition)

initEvents

public final void initEvents(STATE state,
                             STATE targetState)

initEvents

public final void initEvents(STATE state,
                             ITransition<STATE,EVENT,SUBJECT,?> transition)

initStates

public final void initStates(EVENT event,
                             STATE targetState)

initStates

public final void initStates(EVENT event,
                             ITransition<STATE,EVENT,SUBJECT,?> transition)

initAll

public final void initAll(STATE targetState)

initAll

public final void initAll(ITransition<STATE,EVENT,SUBJECT,?> transition)

process

public final <DATA> void process(SUBJECT subject,
                                 EVENT event,
                                 DATA data)

createIgnoreTransition

protected ITransition<STATE,EVENT,SUBJECT,?> createIgnoreTransition(STATE state,
                                                                    EVENT event)

createFailTransition

protected ITransition<STATE,EVENT,SUBJECT,?> createFailTransition(STATE state,
                                                                  EVENT event)

formatProcessMessage

protected String formatProcessMessage(SUBJECT subject,
                                      STATE state,
                                      EVENT event,
                                      Object data)

formatIgnoreMessage

protected String formatIgnoreMessage(SUBJECT subject,
                                     STATE state,
                                     EVENT event,
                                     Object data)

formatFailMessage

protected String formatFailMessage(SUBJECT subject,
                                   STATE state,
                                   EVENT event,
                                   Object data)

getState

protected abstract STATE getState(SUBJECT subject)

setState

protected abstract void setState(SUBJECT subject,
                                 STATE state)

changeState

protected STATE changeState(SUBJECT subject,
                            STATE state)

Since:

3.0