org.quickfixj.codegenerator

Class GenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.quickfixj.codegenerator.GenerateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class GenerateMojo
extends org.apache.maven.plugin.AbstractMojo

A mojo that uses the quickfix code generator to generate Java source files from a QuickFIX Dictionary.

Author:

Claudio Bantaloukas

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
File	getDictFile() Returns the dictionary file for which code generation should be executed.
String	getFieldPackage() Returns the default package to be used during field code generation.
File	getOutputDirectory() Returns the destination directory to used during code generation.
String	getPackaging() Returns the default package to be used during code generation.
org.apache.maven.project.MavenProject	getProject() Returns the MavenProject instance for which code generation should be executed.
File	getSchemaDirectory() Returns the directory containing schemas for code generation.
String	getUtcTimestampPrecision() Returns the default UtcTimestampPrecision to be used during field code generation.
boolean	isDecimal() Returns if BigDecimal has been enabled.
boolean	isOrderedFields() Returns if ordered fields have been enabled.
void	setDecimal(boolean decimal) Enables BigDecimal usage during code generation.
void	setDictFile(File dictFile) Sets the dictionary file for which code generation should be executed.
void	setFieldPackage(String fieldPackage) Sets the default package to be used during field code generation.
void	setOrderedFields(boolean orderedFields) Sets the ordered fields flag.
void	setOutputDirectory(File outputDirectory) Sets the destination directory to used during code generation.
void	setPackaging(String packaging) Sets the default package to be used during code generation.
void	setProject(org.apache.maven.project.MavenProject project) Sets the MavenProject instance for which code generation should be executed.
void	setSchemaDirectory(File schemaDirectory) Sets the directory containing schemas for code generation.
void	setUtcTimestampPrecision(String utcTimestampPrecision) Sets the default UtcTimestampPrecision to be used during field code generation.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateMojo

public GenerateMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

Mojo.execute()

getOutputDirectory

public File getOutputDirectory()

Returns the destination directory to used during code generation.

Returns:

the destination directory to used during code generation.

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

Sets the destination directory to used during code generation.

Parameters:

outputDirectory - the destination directory to used during code generation.

getPackaging

public String getPackaging()

Returns the default package to be used during code generation.

Returns:

the default package to be used during code generation.

setPackaging

public void setPackaging(String packaging)

Sets the default package to be used during code generation.

Parameters:

packaging - the default package to be used during code generation.

getProject

public org.apache.maven.project.MavenProject getProject()

Returns the MavenProject instance for which code generation should be executed.

Returns:

the MavenProject instance for which code generation should be executed.

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Sets the MavenProject instance for which code generation should be executed.

Parameters:

project - the MavenProject instance for which code generation should be executed.

getDictFile

public File getDictFile()

Returns the dictionary file for which code generation should be executed.

Returns:

the dictionary file for which code generation should be executed.

setDictFile

public void setDictFile(File dictFile)

Sets the dictionary file for which code generation should be executed.

Parameters:

dictFile - the dictionary file for which code generation should be executed.

getSchemaDirectory

public File getSchemaDirectory()

Returns the directory containing schemas for code generation.

Returns:

the directory containing schemas for code generation.

setSchemaDirectory

public void setSchemaDirectory(File schemaDirectory)

Sets the directory containing schemas for code generation.

Parameters:

schemaDirectory - the directory containing schemas for code generation.

isDecimal

public boolean isDecimal()

Returns if BigDecimal has been enabled.

Returns:

true if BigDecimal has been enabled; otherwise will use double.

setDecimal

public void setDecimal(boolean decimal)

Enables BigDecimal usage during code generation.

Parameters:

decimal - if true, then enables BigDecimal generation; otherwise uses double

isOrderedFields

public boolean isOrderedFields()

Returns if ordered fields have been enabled.

Returns:

true if ordered fields have been enabled; false otherwise.

setOrderedFields

public void setOrderedFields(boolean orderedFields)

Sets the ordered fields flag.

Parameters:

orderedFields - if true, then ordered fields is enabled.

getFieldPackage

public String getFieldPackage()

Returns the default package to be used during field code generation.

Returns:

the default package to be used during field code generation.

setFieldPackage

public void setFieldPackage(String fieldPackage)

Sets the default package to be used during field code generation.

Parameters:

fieldPackage - the default package to be used during field code generation.

getUtcTimestampPrecision

public String getUtcTimestampPrecision()

Returns the default UtcTimestampPrecision to be used during field code generation.

Returns:

the default UtcTimestampPrecision to be used during field code generation.

setUtcTimestampPrecision

public void setUtcTimestampPrecision(String utcTimestampPrecision)

Sets the default UtcTimestampPrecision to be used during field code generation.

Parameters:

utcTimestampPrecision - the default UtcTimestampPrecision to be used during field code generation.