de.scravy.machina

Class StateMachines

java.lang.Object

de.scravy.machina.StateMachines

public final class StateMachines
extends Object

Static utility methods for dealing with state machines.

Since:

1.0.0

Author:

Julian Fleischer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateMachines.OutputFormat Enumeration of output formats for serializing state machine definitions.

Method Summary

Modifier and Type	Method and Description
static <T> Set<T>	getEventsTypesFrom(StateMachine<?,?,T> fsm)
static <S> Set<S>	getStatesFrom(StateMachine<S,?,?> fsm)
static <S,T> Map<S,Map<T,S>>	getStatesMap()
static <T> Set<T>	getUnusedEventTypes()
static <S> Set<S>	getUnusuedStates()
static <S,T> void	toFile(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, File file) Serialize a given state machine definition as a file.
static <S,T> void	toFile(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, String filePath) Serialize a given state machine definition as a file.
static <S,T> void	toPath(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, Path filePath) Serialize a given state machine definition as a file.
static <S,T> void	toStream(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, OutputStream stream) Serialize a given state machine definition to a stream.
static <S,T> String	toString(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format) Serialize a given StateMachine definition to a String.
static <S,T> StringBuilder	toString(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, StringBuilder builder) Serialize a given StateMachine definition to a StringBuilder.
static <S,T> void	toWriter(StateMachine<S,?,T> fsm, StateMachines.OutputFormat format, Writer writer) Serialize a given state machine definition to a writer.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public static <S,T> String toString(StateMachine<S,?,T> fsm,
                                    StateMachines.OutputFormat format)

Serialize a given StateMachine definition to a String.

Parameters:

fsm - The state machine.

format - The format to use for serialization.

Returns:

A serialization in the given output format.

Since:

1.0.0

toString

public static <S,T> StringBuilder toString(StateMachine<S,?,T> fsm,
                                           StateMachines.OutputFormat format,
                                           StringBuilder builder)

Serialize a given StateMachine definition to a StringBuilder.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

builder - The StringBuilder to append the serialization to.

Returns:

That StringBuilder.

Since:

1.0.0

toFile

public static <S,T> void toFile(StateMachine<S,?,T> fsm,
                                StateMachines.OutputFormat format,
                                String filePath)

Serialize a given state machine definition as a file.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

filePath - The filepath where to write to.

Since:

1.0.0

toFile

public static <S,T> void toFile(StateMachine<S,?,T> fsm,
                                StateMachines.OutputFormat format,
                                File file)

Serialize a given state machine definition as a file.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

file - The file object representing that file.

Since:

1.0.0

toPath

public static <S,T> void toPath(StateMachine<S,?,T> fsm,
                                StateMachines.OutputFormat format,
                                Path filePath)

Serialize a given state machine definition as a file.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

filePath - The filepath where to write to.

Since:

1.0.0

toStream

public static <S,T> void toStream(StateMachine<S,?,T> fsm,
                                  StateMachines.OutputFormat format,
                                  OutputStream stream)

Serialize a given state machine definition to a stream.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

stream - The stream to append to.

Since:

1.0.0

toWriter

public static <S,T> void toWriter(StateMachine<S,?,T> fsm,
                                  StateMachines.OutputFormat format,
                                  Writer writer)

Serialize a given state machine definition to a writer.

Type Parameters:

S - State

T - Event Type

Parameters:

fsm - The state machine.

format - The format to use for serialization.

writer - The writer where to write to.

Since:

1.0.0

getStatesFrom

public static <S> Set<S> getStatesFrom(StateMachine<S,?,?> fsm)

Parameters:

fsm -

Since:

1.0.0

getUnusuedStates

public static <S> Set<S> getUnusuedStates()

Since:

1.3.0

getUnusedEventTypes

public static <T> Set<T> getUnusedEventTypes()

Since:

1.3.0

getStatesMap

public static <S,T> Map<S,Map<T,S>> getStatesMap()

Since:

1.3.0

getEventsTypesFrom

public static <T> Set<T> getEventsTypesFrom(StateMachine<?,?,T> fsm)

Parameters:

fsm -

Since:

1.0.0