net.sourceforge.anotherfsm.qfsm

Class Configuration

java.lang.Object

net.sourceforge.anotherfsm.qfsm.Configuration

 class Configuration
extends java.lang.Object

Configuration of code generation.

Author:

Michal Turek

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseClass The base state machine class.
private boolean	equalsPreprocessor Generate equals preprocessor.
private java.lang.String	fileHeader File header.
private java.lang.String	fsmFileSuffix The suffix of the file name.
private java.lang.String	fsmImports The imports for state machine class.
private boolean	globalStateListener Generate global state listener.
private boolean	globalTransitionListener Generate global transition listener.
private java.lang.String	javaPackage The Java package.
private java.lang.String	outputDirectory The output directory.
private java.lang.String	processorFileSuffix The suffix of the file name.
private java.lang.String	processorImports The imports for processor class.
private boolean	stateListener Generate state listener for each state.
private boolean	transitionDescriptionContainsCode Description of transitions contains Java code.
private boolean	transitionListener Generate transition listener for each transition.
private boolean	typePreprocessor Generate type preprocessor.
private java.lang.String	version The configuration version.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Configuration() Forbid creating objects.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseClass()
java.lang.String	getFileHeader()
java.lang.String	getFsmFileSuffix()
java.lang.String	getFsmImports()
java.lang.String	getJavaPackage()
java.lang.String	getOutputDirectory()
java.lang.String	getProcessorFileSuffix()
java.lang.String	getProcessorImports()
java.lang.String	getVersion()
boolean	isEqualsPreprocessor()
boolean	isGlobalStateListener()
boolean	isGlobalTransitionListener()
boolean	isStateListener()
boolean	isTransitionDescriptionContainsCode()
boolean	isTransitionListener()
boolean	isTypePreprocessor()
static Configuration	parse(java.io.File file) Parse a configuration file.
static Configuration	parse(java.lang.String path) Parse a configuration file.
private static Configuration	parseConfiguration(org.w3c.dom.Element configurationEl) Parse the XML content

Methods inherited from class java.lang.Object

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

Field Detail

version

private java.lang.String version

The configuration version.

outputDirectory

private java.lang.String outputDirectory

The output directory.

baseClass

private java.lang.String baseClass

The base state machine class.

javaPackage

private java.lang.String javaPackage

The Java package.

fsmFileSuffix

private java.lang.String fsmFileSuffix

The suffix of the file name.

fsmImports

private java.lang.String fsmImports

The imports for state machine class.

transitionDescriptionContainsCode

private boolean transitionDescriptionContainsCode

Description of transitions contains Java code.

typePreprocessor

private boolean typePreprocessor

Generate type preprocessor.

equalsPreprocessor

private boolean equalsPreprocessor

Generate equals preprocessor.

globalStateListener

private boolean globalStateListener

Generate global state listener.

globalTransitionListener

private boolean globalTransitionListener

Generate global transition listener.

stateListener

private boolean stateListener

Generate state listener for each state.

transitionListener

private boolean transitionListener

Generate transition listener for each transition.

processorFileSuffix

private java.lang.String processorFileSuffix

The suffix of the file name.

processorImports

private java.lang.String processorImports

The imports for processor class.

fileHeader

private java.lang.String fileHeader

File header.

Constructor Detail

Configuration

private Configuration()

Forbid creating objects.

Method Detail

getVersion

public java.lang.String getVersion()

getOutputDirectory

public java.lang.String getOutputDirectory()

getBaseClass

public java.lang.String getBaseClass()

getJavaPackage

public java.lang.String getJavaPackage()

getFsmImports

public java.lang.String getFsmImports()

isTypePreprocessor

public boolean isTypePreprocessor()

isEqualsPreprocessor

public boolean isEqualsPreprocessor()

isGlobalStateListener

public boolean isGlobalStateListener()

isGlobalTransitionListener

public boolean isGlobalTransitionListener()

isStateListener

public boolean isStateListener()

isTransitionListener

public boolean isTransitionListener()

getProcessorImports

public java.lang.String getProcessorImports()

getFileHeader

public java.lang.String getFileHeader()

isTransitionDescriptionContainsCode

public boolean isTransitionDescriptionContainsCode()

getFsmFileSuffix

public java.lang.String getFsmFileSuffix()

getProcessorFileSuffix

public java.lang.String getProcessorFileSuffix()

parse

public static Configuration parse(java.lang.String path)
                           throws QfsmException

Parse a configuration file.

Parameters:

path - the file system path

Returns:

the object representation of the configuration data file

Throws:

QfsmException - if parsing fails for any reason

See Also:

parse(File)

parse

public static Configuration parse(java.io.File file)
                           throws QfsmException

Parse a configuration file.

Parameters:

file - the input file

Returns:

the object representation of the configuration data file

Throws:

QfsmException - if parsing fails for any reason

parseConfiguration

private static Configuration parseConfiguration(org.w3c.dom.Element configurationEl)
                                         throws QfsmException

Parse the XML content

Parameters:

configurationEl - the top level element

Returns:

the configuration object

Throws:

QfsmException - if something fails