com.github.pnavais.machine.exporter

Class AbstractStatesExporter<R,S extends State,M extends Message,T extends Transitioner<S,M,? extends Transition<S,M>>>

java.lang.Object

com.github.pnavais.machine.exporter.AbstractStatesExporter<R,S,M,T>

All Implemented Interfaces:

Exporter<R,S,M,T>

Direct Known Subclasses:

DOTExporter, YAMLExporter

public abstract class AbstractStatesExporter<R,S extends State,M extends Message,T extends Transitioner<S,M,? extends Transition<S,M>>>
extends Object
implements Exporter<R,S,M,T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	currentStateColor The color for final states
static String	DEFAULT_CURRENT_COLOR The default color for current state
static String	DEFAULT_FINAL_COLOR The default color for final states
protected FileSystem	fileSystem The file system to use when locating paths
protected Color	finalStateColor The color for final states
protected String	graphName The name of the graph
protected static String	NL The system's new line character
protected boolean	showCurrent Show current status in different color
protected static char	TB The tabulator character
protected boolean	useHSB Use HSB colors in the output format.

Constructor Summary

Constructors

Constructor and Description
AbstractStatesExporter() No arguments constructor.
AbstractStatesExporter(FileSystem fileSystem, String graphName, Color finalStateColor, boolean useHSB, boolean showCurrent, Color currentStateColor) All arguments constructor

Method Summary

Modifier and Type	Method and Description
void	exportToFile(T transitioner, @NonNull Path outputFile) Export the current contents of the transitioner to the DOT language to the given file path.
void	exportToFile(T transitioner, @NonNull String outputFile) Export the current contents of the transitioner to the DOT language to the given file path.
protected void	fillDefaults() Fills default values for all non-primitive types

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.pnavais.machine.api.exporter.Exporter

export

Field Detail

DEFAULT_FINAL_COLOR

public static final String DEFAULT_FINAL_COLOR

The default color for final states

See Also:

Constant Field Values

DEFAULT_CURRENT_COLOR

public static final String DEFAULT_CURRENT_COLOR

The default color for current state

See Also:

Constant Field Values

NL

protected static final String NL

The system's new line character

TB

protected static final char TB

The tabulator character

See Also:

Constant Field Values

fileSystem

protected FileSystem fileSystem

The file system to use when locating paths

graphName

protected String graphName

The name of the graph

finalStateColor

protected Color finalStateColor

The color for final states

useHSB

protected boolean useHSB

Use HSB colors in the output format. (Defaults to RGB)

showCurrent

protected boolean showCurrent

Show current status in different color

currentStateColor

protected Color currentStateColor

The color for final states

Constructor Detail

AbstractStatesExporter

public AbstractStatesExporter(FileSystem fileSystem,
                              String graphName,
                              Color finalStateColor,
                              boolean useHSB,
                              boolean showCurrent,
                              Color currentStateColor)

All arguments constructor

Parameters:

fileSystem - the filesystem

graphName - the graph name

finalStateColor - the final state color

useHSB - the flag to control exporting using HSB color format

showCurrent - the flag to control annotating current status

currentStateColor - the current state color

AbstractStatesExporter

public AbstractStatesExporter()

No arguments constructor. Using default values

Method Detail

fillDefaults

protected void fillDefaults()

Fills default values for all non-primitive types

exportToFile

public void exportToFile(@NonNull
                         T transitioner,
                         @NonNull
                         @NonNull String outputFile)

Export the current contents of the transitioner to the DOT language to the given file path.

Parameters:

transitioner - the state machine to export

outputFile - the output file path

exportToFile

public void exportToFile(@NonNull
                         T transitioner,
                         @NonNull
                         @NonNull Path outputFile)

Export the current contents of the transitioner to the DOT language to the given file path.

Specified by:

exportToFile in interface Exporter<R,S extends State,M extends Message,T extends Transitioner<S,M,? extends Transition<S,M>>>

Parameters:

transitioner - the transitioner to export

outputFile - the output file path