A B D E F G H N O R S T U

A

AbstractEvent - Class in org.jeasy.states.api

Abstract class for events to which a FSM should react and make transitions.

AbstractEvent() - Constructor for class org.jeasy.states.api.AbstractEvent

AbstractEvent(String) - Constructor for class org.jeasy.states.api.AbstractEvent

B

build() - Method in class org.jeasy.states.core.FiniteStateMachineBuilder

Build a FSM instance.

build() - Method in class org.jeasy.states.core.TransitionBuilder

Build a transition instance.

D

DEFAULT_EVENT_NAME - Static variable in class org.jeasy.states.util.Utils

Default event name.

DEFAULT_TRANSITION_NAME - Static variable in class org.jeasy.states.util.Utils

Default transition name.

dumpFSMStates(Set<State>) - Static method in class org.jeasy.states.util.Utils

Utility method to print states names as string.

E

equals(Object) - Method in class org.jeasy.states.api.State

Event - Interface in org.jeasy.states.api

Interface for FSM events.

EventHandler<E extends Event> - Interface in org.jeasy.states.api

Abstraction for actions to perform when an event is triggered.

eventHandler(EventHandler<E>) - Method in class org.jeasy.states.core.TransitionBuilder

Set the event handler of the transition.

eventType(Class<? extends Event>) - Method in class org.jeasy.states.core.TransitionBuilder

Set event type upon which the transition should be triggered.

F

FiniteStateMachine - Interface in org.jeasy.states.api

FSM interface.

FiniteStateMachineBuilder - Class in org.jeasy.states.core

FSM builder : this class is the main entry point to build FSM instances.

FiniteStateMachineBuilder(Set<State>, State) - Constructor for class org.jeasy.states.core.FiniteStateMachineBuilder

Create a new FiniteStateMachineBuilder.

FiniteStateMachineException - Exception in org.jeasy.states.api

Exception thrown if a problem occurs during event handling.

FiniteStateMachineException(Transition, Event, Throwable) - Constructor for exception org.jeasy.states.api.FiniteStateMachineException

Create a new FiniteStateMachineException.

fire(Event) - Method in interface org.jeasy.states.api.FiniteStateMachine

Fire an event.

G

getCause() - Method in exception org.jeasy.states.api.FiniteStateMachineException

Get the root cause of the exception.

getCurrentState() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return current FSM state.

getEvent() - Method in exception org.jeasy.states.api.FiniteStateMachineException

Get the event triggered when the exception occurred.

getEventHandler() - Method in interface org.jeasy.states.api.Transition

Return event handler to execute when an event is fired.

getEventType() - Method in interface org.jeasy.states.api.Transition

Return fired event type upon which the transition should be made.

getFinalStates() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return FSM final states.

getInitialState() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return FSM initial state.

getLastEvent() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return the last triggered event.

getLastTransition() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return the last transition made.

getName() - Method in class org.jeasy.states.api.AbstractEvent

getName() - Method in interface org.jeasy.states.api.Event

Name of the event.

getName() - Method in class org.jeasy.states.api.State

Get state name.

getName() - Method in interface org.jeasy.states.api.Transition

Return transition name.

getSourceState() - Method in interface org.jeasy.states.api.Transition

Return transition source state.

getStates() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return FSM registered states.

getTargetState() - Method in interface org.jeasy.states.api.Transition

Return transition target state.

getTimestamp() - Method in class org.jeasy.states.api.AbstractEvent

getTimestamp() - Method in interface org.jeasy.states.api.Event

Timestamp of the event.

getTransition() - Method in exception org.jeasy.states.api.FiniteStateMachineException

Get the transition where the exception occurred.

getTransitions() - Method in interface org.jeasy.states.api.FiniteStateMachine

Return FSM registered transitions.

H

handleEvent(E) - Method in interface org.jeasy.states.api.EventHandler

Action method to execute when an event occurs.

hashCode() - Method in class org.jeasy.states.api.State

N

name - Variable in class org.jeasy.states.api.AbstractEvent

name(String) - Method in class org.jeasy.states.core.TransitionBuilder

Set the name of the transition.

O

org.jeasy.states.api - package org.jeasy.states.api

This package contains the public APIs.

org.jeasy.states.core - package org.jeasy.states.core

This package contains the core implementation of finite state machine.

org.jeasy.states.util - package org.jeasy.states.util

This package contains utility classes.

R

registerFinalState(State) - Method in class org.jeasy.states.core.FiniteStateMachineBuilder

Register FSM final state which is not mandatory.

registerFinalStates(Set<State>) - Method in class org.jeasy.states.core.FiniteStateMachineBuilder

Register FSM final states set.

registerTransition(Transition) - Method in class org.jeasy.states.core.FiniteStateMachineBuilder

Register a transition within FSM transitions set.

registerTransitions(Set<Transition>) - Method in class org.jeasy.states.core.FiniteStateMachineBuilder

Register a set of transitions within FSM transitions set.

S

sourceState(State) - Method in class org.jeasy.states.core.TransitionBuilder

Set the source state of the transition.

State - Class in org.jeasy.states.api

A class representing a FSM state.

State(String) - Constructor for class org.jeasy.states.api.State

Create a new State.

T

targetState(State) - Method in class org.jeasy.states.core.TransitionBuilder

Set the target state of the transition.

timestamp - Variable in class org.jeasy.states.api.AbstractEvent

toString() - Method in class org.jeasy.states.api.AbstractEvent

Transition - Interface in org.jeasy.states.api

Abstraction for a FSM transition.

TransitionBuilder - Class in org.jeasy.states.core

FSM transition builder : this class should be used to build FSM transition instances: Source and target states must be declared in FSM states set. Source and target states must be defined (not null) Event Type must be defined (not null) Event Handler is not mandatory

TransitionBuilder() - Constructor for class org.jeasy.states.core.TransitionBuilder

Create a new TransitionBuilder.

U

Utils - Class in org.jeasy.states.util

Constants and utilities class.

A B D E F G H N O R S T U