org.codehaus.mojo.javacc
Class JavaCCMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.javacc.AbstractJavaCCMojo
          org.codehaus.mojo.javacc.JavaCCMojo

All Implemented Interfaces:

ContextEnabled, Mojo

public class JavaCCMojo

extends AbstractJavaCCMojo

Parses a JavaCC grammar file (*.jj) and transforms it to Java source files. Detailed information about the JavaCC options can be found on the JavaCC website.

Since:

2.0

Version:

$Id: JavaCCMojo.java 8156 2008-11-26 18:20:19Z bentmann $

Author:

jruiz@exist.com, jesse

Is defined by the goal name:

javacc

Is bound to the specified phase of the standard build lifecycle:

generate-sources

Field Summary

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

ROLE

Constructor Summary

JavaCCMojo()

Method Summary

protected File[]	getCompileSourceRoots() Gets all the output directories to register with the project for compilation.
protected String[]	getExcludes() Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.
protected String[]	getIncludes() Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.
protected File	getOutputDirectory() Gets the absolute path to the directory where the generated Java files for the parser will be stored.
protected String	getParserPackage() Gets the package into which the generated parser files should be stored.
protected File	getSourceDirectory() Gets the absolute path to the directory where the grammar files are located.
protected int	getStaleMillis() Gets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
protected void	processGrammar(org.codehaus.mojo.javacc.GrammarInfo grammarInfo) Passes the specified grammar file through the tool.

Methods inherited from class org.codehaus.mojo.javacc.AbstractJavaCCMojo

copyGrammarOutput, deleteTempDirectory, execute, getGrammarEncoding, getIsStatic, getJdkVersion, getTempDirectory, isSourceRoot, newJavaCC

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

JavaCCMojo

public JavaCCMojo()

Method Detail

getSourceDirectory

protected File getSourceDirectory()

Gets the absolute path to the directory where the grammar files are located.

Specified by:

getSourceDirectory in class AbstractJavaCCMojo

Returns:

The absolute path to the directory where the grammar files are located, never null.

getIncludes

protected String[] getIncludes()

Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.

Specified by:

getIncludes in class AbstractJavaCCMojo

Returns:

A set of Ant-like inclusion patterns used to select files from the source directory for processing, can be null if all files should be included.

getExcludes

protected String[] getExcludes()

Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.

Specified by:

getExcludes in class AbstractJavaCCMojo

Returns:

A set of Ant-like inclusion patterns used to unselect files from the source directory for processing, can be null if no files should be excluded.

getOutputDirectory

protected File getOutputDirectory()

Gets the absolute path to the directory where the generated Java files for the parser will be stored.

Specified by:

getOutputDirectory in class AbstractJavaCCMojo

Returns:

The absolute path to the directory where the generated Java files for the parser will be stored, never null.

getStaleMillis

protected int getStaleMillis()

Gets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.

Specified by:

getStaleMillis in class AbstractJavaCCMojo

Returns:

The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.

getCompileSourceRoots

protected File[] getCompileSourceRoots()

Gets all the output directories to register with the project for compilation.

Specified by:

getCompileSourceRoots in class AbstractJavaCCMojo

Returns:

The compile source roots to register with the project, never null.

getParserPackage

protected String getParserPackage()

Gets the package into which the generated parser files should be stored.

Overrides:

getParserPackage in class AbstractJavaCCMojo

Returns:

The package into which the generated parser files should be stored, can be null to use the package declaration from the grammar file.

processGrammar

protected void processGrammar(org.codehaus.mojo.javacc.GrammarInfo grammarInfo)
                       throws MojoExecutionException,
                              MojoFailureException

Passes the specified grammar file through the tool.

Specified by:

processGrammar in class AbstractJavaCCMojo

Parameters:

grammarInfo - The grammar info describing the grammar file to process, must not be null.

Throws:

MojoExecutionException - If the invocation of the tool failed.

MojoFailureException - If the tool reported a non-zero exit code.