com.github.pnavais.machine.exporter

Class YAMLExporter

java.lang.Object

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

com.github.pnavais.machine.exporter.YAMLExporter

All Implemented Interfaces:

Exporter<String,State,Message,StateMachine>

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

An exporter allowing to translate a given state machine representation (States and transitions) to YAML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YAMLExporter.MarginSize The margin spacing options (2 or 4 spaces)

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
YAMLExporter(FileSystem fileSystem, String graphName, Color finalStateColor, boolean useHSB, boolean showCurrent, Color currentStateColor, YAMLExporter.MarginSize marginSize) All arguments constructor

Method Summary

Modifier and Type	Method and Description
String	export(StateMachine stateMachine) Export the current contents of the state machine to YAML syntax.

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

YAMLExporter

public YAMLExporter(FileSystem fileSystem,
                    String graphName,
                    Color finalStateColor,
                    boolean useHSB,
                    boolean showCurrent,
                    Color currentStateColor,
                    YAMLExporter.MarginSize marginSize)

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

Method Detail

export

public String export(StateMachine stateMachine)

Export the current contents of the state machine to YAML syntax.

Parameters:

stateMachine - the state machine to export

Returns:

the string representation of the state machine in YAML.