org.codehaus.mojo.javacc
Class JTBMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.javacc.AbstractPreprocessorMojo
          org.codehaus.mojo.javacc.JTBMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Deprecated. As of version 2.4, use the jtb-javacc goal instead.

public class JTBMojo
extends AbstractPreprocessorMojo

Parses a JTB file and transforms it into source files for an AST and a JavaCC grammar file which automatically builds the AST.

Note: JTB requires Java 1.5 or higher. This goal will not work with earlier versions of the JRE.

Since:

2.2

Version:

$Id: JTBMojo.java 7008 2008-05-18 10:29:21Z bentmann $

Author:

Gregory Kick (gk5885@kickstyle.net)

Is defined by the goal name:

jtb

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

JTBMojo()
Deprecated.

Method Summary

protected String[]	getExcludes() Deprecated. Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.
protected String[]	getIncludes() Deprecated. Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.
protected File	getOutputDirectory() Deprecated. Gets the absolute path to the directory where the generated Java files for the parser will be stored.
protected File	getSourceDirectory() Deprecated. Gets the absolute path to the directory where the grammar files are located.
protected int	getStaleMillis() Deprecated. Gets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
protected File	getTimestampDirectory() Deprecated. Gets the absolute path to the directory where the processed input files will be stored for later detection of stale sources.
protected void	processGrammar(org.codehaus.mojo.javacc.GrammarInfo grammarInfo) Deprecated. Passes the specified grammar file through the tool.

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

addCompileSourceRoot, createTimestamp, 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

Constructor Detail

JTBMojo

public JTBMojo()

Deprecated.

Method Detail

getSourceDirectory

protected File getSourceDirectory()

Deprecated.

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

Specified by:

getSourceDirectory in class AbstractPreprocessorMojo

Returns:

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

getIncludes

protected String[] getIncludes()

Deprecated.

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

Specified by:

getIncludes in class AbstractPreprocessorMojo

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()

Deprecated.

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

Specified by:

getExcludes in class AbstractPreprocessorMojo

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()

Deprecated.

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

Specified by:

getOutputDirectory in class AbstractPreprocessorMojo

Returns:

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

getTimestampDirectory

protected File getTimestampDirectory()

Deprecated.

Gets the absolute path to the directory where the processed input files will be stored for later detection of stale sources.

Specified by:

getTimestampDirectory in class AbstractPreprocessorMojo

Returns:

The absolute path to the directory where the processed input files will be stored for later detection of stale sources, never null.

getStaleMillis

protected int getStaleMillis()

Deprecated.

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

Specified by:

getStaleMillis in class AbstractPreprocessorMojo

Returns:

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

processGrammar

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

Deprecated.

Passes the specified grammar file through the tool.

Specified by:

processGrammar in class AbstractPreprocessorMojo

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.