com.github.pnavais.machine.exporter

Class DOTExporter

java.lang.Object

com.github.pnavais.machine.exporter.AbstractStatesExporter<String,State,Message,StateMachine>

com.github.pnavais.machine.exporter.DOTExporter

All Implemented Interfaces:

Exporter<String,State,Message,StateMachine>

public class DOTExporter
extends AbstractStatesExporter<String,State,Message,StateMachine>

An exporter allowing to translate a given state machine to the GraphViz DOT language (@see https://www.graphviz.org/doc/info/lang.html)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DOTExporter.RankDir The possible Rank direction of the grapth

Field Summary

Fields inherited from class com.github.pnavais.machine.exporter.AbstractStatesExporter

currentStateColor, DEFAULT_CURRENT_COLOR, DEFAULT_FINAL_COLOR, fileSystem, finalStateColor, graphName, NL, showCurrent, TB, useHSB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	export(@NonNull StateMachine stateMachine) Export the current contents of the state machine to the DOT language.

Methods inherited from class com.github.pnavais.machine.exporter.AbstractStatesExporter

exportToFile, exportToFile, fillDefaults

Methods inherited from class java.lang.Object

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

Constructor Detail

DOTExporter

public DOTExporter(FileSystem fileSystem,
                   String graphName,
                   Color finalStateColor,
                   boolean useHSB,
                   boolean showCurrent,
                   Color currentStateColor,
                   DOTExporter.RankDir rankDir)

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

rankDir - the graph direction

Method Detail

export

public String export(@NonNull
                     @NonNull StateMachine stateMachine)

Export the current contents of the state machine to the DOT language.

Parameters:

stateMachine - the state machine to export

Returns:

the string representation of the state machine in DOT language.