Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- action() - Method in interface net.tangly.fsm.Transition
-
Return the optional action executed upon firing of the transition.
- actionDescription() - Method in interface net.tangly.fsm.Transition
-
Return the human-readable description of the action for the transition.
- Actor<T> - Interface in net.tangly.fsm.actors
-
The actor abstraction provides an active actor object to process received messages.
- ActorFsm<O,
S, - Class in net.tangly.fsm.actorsE> -
A local actor implements the actor contract as a local thread running in the virtual machine.
- ActorFsm(FsmBuilder<O, S, E>, String, ExecutorService) - Constructor for class net.tangly.fsm.actors.ActorFsm
-
Constructor of the class.
- ActorImp<T> - Class in net.tangly.fsm.actors
- ActorImp(String, ExecutorService) - Constructor for class net.tangly.fsm.actors.ActorImp
- actorNamed(String) - Method in class net.tangly.fsm.actors.Actors
-
Return an actor with the given name.
- Actors<T> - Class in net.tangly.fsm.actors
-
The actor infrastructure enabler provides asynchronous execution for actors he is in charge.
- Actors() - Constructor for class net.tangly.fsm.actors.Actors
-
Defaul constructor uses a virtual thread to execute tasks.
- Actors(ExecutorService) - Constructor for class net.tangly.fsm.actors.Actors
-
Constructor with a customer executor.
- ActorTimerMgr<T> - Class in net.tangly.fsm.actors
- ActorTimerMgr(String, ExecutorService, Function<T, ActorTimerMgr.TimerCmd<T>>, Function<ActorTimerMgr.Timer<T>, T>) - Constructor for class net.tangly.fsm.actors.ActorTimerMgr
- ActorTimerMgr.Timer<T> - Record Class in net.tangly.fsm.actors
- ActorTimerMgr.TimerCmd<T> - Record Class in net.tangly.fsm.actors
- add(S) - Method in interface net.tangly.fsm.dsl.StateBuilder
-
Once a state is selected, you can addToRoot a new substate.
- add(S, String) - Method in interface net.tangly.fsm.dsl.StateBuilder
-
Once a state is selected, you can addToRoot a new substate.
- add(S, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- addEventHandler(StateMachineEventHandler<O, S, E>) - Method in interface net.tangly.fsm.StateMachine
-
Add an event handler.
- addToRoot(S) - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Add a new state to the root state.
- addToRoot(S, String) - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Add a new state to the root state.
- alarmTimeInNanoSeconds() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns the value of the
alarmTimeInNanoSeconds
record component. - ARROW - Static variable in class net.tangly.fsm.utilities.GeneratorPlantUml
- awaitTermination(long, TimeUnit) - Method in class net.tangly.fsm.actors.Actors
B
- build() - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Build the transition and add it to the context.
- build() - Method in class net.tangly.fsm.imp.DefinitionBuilder
- builder - Variable in class net.tangly.fsm.utilities.Generator
C
- cancelTimer(Actor<T>, String, Function<ActorTimerMgr.TimerCmd<T>, T>) - Method in class net.tangly.fsm.actors.ActorTimerMgr
- Channel<T> - Class in net.tangly.fsm.actors
-
Provide a subscription handler for multiple suppliers and consumers.
- Channel(String) - Constructor for class net.tangly.fsm.actors.Channel
- channelNamed(String) - Method in class net.tangly.fsm.actors.Actors
-
Return the channel with the given name.
- check(State<O, S, E>) - Method in class net.tangly.fsm.utilities.StaticChecker
-
Checks all static rules on the given final state machine description.
- Checker - Interface in net.tangly.fsm.utilities
-
The checker interface defines the contract for all finite state machine syntactic and semantic checkers.
- Checker.Level - Enum Class in net.tangly.fsm.utilities
- checkStateHasAtMostOneInitialState(State<O, S, E>) - Method in class net.tangly.fsm.utilities.StaticChecker
-
Checks each composite state has at most one substate with the initial flag.
- checkStateIdUsedOnce(State<O, S, E>) - Method in class net.tangly.fsm.utilities.StaticChecker
-
Checks each enumeration value is used exactly once to identify the state of the machine.
- checkStateWithAfferentTransitionHasInitialState(State<O, S, E>) - Method in class net.tangly.fsm.utilities.StaticChecker
-
Checks each composite state with an afferent transition has an initial state.
- client() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns the value of the
client
record component. - close() - Method in class net.tangly.fsm.actors.Channel
- command() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Returns the value of the
command
record component. - compareTo(State<O, S, E>) - Method in interface net.tangly.fsm.State
- compareTo(ActorTimerMgr.Timer<T>) - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
- context() - Method in interface net.tangly.fsm.StateMachine
-
Return the context of the finite state machine instance.
- Create a FSM description with Builder - Search tag in package net.tangly.fsm.dsl
- Section
- createAndRegister(String) - Method in class net.tangly.fsm.actors.Actors
-
Register the channel and activate it.
- createError(ResourceBundle, String, Object...) - Method in interface net.tangly.fsm.utilities.Checker
-
Creates an error message for the checker.
- createMessage(Checker.Level, ResourceBundle, String, Object...) - Method in interface net.tangly.fsm.utilities.Checker
-
Creates a message for the checker.
- createTimer(ActorTimerMgr.Timer<T>, Function<ActorTimerMgr.TimerCmd<T>, T>) - Method in class net.tangly.fsm.actors.ActorTimerMgr
D
- DEBUG - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- Decisions - Search tag in package net.tangly.fsm
- Section
- definition() - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Return the root state of the finite state machine definition and terminate the building process.
- definition() - Method in class net.tangly.fsm.imp.DefinitionBuilder
- DefinitionBuilder<O,
S, - Class in net.tangly.fsm.impE> -
The class implements the interfaces to build a complete finite state machine definition using a fluent DSL - Domain Specific Language -.
- DefinitionBuilder(S) - Constructor for class net.tangly.fsm.imp.DefinitionBuilder
-
Constructor of the class.
- Definitions - Search tag in package net.tangly.fsm
- Section
- delayInNanoSeconds() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns the value of the
delayInNanoSeconds
record component. - description() - Method in interface net.tangly.fsm.State
-
Return the human-readable description of the state.
- description() - Method in interface net.tangly.fsm.Transition
-
Return the human-readable description of the transition.
- DynamicChecker<O,
S, - Record Class in net.tangly.fsm.utilitiesE> -
The finite state machine dynamic checker verifies the correctness of a state machine description.
- DynamicChecker(StateMachine<O, S, E>) - Constructor for record class net.tangly.fsm.utilities.DynamicChecker
-
Creates an instance of a
DynamicChecker
record class.
E
- enterState(State<O, S, E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the state is entered.
- enterState(State<O, S, E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- entryAction() - Method in interface net.tangly.fsm.State
-
Return the entry action of the state.
- entryActionDescription() - Method in interface net.tangly.fsm.State
-
Return the human-readable description for the entry action of the state.
- equals(Object) - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.tangly.fsm.Event
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.tangly.fsm.utilities.DynamicChecker
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- evaluate(O, Event<E>) - Method in interface net.tangly.fsm.Transition
-
Evaluate the event and guard of the transition.
- Event<E> - Record Class in net.tangly.fsm
-
The event is an immutable class containing the event with payload sent to the finite state machine.
- Event(E, List<Object>) - Constructor for record class net.tangly.fsm.Event
-
Creates an instance of a
Event
record class. - eventId() - Method in interface net.tangly.fsm.Transition
-
Return the identifier of the event triggering the firing of the transition.
- execute(BiConsumer<O, Event<E>>, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- execute(BiConsumer<O, Event<E>>) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- execute(BiConsumer<O, Event<E>>, String) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- execute(Consumer<O>) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- execute(Consumer<O>, String) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- execute(O, Event<E>) - Method in interface net.tangly.fsm.Transition
-
Execute the action associated with the transition if defined.
- executeEntryAction(State<O, S, E>, Event<E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the entry action of the state is processed.
- executeEntryAction(State<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- executeEntryAction(O, Event<E>) - Method in interface net.tangly.fsm.State
-
Execute the entry action associated with the state if defined.
- executeExitAction(State<O, S, E>, Event<E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the exit action of the state is processed.
- executeExitAction(State<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- executeExitAction(O, Event<E>) - Method in interface net.tangly.fsm.State
-
Execute the exit action associated with the state if defined.
- executor() - Method in class net.tangly.fsm.actors.Actors
- exitAction() - Method in interface net.tangly.fsm.State
-
Return the exit action of the state.
- exitActionDescription() - Method in interface net.tangly.fsm.State
-
Return the human-readable description for the exit action of the state.
- exitState(State<O, S, E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the state is left.
- exitState(State<O, S, E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- extension() - Method in class net.tangly.fsm.utilities.Generator
-
Return the extension used by the generator when writing its output.
- extension() - Method in class net.tangly.fsm.utilities.GeneratorAsciiDoc
- extension() - Method in class net.tangly.fsm.utilities.GeneratorGraphDot
- extension() - Method in class net.tangly.fsm.utilities.GeneratorMermaid
- extension() - Method in class net.tangly.fsm.utilities.GeneratorPlantUml
- extension() - Method in class net.tangly.fsm.utilities.GeneratorStateMachineCat
- EXTENSION - Static variable in class net.tangly.fsm.utilities.GeneratorPlantUml
F
- FATAL - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- Features - Search tag in package net.tangly.fsm.dsl
- Section
- findBy(S) - Method in interface net.tangly.fsm.State
-
Return the state with the given identifier.
- findOwner(State<O, S, E>) - Method in class net.tangly.fsm.utilities.Generator
- fire(Event<E>) - Method in interface net.tangly.fsm.StateMachine
-
Fire the specified event and processes all associated actions.
- fireLocalTransition(Transition<O, S, E>, Event<E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the action of the transition is processed.
- fireLocalTransition(Transition<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.DynamicChecker
- fireLocalTransition(Transition<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- fireTransition(Transition<O, S, E>, Event<E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the transition is fired.
- fireTransition(Transition<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.DynamicChecker
- fireTransition(Transition<O, S, E>, Event<E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- fsm() - Method in record class net.tangly.fsm.utilities.DynamicChecker
-
Returns the value of the
fsm
record component. - FsmBuilder<O,
S, - Interface in net.tangly.fsm.dslE> -
Domain-specific language fluent interface to build a state machine declaration starting with a state.
G
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.Generator
-
Implement the creation of the text content for a specific generator.
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.GeneratorAsciiDoc
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.GeneratorGraphDot
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.GeneratorMermaid
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.GeneratorPlantUml
- generate(PrintWriter) - Method in class net.tangly.fsm.utilities.GeneratorStateMachineCat
- generateFileIfChanged(Path) - Method in class net.tangly.fsm.utilities.Generator
-
Generate the content of the file identified through the path if the file does not exist or the new creation of the output is different to the one in the file.
- Generator<O,
S, - Class in net.tangly.fsm.utilitiesE> -
Abstract generator to create a human-readable description of a finite state machine description.
- Generator(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.Generator
-
Constructor of the class.
- GeneratorAsciiDoc<O,
S, - Class in net.tangly.fsm.utilitiesE> -
Generates an AsciiDoc description of the finite state machine declaration.
- GeneratorAsciiDoc(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.GeneratorAsciiDoc
-
Constructor of the class.
- GeneratorGraphDot<O,
S, - Class in net.tangly.fsm.utilitiesE> -
The generator creates graphical graph representations of a finite state machine in the graphical language of Graphviz dot language.
- GeneratorGraphDot(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.GeneratorGraphDot
-
Constructor of the class.
- GeneratorMermaid<O,
S, - Class in net.tangly.fsm.utilitiesE> - GeneratorMermaid(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.GeneratorMermaid
-
Constructor of the class.
- GeneratorPlantUml<O,
S, - Class in net.tangly.fsm.utilitiesE> -
The generator creates graphical graph representations of a finite state machine in the graphical language of Graphviz dot language.
- GeneratorPlantUml(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.GeneratorPlantUml
-
Constructor of the class.
- GeneratorStateMachineCat<O,
S, - Class in net.tangly.fsm.utilitiesE> -
THe state machine cat is a nice FSM diagram generator with a few peculiarities.
- GeneratorStateMachineCat(FsmBuilder<O, S, E>, String) - Constructor for class net.tangly.fsm.utilities.GeneratorStateMachineCat
-
Constructor of the class.
- getHierarchyFor(State<O, S, E>) - Method in interface net.tangly.fsm.State
-
Return the list of all substates including this state and the given substate to reach the given substate.
- getStateFor(S) - Method in interface net.tangly.fsm.State
-
Return the state with the given state identifier.
- getStateId(State<O, S, E>) - Method in class net.tangly.fsm.utilities.Generator
- getStateName(State<O, S, E>) - Method in class net.tangly.fsm.utilities.Generator
- guard() - Method in interface net.tangly.fsm.Transition
-
Return the optional guard restricting the firing of the transition.
- guardDescription() - Method in interface net.tangly.fsm.Transition
-
Return the human-readable description of the guard for the transition.
H
- hasAction() - Method in interface net.tangly.fsm.Transition
-
Indicate if the transition has an action or not.
- hasEntryAction() - Method in interface net.tangly.fsm.State
-
Return true if the state has an entry action.
- hasExitAction() - Method in interface net.tangly.fsm.State
-
Return true if the state has an exit action.
- hasGuard() - Method in interface net.tangly.fsm.Transition
-
Indicate if the transition has a guard or not.
- hashCode() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.tangly.fsm.Event
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.tangly.fsm.utilities.DynamicChecker
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.tangly.fsm.utilities.StateMachineLogger
-
Returns a hash code value for this object.
- hasHistory() - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the history flag of the state to true.
- hasHistory() - Method in interface net.tangly.fsm.State
-
Return true if the state has history active.
- hasHistory(boolean) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the history flag of the state.
- hasHistory(boolean) - Method in class net.tangly.fsm.imp.DefinitionBuilder
I
- id() - Method in interface net.tangly.fsm.actors.Actor
-
Return a unique identifier of the actor.
- id() - Method in class net.tangly.fsm.actors.ActorImp
- id() - Method in interface net.tangly.fsm.State
-
Gets the id of this state.
- in(S) - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Select the state with the given identifier and returns a state builder.
- in(S) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- indent(PrintWriter, int) - Method in class net.tangly.fsm.utilities.Generator
- INFO - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- initialState() - Method in interface net.tangly.fsm.State
-
Return the direct substate being an initial state.
- initialStates() - Method in interface net.tangly.fsm.State
-
Return the state machine's default initial state.
- isAlive() - Method in interface net.tangly.fsm.StateMachine
-
Return true if the finite state machine is in a non-final state and will process further events.
- isComposite() - Method in interface net.tangly.fsm.State
-
Return true if the state contains substates.
- isFinal() - Method in interface net.tangly.fsm.State
-
Return true if the state is a final state.
- isInitial() - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the initial flag of the state to true.
- isInitial() - Method in class net.tangly.fsm.imp.DefinitionBuilder
- isInitial() - Method in interface net.tangly.fsm.State
-
Return true if the state is an initial state.
- isInitial(boolean) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the initial flag of the state.
- isInitial(boolean) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- isRegistered(StateMachineEventHandler<O, S, E>) - Method in interface net.tangly.fsm.StateMachine
-
Return true if the given handler is registered in the state machine.
L
- localTransitions() - Method in interface net.tangly.fsm.State
-
Return the list of local or self transitions starting from this state.
M
- machine() - Method in record class net.tangly.fsm.utilities.StateMachineLogger
-
Returns the value of the
machine
record component. - machine(String, O) - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Create an instance of the state machine based on the definition of the state machine available to the builder.
- machine(String, O) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- message() - Method in class net.tangly.fsm.actors.ActorImp
- message(long, TimeUnit) - Method in class net.tangly.fsm.actors.ActorImp
N
- name() - Method in interface net.tangly.fsm.actors.Actor
-
Return the possibly unique human-readable name of the actor.
- name() - Method in class net.tangly.fsm.actors.ActorImp
- name() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns the value of the
name
record component. - name() - Method in class net.tangly.fsm.actors.Channel
- name() - Method in interface net.tangly.fsm.StateMachine
-
Return the name of this state machine.
- name() - Method in class net.tangly.fsm.utilities.Generator
- net.tangly.fsm - module net.tangly.fsm
-
Provides classes for a fluent based finite state machine library implementing hierarchical state machines as defined in the UML 2 standard.
- net.tangly.fsm - package net.tangly.fsm
-
The package defines the interfaces to access and work with hierarchical state machines.
- net.tangly.fsm.actors - package net.tangly.fsm.actors
-
The package provides actor abstractions to run a set of finite state machines as processes and exchange messages between actors.
- net.tangly.fsm.dsl - package net.tangly.fsm.dsl
-
The domain specific language builds finite state machine definitions including Lambda expressions and optional human-readable names and descriptions.
- net.tangly.fsm.imp - package net.tangly.fsm.imp
-
The implementation of the finite state machine interfaces; the classes are package private and are only instantiated through the domain specific language implementing the builder pattern.
- net.tangly.fsm.utilities - package net.tangly.fsm.utilities
-
Provides utilities to validate and to generate description in textual and graphical forms of finite state machine descriptions.
O
- of(E) - Static method in record class net.tangly.fsm.Event
-
Factory method to create an event.
- of(E, Object...) - Static method in record class net.tangly.fsm.Event
-
Factory method to create an event.
- of(S) - Static method in interface net.tangly.fsm.dsl.FsmBuilder
-
Builder method to create a new finite state machine builder.
- on(E) - Method in interface net.tangly.fsm.dsl.StateBuilder
-
Once a state is selected, you can addToRoot a new transition leaving this state.
- on(E) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- onEntry(BiConsumer<O, Event<E>>) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the entry action of the state.
- onEntry(BiConsumer<O, Event<E>>, String) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the entry action of the state.
- onEntry(BiConsumer<O, Event<E>>, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- onEntry(Consumer<O>) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the entry action of the state.
- onEntry(Consumer<O>, String) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the entry action of the state.
- onExit(BiConsumer<O, Event<E>>) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the exit action of the state.
- onExit(BiConsumer<O, Event<E>>, String) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the exit action of the state.
- onExit(BiConsumer<O, Event<E>>, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- onExit(Consumer<O>) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the exit action of the state.
- onExit(Consumer<O>, String) - Method in interface net.tangly.fsm.dsl.SubStateBuilder
-
Sets the exit action of the state.
- onLocal(E) - Method in interface net.tangly.fsm.dsl.StateBuilder
-
Once a state is selected, you can addToRoot a new local transition on the state.
- onLocal(E, String) - Method in interface net.tangly.fsm.dsl.StateBuilder
-
Once a state is selected, you can addToRoot a new local transition on the state.
- onLocal(E, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- onlyIf(BiPredicate<O, Event<E>>, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- onlyIf(BiPredicate<O, Event<E>>) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- onlyIf(BiPredicate<O, Event<E>>, String) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- onlyIf(Predicate<O>) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can addToRoot an optional guard.
- onlyIf(Predicate<O>, String) - Method in interface net.tangly.fsm.dsl.TransitionBuilder
-
Once a transition is selected, you can add an optional guard.
P
- parameters() - Method in record class net.tangly.fsm.Event
-
Returns the value of the
parameters
record component. - process(Event<E>) - Method in class net.tangly.fsm.actors.ActorFsm
- process(T) - Method in class net.tangly.fsm.actors.ActorImp
- process(T) - Method in class net.tangly.fsm.actors.ActorTimerMgr
- processEvent(Event<E>) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback before the processing of an event is started.
- processEvent(Event<E>) - Method in record class net.tangly.fsm.utilities.DynamicChecker
- processEvent(Event<E>) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- publish(T) - Method in class net.tangly.fsm.actors.Channel
-
Dispatch a message to all subscribers of the channel.
- publisher() - Method in class net.tangly.fsm.actors.Channel
R
- receive(T) - Method in interface net.tangly.fsm.actors.Actor
-
Receive a message for further processing.
- receive(T) - Method in class net.tangly.fsm.actors.ActorImp
- recurring() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns the value of the
recurring
record component. - register(Actor<T>) - Method in class net.tangly.fsm.actors.Actors
-
Register the actor in the pool of known actors and activate it by submitting it to the executor.
- register(Actor<T>, String) - Method in class net.tangly.fsm.actors.Actors
-
Register the actor in the pool of known actors and activate it by submitting it to the executor.
- removeEventHandler(StateMachineEventHandler<O, S, E>) - Method in interface net.tangly.fsm.StateMachine
-
Remove the given event handler.
- reset() - Method in interface net.tangly.fsm.StateMachine
-
Reset the state machine to his start state.
- root() - Method in interface net.tangly.fsm.dsl.FsmBuilder
-
Select the root state of the machine and returns a state builder.
- root() - Method in class net.tangly.fsm.imp.DefinitionBuilder
- root() - Method in interface net.tangly.fsm.StateMachine
-
Return the state machine description.
- run() - Method in class net.tangly.fsm.actors.ActorImp
- run() - Method in class net.tangly.fsm.actors.ActorTimerMgr
S
- send(Actor<T>, T) - Static method in interface net.tangly.fsm.actors.Actor
- sendTo(T, UUID) - Method in class net.tangly.fsm.actors.Actors
-
Send an event to the actor with the given name.
- source() - Method in interface net.tangly.fsm.Transition
-
Return the start state or source state of the transition.
- State<O,
S, - Interface in net.tangly.fsmE> -
The state abstraction of a hierarchical finite state machine.
- StateBuilder<O,
S, - Interface in net.tangly.fsm.dslE> -
Domain-specific language fluent interface to configure an existing state with new substates.
- StateMachine<O,
S, - Interface in net.tangly.fsmE> -
The finite state machine executing a hierarchical finite state machine description.
- StateMachineEventHandler<O,
S, - Interface in net.tangly.fsmE> -
The handler observing all the changes in a hierarchical final state machine.
- StateMachineLogger<O,
S, - Record Class in net.tangly.fsm.utilitiesE> -
The state machine logger documents all activities performed during the firing of events for a specific finite state machine instance.
- StateMachineLogger(StateMachine<O, S, E>) - Constructor for record class net.tangly.fsm.utilities.StateMachineLogger
-
Creates an instance of a
StateMachineLogger
record class. - states - Variable in class net.tangly.fsm.utilities.Generator
- StaticChecker<O,
S, - Class in net.tangly.fsm.utilitiesE> -
The finite state machine static checker verifies the correctness of a state machine description.
- StaticChecker() - Constructor for class net.tangly.fsm.utilities.StaticChecker
- subscribe(Actor<T>) - Method in class net.tangly.fsm.actors.Channel
-
Subscribe an actor to the channel.
- SubStateBuilder<O,
S, - Interface in net.tangly.fsm.dslE> -
Domain specific language fluent interface to configure a new state.
- substates() - Method in interface net.tangly.fsm.State
-
Return the list of substates.
T
- target() - Method in interface net.tangly.fsm.Transition
-
Return the end state or target state of the transition.
- throwException(State<O, S, E>, BiConsumer<O, Event<E>>, Event<E>, Exception) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback when an exception was thrown during the execution of an entry or exit state action.
- throwException(State<O, S, E>, BiConsumer<O, Event<E>>, Event<E>, Exception) - Method in record class net.tangly.fsm.utilities.DynamicChecker
- throwException(State<O, S, E>, BiConsumer<O, Event<E>>, Event<E>, Exception) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- throwException(Transition<O, S, E>, Event<E>, Exception) - Method in interface net.tangly.fsm.StateMachineEventHandler
-
Callback when an exception was thrown during the evaluation of a transition guard or action.
- throwException(Transition<O, S, E>, Event<E>, Exception) - Method in record class net.tangly.fsm.utilities.DynamicChecker
- throwException(Transition<O, S, E>, Event<E>, Exception) - Method in record class net.tangly.fsm.utilities.StateMachineLogger
- timer() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Returns the value of the
timer
record component. - Timer(Actor<T>, String, long, boolean, long) - Constructor for record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Creates an instance of a
Timer
record class. - TimerCmd(ActorTimerMgr.TimerCommands, ActorTimerMgr.Timer<T>) - Constructor for record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Creates an instance of a
TimerCmd
record class. - to(S) - Method in interface net.tangly.fsm.dsl.ToTransitionBuilder
-
Creates a transition from the selected state to the one with the given identifier.
- to(S, String) - Method in interface net.tangly.fsm.dsl.ToTransitionBuilder
-
Creates a transition from the selected state to the one with the given identifier.
- to(S, String) - Method in class net.tangly.fsm.imp.DefinitionBuilder
- toString() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.Timer
-
Returns a string representation of this record class.
- toString() - Method in record class net.tangly.fsm.actors.ActorTimerMgr.TimerCmd
-
Returns a string representation of this record class.
- toString() - Method in record class net.tangly.fsm.Event
-
Returns a string representation of this record class.
- toString() - Method in record class net.tangly.fsm.utilities.DynamicChecker
-
Returns a string representation of this record class.
- toString() - Method in record class net.tangly.fsm.utilities.StateMachineLogger
-
Returns a string representation of this record class.
- toString(String) - Method in class net.tangly.fsm.utilities.Generator
- ToTransitionBuilder<O,
S, - Interface in net.tangly.fsm.dslE> -
Domain-specific language fluent interface to configure a new transition to another node.
- TRACE - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- Transition<O,
S, - Interface in net.tangly.fsmE> -
The transition defines a link between two finite machine states.
- TransitionBuilder<O,
S, - Interface in net.tangly.fsm.dslE> -
Domain-specific language fluent interface to configure a new transition.
- transitionComparator() - Method in class net.tangly.fsm.utilities.Generator
- transitions() - Method in interface net.tangly.fsm.State
-
Return the list of transitions starting from this state.
- type() - Method in record class net.tangly.fsm.Event
-
Returns the value of the
type
record component.
V
- valueOf(String) - Static method in enum class net.tangly.fsm.utilities.Checker.Level
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class net.tangly.fsm.utilities.Checker.Level
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARNING - Enum constant in enum class net.tangly.fsm.utilities.Checker.Level
- wasReset() - Method in interface net.tangly.fsm.StateMachineEventHandler
-
The reset operation was called on the state machine.
- wasReset() - Method in record class net.tangly.fsm.utilities.DynamicChecker
- wasReset() - Method in record class net.tangly.fsm.utilities.StateMachineLogger
All Classes and Interfaces|All Packages|Constant Field Values