Package com.fizzed.rocker.maven

Class GenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.fizzed.rocker.maven.GenerateMojo

All Implemented Interfaces:

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

@Mojo(name="generate",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE)
public class GenerateMojo
extends org.apache.maven.plugin.AbstractMojo

Maven plugin for parsing Rocker templates and generating Java source code.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addAsSources
protected boolean	addAsTestSources
protected File	classDirectory	Directory where classes are compiled to (for placing rocker config file).
protected Boolean	discardLogicWhitespace
protected String	extendsClass
protected String	extendsModelClass
protected boolean	failOnError
protected String	javaVersion
protected Boolean	markAsGenerated	Weather or not to mark the generated classes as @Generated.
protected Boolean	optimize
protected File	outputDirectory	Directory to output generated Java source files.
protected PlainTextStrategy	plainTextStrategy
protected String[]	postProcessing
protected org.apache.maven.project.MavenProject	project
private boolean	skip
protected boolean	skipTouch
protected String	suffixRegex
protected String	targetCharset
protected File	templateDirectory	Directory containing templates.
protected String	touchFile

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

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

Field Details

skip

@Parameter(property="rocker.skip",
           defaultValue="false")
private boolean skip

failOnError

@Parameter(property="rocker.failOnError",
           defaultValue="true")
protected boolean failOnError

skipTouch

@Parameter(property="rocker.skipTouch",
           defaultValue="false")
protected boolean skipTouch

touchFile

@Parameter(property="rocker.touchFile",
           defaultValue="${basedir}/pom.xml")
protected String touchFile

addAsSources

@Parameter(property="rocker.addAsSources",
           defaultValue="true")
protected boolean addAsSources

addAsTestSources

@Parameter(property="rocker.addAsTestSources",
           defaultValue="false")
protected boolean addAsTestSources

javaVersion

@Parameter(property="rocker.javaVersion")
protected String javaVersion

extendsClass

@Parameter(property="rocker.extendsClass")
protected String extendsClass

extendsModelClass

@Parameter(property="rocker.extendsModelClass")
protected String extendsModelClass

optimize

@Parameter(property="rocker.optimize")
protected Boolean optimize

discardLogicWhitespace

@Parameter(property="rocker.discardLogicWhitespace")
protected Boolean discardLogicWhitespace

targetCharset

@Parameter(property="rocker.targetCharset")
protected String targetCharset

suffixRegex

@Parameter(property="rocker.suffixRegex")
protected String suffixRegex

templateDirectory

@Parameter(property="rocker.templateDirectory",
           defaultValue="${project.build.sourceDirectory}")
protected File templateDirectory

Directory containing templates. The base directory to search -- which is also how their "package" name is determined.

outputDirectory

@Parameter(property="rocker.outputDirectory",
           defaultValue="${project.build.directory}/generated-sources/rocker",
           required=true)
protected File outputDirectory

Directory to output generated Java source files.

classDirectory

@Parameter(property="rocker.classDirectory",
           defaultValue="${project.build.outputDirectory}",
           required=true)
protected File classDirectory

Directory where classes are compiled to (for placing rocker config file).

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

postProcessing

@Parameter(property="rocker.postProcessing",
           required=false)
protected String[] postProcessing

plainTextStrategy

@Parameter(property=" rocker.plainTextStrategy",
           required=false,
           defaultValue="STATIC_BYTE_ARRAYS_VIA_UNLOADED_CLASS")
protected PlainTextStrategy plainTextStrategy

markAsGenerated

@Parameter(property="rocker.markAsGenerated")
protected Boolean markAsGenerated

Weather or not to mark the generated classes as @Generated.

Constructor Details

GenerateMojo

public GenerateMojo()

Method Details

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException