Index (state-machine 1.2.0 API)

A B C D E F G H I L M N O P R S T U V Y

A

ABORT - Static variable in class com.github.pnavais.machine.api.Status: Abort the operation
AbstractEnvelope<N extends Node,M extends Message> - Class in com.github.pnavais.machine.api.message: Base class for Envelope implementors.
AbstractEnvelope() - Constructor for class com.github.pnavais.machine.api.message.AbstractEnvelope
AbstractFilteredState - Class in com.github.pnavais.machine.model: Base class for all Message filter state decorators
AbstractFilteredState(State) - Constructor for class com.github.pnavais.machine.model.AbstractFilteredState: Constructor with the state to wrap
AbstractNode - Class in com.github.pnavais.machine.api: Represents an arbitrary node of a given directed graph
AbstractNode(String) - Constructor for class com.github.pnavais.machine.api.AbstractNode: Constructor with node name
AbstractStatesExporter<R,S extends State,M extends Message,T extends Transitioner<S,M,? extends Transition<S,M>>> - Class in com.github.pnavais.machine.exporter
AbstractStatesExporter(FileSystem, String, Color, boolean, boolean, Color) - Constructor for class com.github.pnavais.machine.exporter.AbstractStatesExporter: All arguments constructor
AbstractStatesExporter() - Constructor for class com.github.pnavais.machine.exporter.AbstractStatesExporter: No arguments constructor.
AbstractWrappedState - Class in com.github.pnavais.machine.model: This class is intended to contain the actual State instance in order to be stored in a state machine.
AbstractWrappedState(State) - Constructor for class com.github.pnavais.machine.model.AbstractWrappedState: Constructor with the state to wrap
add(T) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Adds a new transition
add(T) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Adds a new transition to the index
add(StateTransition) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Adds the given transition to the transition map.
add(StateTransition) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Adds a new Transition to the statemachine.
add(StateTransition) - Method in class com.github.pnavais.machine.StateMachine: Adds a new Transition to the state machine.
addAll(Collection<T>) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Adds a collection of Transition to the state machine.
addAll(Collection<T>) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Adds all supplied transitions to the index.
addAll(Collection<StateTransition>) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Adds all supplied transitions to the index.
addAll(Collection<StateTransition>) - Method in class com.github.pnavais.machine.StateMachine: Adds a collection of Transition to the state machine.
addProperty(String, String) - Method in class com.github.pnavais.machine.model.State: Adds the property with the given key and value.
ANY - Static variable in class com.github.pnavais.machine.api.message.Messages: A void message used as marker representing any kind of message
ANY_MESSAGE_ID - Static variable in class com.github.pnavais.machine.api.message.Messages: The identifier of the ANY void message
ANY_MESSAGE_PAYLOAD - Static variable in class com.github.pnavais.machine.api.message.Messages: The payload string of the ANY void message
arriving(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Initializes the builder to add a global filter for arrivals for the state specified by the given name.
arriving(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Initializes the builder to add a global filter for arrivals for the given state.
arriving(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Adds a filtering function for incoming messages in target state of the transition by transforming the current target state into a FilteredState.
arriving(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Initializes the builder to add a global filter for arrivals for the state specified by the given name.
arriving(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Initializes the builder to add a global filter for arrivals for the given state.
arriving(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Adds a filtering function for incoming messages in target state of the transition by transforming the current target state into a FilteredState.

B

build() - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Creates and initializes a State Machine from the transition map currently built.
build() - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Finish the current transition and retrieves the current state machine built instance.
build() - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Finish the current transition and retrieves the current state machine built instance.
build() - Method in class com.github.pnavais.machine.model.State.StateBuilder: Retrieves the built instance
builder() - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Retrieves the current State Machine builder

C

clear() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Removes all transitions from the state machine
clear() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Removes all nodes and transitions
clear() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Clear all states and transitions from the map
clear() - Method in class com.github.pnavais.machine.StateMachine: Removes all transitions from the state machine
ColorTranslator - Class in com.github.pnavais.machine.exporter.util: Contains utility method to translated colors to string formats.
ColorTranslator() - Constructor for class com.github.pnavais.machine.exporter.util.ColorTranslator
com.github.pnavais.machine - package com.github.pnavais.machine
com.github.pnavais.machine.api - package com.github.pnavais.machine.api
com.github.pnavais.machine.api.exception - package com.github.pnavais.machine.api.exception
com.github.pnavais.machine.api.exporter - package com.github.pnavais.machine.api.exporter
com.github.pnavais.machine.api.filter - package com.github.pnavais.machine.api.filter
com.github.pnavais.machine.api.importer - package com.github.pnavais.machine.api.importer
com.github.pnavais.machine.api.message - package com.github.pnavais.machine.api.message
com.github.pnavais.machine.api.transition - package com.github.pnavais.machine.api.transition
com.github.pnavais.machine.api.validator - package com.github.pnavais.machine.api.validator
com.github.pnavais.machine.builder - package com.github.pnavais.machine.builder
com.github.pnavais.machine.exporter - package com.github.pnavais.machine.exporter
com.github.pnavais.machine.exporter.util - package com.github.pnavais.machine.exporter.util
com.github.pnavais.machine.impl - package com.github.pnavais.machine.impl
com.github.pnavais.machine.importer - package com.github.pnavais.machine.importer
com.github.pnavais.machine.model - package com.github.pnavais.machine.model
contains(N) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Checks the presence of the given node in the index.
contains(T) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Checks the presence of the given transition in the index.
contains(State) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Checks the presence of the given state in the index.
contains(StateTransition) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Checks the presence of the given transition in the index.
Context<T extends AbstractNode> - Class in com.github.pnavais.machine.api.filter: Simple holder for all components involved in a transition event i.e.
Context() - Constructor for class com.github.pnavais.machine.api.filter.Context
createNew() - Static method in class com.github.pnavais.machine.api.message.VoidMessage: Creates a new void message.
createWith(String) - Static method in class com.github.pnavais.machine.api.message.VoidMessage: Creates a new void message with name.
createWith(String, Payload) - Static method in class com.github.pnavais.machine.api.message.VoidMessage: Creates a new void message with name and payload
currentStateColor - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The color for final states

D

DEFAULT_CURRENT_COLOR - Static variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The default color for current state
DEFAULT_FINAL_COLOR - Static variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The default color for final states
DOTExporter - Class in com.github.pnavais.machine.exporter: An exporter allowing to translate a given state machine to the GraphViz DOT language (@see https://www.graphviz.org/doc/info/lang.html)
DOTExporter(FileSystem, String, Color, boolean, boolean, Color, DOTExporter.RankDir) - Constructor for class com.github.pnavais.machine.exporter.DOTExporter: All arguments constructor
DOTExporter.RankDir - Enum in com.github.pnavais.machine.exporter: The possible Rank direction of the grapth

E

EMPTY - Static variable in class com.github.pnavais.machine.api.message.Messages: A void message used as marker representing an empty message
EMPTY_MESSAGE_ID - Static variable in class com.github.pnavais.machine.api.message.Messages: The identifier of the EMPTY void message
EMPTY_MESSAGE_PAYLOAD - Static variable in class com.github.pnavais.machine.api.message.Messages: The payload string of the EMPTY void message
Envelope<N extends Node,M extends Message> - Interface in com.github.pnavais.machine.api.message: This interface allows wrapping a message with the source/target information in order to be transmitted to interested parties (e.g.
equals(Object) - Method in class com.github.pnavais.machine.api.AbstractNode
equals(Object) - Method in class com.github.pnavais.machine.api.Transition
equals(Object) - Method in class com.github.pnavais.machine.model.AbstractWrappedState
equals(Object) - Method in class com.github.pnavais.machine.model.FilteredState
equals(Object) - Method in class com.github.pnavais.machine.model.SimpleEnvelope
equals(Object) - Method in class com.github.pnavais.machine.model.State
equals(Object) - Method in class com.github.pnavais.machine.model.StringMessage
Event - Enum in com.github.pnavais.machine.api.message
execute(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.FilterBuilder: Adds the global filter to the current state for the corresponding event (departure/arrival)
export(T) - Method in interface com.github.pnavais.machine.api.exporter.Exporter: Exports the current contents of the transitioner to the given output format.
export(StateMachine) - Method in class com.github.pnavais.machine.exporter.DOTExporter: Export the current contents of the state machine to the DOT language.
export(StateMachine) - Method in class com.github.pnavais.machine.exporter.YAMLExporter: Export the current contents of the state machine to YAML syntax.
Exporter<R,N extends Node,M extends Message,T extends Transitioner<N,M,? extends Transition<N,M>>> - Interface in com.github.pnavais.machine.api.exporter: Defines the methods to export a Transitioner to a given result type.
exportToFile(T, Path) - Method in interface com.github.pnavais.machine.api.exporter.Exporter: Exports the current contents of the transitioner to the given output file.
exportToFile(T, String) - Method in class com.github.pnavais.machine.exporter.AbstractStatesExporter: Export the current contents of the transitioner to the DOT language to the given file path.
exportToFile(T, Path) - Method in class com.github.pnavais.machine.exporter.AbstractStatesExporter: Export the current contents of the transitioner to the DOT language to the given file path.

F

fail(String) - Static method in class com.github.pnavais.machine.api.validator.ValidationResult: Creates an unsuccessful validation result with the given message.
FileExportException - Exception in com.github.pnavais.machine.api.exception: An exception raised on file export operations
FileExportException(String, Throwable) - Constructor for exception com.github.pnavais.machine.api.exception.FileExportException: Creates the exception using the given message description and wrapping the actual exception
FileImportException - Exception in com.github.pnavais.machine.api.exception: Exception raised during I/O Processing of a given State Machine representation.Actually the exception is intended to wrap an actual underlying exception (e.g IOException
FileImportException(String, Throwable) - Constructor for exception com.github.pnavais.machine.api.exception.FileImportException: Constructor with a given message and throwable cause.
fileSystem - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The file system to use when locating paths
fillDefaults() - Method in class com.github.pnavais.machine.exporter.AbstractStatesExporter: Fills default values for all non-primitive types
FilteredState - Class in com.github.pnavais.machine.model: A decorator adding message filtering functionality to regular states.
FilteredState(State) - Constructor for class com.github.pnavais.machine.model.FilteredState: Constructor with state
finalStateColor - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The color for final states
find(String) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Finds the node in the transition associated with the give name.
find(String) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Search the given node in the transition index by its name.
find(String) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Finds the given state by its name.
find(String) - Method in class com.github.pnavais.machine.StateMachine: Finds the state referenced by the given name in the state machine machine.
forward(Message) - Static method in class com.github.pnavais.machine.api.Status: Creates an status to request the emission of a new message.
from(RuntimeException) - Static method in class com.github.pnavais.machine.api.validator.ValidationResult: Creates an invalid result from a given exception
from(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Starts the building of a new transition by specifying the source state's name
from(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Starts the building of a new transition by specifying the source state.
from(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Starts a new transition from the given state name using an empty message for the current transition.
from(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Starts a new transition from the given state using an empty message for the current transition.
from(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Starts a new transition from the given state name using an empty message for the current transition.
from(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Starts a new transition from the given state using an empty message for the current transition.
from(State) - Static method in class com.github.pnavais.machine.model.FilteredState: Static factory method to decorate the state with message filtering capabilities
from(Status, Event) - Static method in class com.github.pnavais.machine.model.InfoStatus: Static factory method to create the wrapped information status instance.
from(String) - Static method in class com.github.pnavais.machine.model.State: Static factory method to create the State
from(String) - Static method in class com.github.pnavais.machine.model.StringMessage: Static factory method to create a message with a message key.
from(String, Payload) - Static method in class com.github.pnavais.machine.model.StringMessage: Static factory method to create a message with a message key and payload
FunctionMessageFilter<T extends AbstractNode,C extends Context<T>> - Class in com.github.pnavais.machine.api.filter: Allows fine grained customization of the filtering as it provides a per message functionality injection.
FunctionMessageFilter() - Constructor for class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Creates a new FunctionMessageFilter

G

getAllTransitions() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves all state transitions currently defined.
getAllTransitions() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieve all transitions stored in the index.
getAllTransitions() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieve all the transitions stored in the transition map.
getAllTransitions() - Method in class com.github.pnavais.machine.StateMachine: Retrieves all state transitions currently defined.
getCurrent() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the node of the last transition performed.
getCurrent() - Method in class com.github.pnavais.machine.StateMachine: Retrieves the current state
getDispatchHandler(Message) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Retrieves the dispatch handler for the given message
getFailurePolicy() - Method in interface com.github.pnavais.machine.api.validator.TransitionValidator: Retrieves the failure policy.
getFirst() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the first node in the index
getFirst() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the first state in the transition map
getId() - Method in class com.github.pnavais.machine.api.AbstractNode: Retrieves the identifier of the node
getMessage() - Method in interface com.github.pnavais.machine.api.message.Envelope: Retrieves the message
getMessageFilter() - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Retrieves the message filter
getMessageId() - Method in interface com.github.pnavais.machine.api.message.Message: Retrieves the Message Identifier
getMessageId() - Method in class com.github.pnavais.machine.model.StringMessage: Retrieves the message identifier
getName() - Method in class com.github.pnavais.machine.api.AbstractNode: Retrieves the name of the node
getName() - Method in interface com.github.pnavais.machine.api.Node: Retrieves the name of the node
getName() - Method in class com.github.pnavais.machine.model.AbstractWrappedState: Retrieves the name of the state
getNext(M) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the next node upon transitioning from the current node on message reception.
getNext(N, M) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the next node after applying the message on the given source node.
getNext(State, Message) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the next state in the transition from source state upon message m reception
getNext(Message) - Method in class com.github.pnavais.machine.StateMachine: Retrieves the next state upon message reception.
getOrigin() - Method in interface com.github.pnavais.machine.api.message.Envelope: Retrieves the source originator of the message.
getPayload() - Method in interface com.github.pnavais.machine.api.message.Message: Retrieves the payload contents of the message.
getPayload() - Method in class com.github.pnavais.machine.model.StringMessage
getPrevious(N, M) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the previous node upon reception of the message on the given source node.
getPrevious(State, Message) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the previous node upon reception of the message on the given source node.
getProperty(String) - Method in class com.github.pnavais.machine.model.State: Retrieves the property identified by the given key or null if not found
getReceptionHandler(Message) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Retrieves the reception handler for the given message
getSiblings(String) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the adjacent nodes i.e.
getSiblings(String) - Method in class com.github.pnavais.machine.StateMachine: Retrieves the adjacent states i.e.
getTarget() - Method in interface com.github.pnavais.machine.api.message.Envelope: Retrieves the target of the message.
getTransitionMap() - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Retrieves the current transition map.
getTransitions(String) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the transitions currently defined for the given node.
getTransitions(N) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the transitions stored in the index for the given node.
getTransitions(String) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the transitions stored in the index for the given named node.
getTransitions(String) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the transitions from the given state or throws a NullStateException if not found.
getTransitions(State) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the transitions from the given state or throws a NullStateException if not found.
getTransitions(String) - Method in class com.github.pnavais.machine.StateMachine: Retrieves the state transitions for the given state.
getTransitionsAsMap() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the transitions as a map
getTransitionsAsMap() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the transitions as a map
getTransitionsIndex() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the transition index used by the transition.
getTransitionsIndex() - Method in class com.github.pnavais.machine.StateMachine: Retrieves the transition map
graphName - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The name of the graph

H

hashCode() - Method in class com.github.pnavais.machine.api.AbstractNode
hashCode() - Method in class com.github.pnavais.machine.api.Transition
hashCode() - Method in class com.github.pnavais.machine.model.AbstractWrappedState
hashCode() - Method in class com.github.pnavais.machine.model.FilteredState
hashCode() - Method in class com.github.pnavais.machine.model.SimpleEnvelope
hashCode() - Method in class com.github.pnavais.machine.model.State
hashCode() - Method in class com.github.pnavais.machine.model.StringMessage
hasProperties() - Method in class com.github.pnavais.machine.model.State: Checks whether the state has properties or not
hasProperty(String) - Method in class com.github.pnavais.machine.model.State: Checks whether the state contains the given property.

I

id - Variable in class com.github.pnavais.machine.api.AbstractNode: The identifier of the node
IllegalTransitionException - Exception in com.github.pnavais.machine.api.exception: An exception raised when dealing with incorrect transitions
IllegalTransitionException(String) - Constructor for exception com.github.pnavais.machine.api.exception.IllegalTransitionException: Creates the exception using the given message description.
Importer<I,N extends Node,M extends Message,T extends Transitioner<N,M,? extends Transition<N,M>>> - Interface in com.github.pnavais.machine.api.importer: Defines the methods to import a Transitioner from a given input source.
ImportException - Exception in com.github.pnavais.machine.api.exception: The base class for all import exception types
ImportException(String) - Constructor for exception com.github.pnavais.machine.api.exception.ImportException: Instantiates a new Import exception with a description message.
ImportException(String, Throwable) - Constructor for exception com.github.pnavais.machine.api.exception.ImportException: Instantiates a new Import exception with a description message and throwable cause.
InfoStatus - Class in com.github.pnavais.machine.model: This class acts as a wrapper for Status instances allowing to associate their originating events.
init() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Performs generic initialization e.g.
init() - Method in class com.github.pnavais.machine.StateMachine: Initializes the current state to the first one added to the state machine (if any).
isFinal() - Method in class com.github.pnavais.machine.api.AbstractNode: Retrieves the final state condition flag.
isFinal() - Method in class com.github.pnavais.machine.model.AbstractWrappedState: Retrieves the final state condition flag.
isFinal(boolean) - Method in class com.github.pnavais.machine.model.State.StateBuilder: Sets the final state
isRedirect() - Method in class com.github.pnavais.machine.api.Status: Verify if the status informs of a redirection (forward status and message is present)

L

leaving(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Initializes the builder to add a global filter for departures for the state specified by the given name.
leaving(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Initializes the builder to add a global filter for departures for the given state.
leaving(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Adds a filtering function for triggering messages from origin state of the transition by transforming the current origin state into a FilteredState.
leaving(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Initializes the builder to add a global filter for departures for the state specified by the given name.
leaving(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Initializes the builder to add a global filter for departures for the given state.
leaving(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Adds a filtering function for triggering messages from origin state of the transition by transforming the current origin state into a FilteredState.

M

merge(AbstractNode) - Method in class com.github.pnavais.machine.api.AbstractNode: Merges the information of the given node into the current instance.
merge(N) - Method in interface com.github.pnavais.machine.api.Mergeable: Merges the information contained by the given node returning a merged node.
merge(AbstractNode) - Method in class com.github.pnavais.machine.model.FilteredState: Adds the filter mappings from the given state to the current instance.
merge(AbstractNode) - Method in class com.github.pnavais.machine.model.State: Merges the information of the given state into the current instance.
Mergeable<N extends Node> - Interface in com.github.pnavais.machine.api: Defines the method to be implemented by classes interested in merging its current state (i.e.
message - Variable in class com.github.pnavais.machine.api.message.AbstractEnvelope: The message
Message - Interface in com.github.pnavais.machine.api.message: Represents a message passed to a given state in the state machine.
message - Variable in class com.github.pnavais.machine.api.Status: The emitted message
message - Variable in class com.github.pnavais.machine.api.Transition: The Message triggering the transition
MessageFilter<T extends AbstractNode,C extends Context<T>> - Interface in com.github.pnavais.machine.api.filter: A MessageFilter allows performing custom logic upon reception or dispatch of messages deciding whether the operation can continue or not.
Messages - Class in com.github.pnavais.machine.api.message: Provides default generic Message types

N

name - Variable in class com.github.pnavais.machine.api.AbstractNode: The shorthand name associated to the node
named(String) - Static method in class com.github.pnavais.machine.model.State: Static factory method to create the State with name.
named(String) - Method in class com.github.pnavais.machine.model.State.StateBuilder: Named state builder.
newBuilder() - Static method in class com.github.pnavais.machine.StateMachine: Retrieves a new StateMachineBuilder instance to ease the State Machine creation process.
next() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Sends an empty message to the transitioner triggering a potential transition in case the current node supports empty messages.
next() - Method in class com.github.pnavais.machine.StateMachine: Sends a void message to the state machine triggering a potential transition.
NL - Static variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The system's new line character
Node - Interface in com.github.pnavais.machine.api: Represents any item present in a directed graph
NULL - Static variable in class com.github.pnavais.machine.api.message.Messages: A void message used as marker representing an empty message
NullStateException - Exception in com.github.pnavais.machine.api.exception: An exception raised when dealing with void states.
NullStateException(String) - Constructor for exception com.github.pnavais.machine.api.exception.NullStateException: Create the exception with the given message.
NullTransitionException - Exception in com.github.pnavais.machine.api.exception: An exception raised when dealing with void transitions.
NullTransitionException(String) - Constructor for exception com.github.pnavais.machine.api.exception.NullTransitionException: Creates a new exception with the given message.

O

on(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Ends the transition by applying the message and retrieving the initial builder.
on(Message) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Ends the transition by applying a custom message and retrieving the initial builder.
onDispatch(C) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Delegates the execution of the message dispatch to the dispatch function registered with the message.
onDispatch(C) - Method in interface com.github.pnavais.machine.api.filter.MessageFilter: Intercepts a message to be dispatched to the given destination.
onDispatch(StateContext) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Intercepts a message to be dispatched to the given destination.
onReceive(C) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Delegates the execution of the message processing to the reception function registered with the message.
onReceive(C) - Method in interface com.github.pnavais.machine.api.filter.MessageFilter: Intercepts a message to be received from the given origin.
onReceive(StateContext) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Intercepts a message to be received from the given origin.
origin - Variable in class com.github.pnavais.machine.api.message.AbstractEnvelope: The source node
origin - Variable in class com.github.pnavais.machine.api.Transition: The source node of the transition

P

parse(I) - Method in interface com.github.pnavais.machine.api.importer.Importer: Parses the given input format containing the information allowing to deserialize the transitioner.
parse(String) - Method in class com.github.pnavais.machine.importer.YAMLImporter: Parses the given YAML String containing the State machine specification or throws YAMLImportException in case of errors.
parseFile(Path) - Method in interface com.github.pnavais.machine.api.importer.Importer: Parses the contents of the input file containing the information allowing to build the transitioner.
parseFile(String) - Method in class com.github.pnavais.machine.importer.YAMLImporter: Processes the given input file to obtain an actual StateMachine instance.
parseFile(Path) - Method in class com.github.pnavais.machine.importer.YAMLImporter: Processes the given input file to obtain an actual StateMachine instance.
Payload - Interface in com.github.pnavais.machine.api.message: A simple marker interface representing the information contained by transition messages.
PROCEED - Static variable in class com.github.pnavais.machine.api.Status: Proceed with the operation
property(String, String) - Method in class com.github.pnavais.machine.model.State.StateBuilder: Adds a new property to the state.
prune() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Remove orphan nodes.
prune() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Remove orphan nodes from the index (i.e.
prune() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Remove orphan states from the transition map i.e.
prune() - Method in class com.github.pnavais.machine.StateMachine: Remove orphan states

R

remove(T) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Removes an existing transition
remove(String) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Removes a node matching the given name and allits transitions
remove(N) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Removes an existing node and all its transitions.
remove(T) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Removes an existing transition from the index
remove(N) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Removes an existing node from the index and all its transitions.
remove(String) - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Removes an existing node from the index and all its transitions by its name.
remove(StateTransition) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Removes an existing Transition from the state machine.
remove(State) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Removes the current state from the machine including defined transitions.
remove(String) - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Removes the current state from the machine including defined transitions.
remove(StateTransition) - Method in class com.github.pnavais.machine.StateMachine: Removes an existing Transition from the state machine.
remove(String) - Method in class com.github.pnavais.machine.StateMachine: Removes an existing state from the state machine.
remove(State) - Method in class com.github.pnavais.machine.StateMachine: Removes an existing state from the state machine.
removeAllTransitions() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Removes all existing Transitions from the state machine.
removeAllTransitions() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Removes all transitions from the map
removeAllTransitions() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Clear all transitions from the map
removeAllTransitions() - Method in class com.github.pnavais.machine.StateMachine: Removes all existing Transitions from the state machine.
removeDispatchHandler(Message) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Removes the dispatch handler for the given message.
removeProperty(String) - Method in class com.github.pnavais.machine.model.State: Removes the property identified by the given key or discard the operation silently if not found.
removeReceptionHandler(Message) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Removes the reception handler for the given message.

S

selfLoop(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Creates a self loop for the state specified by the given name.
selfLoop(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder: Creates a self loop for the given state.
selfLoop(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Starts the definition of a loop for the given state's name
selfLoop(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder: Starts a definition of a loop for the given state
selfLoop(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Creates a self loop for the state specified by the given name.
selfLoop(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder: Creates a self loop for the given state.
send(M) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Sends a message to the transitioner triggering a potential transition.
send(String) - Method in class com.github.pnavais.machine.StateMachine: Sends a message to the state machine triggering a potential transition.
send(Message) - Method in class com.github.pnavais.machine.StateMachine: Sends a message to the state machine triggering a potential transition.
setCurrent(String) - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Sets the current node to the one supplied by the the given name.
setCurrent(String) - Method in class com.github.pnavais.machine.StateMachine: Sets the current state to the given one.
setCurrent(State) - Method in class com.github.pnavais.machine.StateMachine: Sets the current state if present
setDispatchHandler(Message, Function<C, Status>) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Sets the given function to handle the message to be dispatched.
setDispatchHandler(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Sets the dispatch handler for ANY message
setDispatchHandler(Message, Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Sets the dispatch handler for the given message
setDispatchHandler(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.FilteredState: Sets the dispatch handler for ANY message
setDispatchHandler(Message, Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.FilteredState: Sets the dispatch handler for the given message
setFinal(boolean) - Method in class com.github.pnavais.machine.api.AbstractNode: Sets whether the state is final or not.
setFinal(boolean) - Method in class com.github.pnavais.machine.model.AbstractWrappedState: Sets whether the state is final or not.
setReceptionHandler(Message, Function<C, Status>) - Method in class com.github.pnavais.machine.api.filter.FunctionMessageFilter: Sets the given function to handle the message to be received.
setReceptionHandler(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Sets the reception handler for ANY message
setReceptionHandler(Message, Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.AbstractFilteredState: Sets the reception handler for the given message
setReceptionHandler(Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.FilteredState: Sets the reception handler for ANY message
setReceptionHandler(Message, Function<StateContext, Status>) - Method in class com.github.pnavais.machine.model.FilteredState: Sets the reception handler for the given message
showCurrent - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: Show current status in different color
SimpleEnvelope - Class in com.github.pnavais.machine.model: An implementation of the envelope handling state messaging.
SimpleEnvelope(State, Message, State, TransitionIndex<State, Message, StateTransition>) - Constructor for class com.github.pnavais.machine.model.SimpleEnvelope
size() - Method in interface com.github.pnavais.machine.api.transition.Transitioner: Retrieves the number of nodes currently handled by the transition.
size() - Method in interface com.github.pnavais.machine.api.transition.TransitionIndex: Retrieves the number of elements in the index
size() - Method in class com.github.pnavais.machine.impl.StateTransitionMap: Retrieves the number of states in the transition map
size() - Method in class com.github.pnavais.machine.StateMachine: Retrieves the number of states currently present in the state machine.
state - Variable in class com.github.pnavais.machine.model.AbstractWrappedState: The target State.
State - Class in com.github.pnavais.machine.model: The default implementation of the state.
State(String) - Constructor for class com.github.pnavais.machine.model.State: Constructor with node name
State.StateBuilder - Class in com.github.pnavais.machine.model: A basic State builder
StateBuilder() - Constructor for class com.github.pnavais.machine.model.State.StateBuilder
StateContext - Class in com.github.pnavais.machine.model: The context implementation for State nodes
StateContext(Event, State, State, Message) - Constructor for class com.github.pnavais.machine.model.StateContext: Default constructor with all context information.
StateMachine - Class in com.github.pnavais.machine: The State Machine contains a simple map of Transitions between different nodes (States) triggered by incoming messages.
StateMachine() - Constructor for class com.github.pnavais.machine.StateMachine: Creates the state machine.
StateMachine(TransitionIndex<State, Message, StateTransition>) - Constructor for class com.github.pnavais.machine.StateMachine: Creates the state machine with the given transition map.
StateMachine(TransitionChecker<State, Message>) - Constructor for class com.github.pnavais.machine.StateMachine: Creates the state machine with the given transition checker.
StateMachine(TransitionIndex<State, Message, StateTransition>, TransitionChecker<State, Message>) - Constructor for class com.github.pnavais.machine.StateMachine: Creates the state machine with the given transition map and checker
StateMachineBuilder - Class in com.github.pnavais.machine.builder: A simple builder for StateMachine instances
StateMachineBuilder() - Constructor for class com.github.pnavais.machine.builder.StateMachineBuilder: The constructor
StateMachineBuilder.FilterBuilder - Class in com.github.pnavais.machine.builder: Internal builder class to begin the definition of a new filter.
StateMachineBuilder.FromBuilder - Class in com.github.pnavais.machine.builder: Internal builder class to begin the definition of a new transition.
StateMachineBuilder.OnBuilder - Class in com.github.pnavais.machine.builder: Internal builder class to optionally add message filtering before ending the definition of a new transition.
StateMachineBuilder.ToBuilder - Class in com.github.pnavais.machine.builder: Internal builder class to end the definition of a new transition.
StateTransition - Class in com.github.pnavais.machine.model: Represents a simple transition between states
StateTransition(State, Message, State) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination states after applying the message.
StateTransition(State, Message, String) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(String, Message, State) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(String, Message, String) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(State, String, State) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(String, String, String) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(String, String, State) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransition(State, String, String) - Constructor for class com.github.pnavais.machine.model.StateTransition: Creates a new state transition with the given origin and destination state names after applying the message.
StateTransitionChecker - Class in com.github.pnavais.machine.impl: Implements the check between state transitions
StateTransitionChecker() - Constructor for class com.github.pnavais.machine.impl.StateTransitionChecker
StateTransitionMap - Class in com.github.pnavais.machine.impl: The State Machine contains a simple map of Transitions between different nodes (States) triggered by incoming messages.
StateTransitionMap() - Constructor for class com.github.pnavais.machine.impl.StateTransitionMap: Creates the state machine.
StateTransitionMap(Map<State, Map<Message, State>>) - Constructor for class com.github.pnavais.machine.impl.StateTransitionMap: Creates the state machine with a given transition map.
StateTransitionMap(TransitionValidator<State, Message, StateTransition>) - Constructor for class com.github.pnavais.machine.impl.StateTransitionMap: Creates the state machine with a custom transition validator.
StateTransitionMap(Map<State, Map<Message, State>>, TransitionValidator<State, Message, StateTransition>) - Constructor for class com.github.pnavais.machine.impl.StateTransitionMap: Creates the state machine with a custom transition map and validator.
StateTransitionValidator - Class in com.github.pnavais.machine.impl: Implementation of the transition validator for state transitions.
StateTransitionValidator() - Constructor for class com.github.pnavais.machine.impl.StateTransitionValidator
Status - Class in com.github.pnavais.machine.api: The status represents the possible outcome of a given movement between nodes.
Status(String, Message, boolean) - Constructor for class com.github.pnavais.machine.api.Status: Constructor with name, message and validity.
STATUS_ABORTED - Static variable in class com.github.pnavais.machine.api.Status: The aborted status keyword
STATUS_FORWARD - Static variable in class com.github.pnavais.machine.api.Status: The send message status keyword
STATUS_PROCEED - Static variable in class com.github.pnavais.machine.api.Status: The proceed status keyword
statusName - Variable in class com.github.pnavais.machine.api.Status: The Status name.
StringMessage - Class in com.github.pnavais.machine.model: An implementation of the Message interface with a String payload.
StringMessage(String) - Constructor for class com.github.pnavais.machine.model.StringMessage: Default constructor with a message identifier
success() - Static method in class com.github.pnavais.machine.api.validator.ValidationResult: Creates a successful validation result

T

target - Variable in class com.github.pnavais.machine.api.message.AbstractEnvelope
target - Variable in class com.github.pnavais.machine.api.Transition: The target node of the transition
TB - Static variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: The tabulator character
to(String) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.FromBuilder: Adds a new target state to the transition under build.
to(State) - Method in class com.github.pnavais.machine.builder.StateMachineBuilder.FromBuilder: Adds a new target state by it's name to the transition under build.
toHSBColor(Color) - Static method in class com.github.pnavais.machine.exporter.util.ColorTranslator: Convert a color to an HSB string
toRGBColor(Color) - Static method in class com.github.pnavais.machine.exporter.util.ColorTranslator: Convert a color to an RGB string
toString() - Method in class com.github.pnavais.machine.api.message.VoidMessage
toString() - Method in enum com.github.pnavais.machine.exporter.DOTExporter.RankDir
toString() - Method in enum com.github.pnavais.machine.exporter.YAMLExporter.MarginSize
toString() - Method in class com.github.pnavais.machine.model.State
toString() - Method in class com.github.pnavais.machine.model.StateTransition
toString() - Method in class com.github.pnavais.machine.model.StringMessage
Transition<N extends Node,M extends Message> - Class in com.github.pnavais.machine.api: A generic contract allowing to identify the target destination after processing the message.
Transition() - Constructor for class com.github.pnavais.machine.api.Transition
TransitionChecker<N extends Node,M extends Message> - Interface in com.github.pnavais.machine.api.transition: The transition checker acts a validator that is used by a given State Machine to allow/deny a given transition.
Transitioner<N extends Node,M extends Message,T extends Transition<N,M>> - Interface in com.github.pnavais.machine.api.transition: An interface for defining methods common to entities handling transitions between nodes.
TransitionIndex<N extends Node,M extends Message,T extends Transition<N,M>> - Interface in com.github.pnavais.machine.api.transition: An index allowing to store and fetch defined transitions.
TransitionInitializationException - Exception in com.github.pnavais.machine.api.exception: An exception raised when initializing transitions incorrectly
TransitionInitializationException(String) - Constructor for exception com.github.pnavais.machine.api.exception.TransitionInitializationException: Creates the exception using the given message description.
TransitionValidator<N extends Node,M extends Message,T extends Transition<N,M>> - Interface in com.github.pnavais.machine.api.validator: The transition validator verifies operations involved in transition management with respect to a given index.
TransitionValidator.FailurePolicy - Enum in com.github.pnavais.machine.api.validator: The failure policy
TransitionValidator.Operation - Enum in com.github.pnavais.machine.api.validator: The possible transition operations

U

useHSB - Variable in class com.github.pnavais.machine.exporter.AbstractStatesExporter: Use HSB colors in the output format.

V

valid - Variable in class com.github.pnavais.machine.api.Status: The validity flag
validate(T, TransitionIndex<N, M, T>, TransitionValidator.Operation) - Method in interface com.github.pnavais.machine.api.validator.TransitionValidator: Checks the transition parameter correctness with respect to current transitions on the given index.
validate(StateTransition, TransitionIndex<State, Message, StateTransition>, TransitionValidator.Operation) - Method in class com.github.pnavais.machine.impl.StateTransitionValidator: Checks the transition parameter correctness with respect to current transitions on the given index before applying the operation.
validateArrival(Envelope<N, M>) - Method in interface com.github.pnavais.machine.api.transition.TransitionChecker: Validates the arrival to a given target state upon reception of a given message using the specified transition index to ensure transitions are accepted.
validateArrival(Envelope<State, Message>) - Method in class com.github.pnavais.machine.impl.StateTransitionChecker: Validates the arrival to a given target state upon reception of a given message using the specified transition index to ensure transitions are accepted.
validateDeparture(Envelope<N, M>) - Method in interface com.github.pnavais.machine.api.transition.TransitionChecker: Validates the departure from the current state upon reception of a given message using the specified transition index to ensure transitions are accepted.
validateDeparture(Envelope<State, Message>) - Method in class com.github.pnavais.machine.impl.StateTransitionChecker: Validates the departure from the current state upon reception of a given message using the specified transition index to ensure transitions are accepted.
ValidationException - Exception in com.github.pnavais.machine.api.exception: A generic exception raised when dealing with incorrect validation results
ValidationException(String) - Constructor for exception com.github.pnavais.machine.api.exception.ValidationException: Creates the exception using the given message description.
ValidationResult - Class in com.github.pnavais.machine.api.validator: This class holds the results of a validation with an optional detailed description message and companion exception class.
ValidationResult() - Constructor for class com.github.pnavais.machine.api.validator.ValidationResult
valueOf(String) - Static method in enum com.github.pnavais.machine.api.message.Event: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.pnavais.machine.api.validator.TransitionValidator.FailurePolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.pnavais.machine.api.validator.TransitionValidator.Operation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.pnavais.machine.exporter.DOTExporter.RankDir: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.pnavais.machine.exporter.YAMLExporter.MarginSize: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.pnavais.machine.api.message.Event: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.pnavais.machine.api.validator.TransitionValidator.FailurePolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.pnavais.machine.api.validator.TransitionValidator.Operation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.pnavais.machine.exporter.DOTExporter.RankDir: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.pnavais.machine.exporter.YAMLExporter.MarginSize: Returns an array containing the constants of this enum type, in the order they are declared.
VoidMessage - Class in com.github.pnavais.machine.api.message: Represents an empty/null message

Y

YAMLExporter - Class in com.github.pnavais.machine.exporter: An exporter allowing to translate a given state machine representation (States and transitions) to YAML.
YAMLExporter(FileSystem, String, Color, boolean, boolean, Color, YAMLExporter.MarginSize) - Constructor for class com.github.pnavais.machine.exporter.YAMLExporter: All arguments constructor
YAMLExporter.MarginSize - Enum in com.github.pnavais.machine.exporter: The margin spacing options (2 or 4 spaces)
YAMLImporter - Class in com.github.pnavais.machine.importer: An importer allowing to parse a given state machine YAML representation (States and transitions) into an actual State machine.
YAMLImporter() - Constructor for class com.github.pnavais.machine.importer.YAMLImporter
YAMLParseException - Exception in com.github.pnavais.machine.api.exception: Exception raised during parsing of a given YAML State Machine representation.
YAMLParseException(String) - Constructor for exception com.github.pnavais.machine.api.exception.YAMLParseException: Constructor with description message.

A B C D E F G H I L M N O P R S T U V Y