Package 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:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="jtb",
defaultPhase=GENERATE_SOURCES,
threadSafe=true)
public class JTBMojo
extends AbstractPreprocessorMojo
Deprecated.
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Boolean
Deprecated.Setting this option totrue
causes JTB to generate field names that reflect the structure of the tree instead of generic names likef0
,f1
etc.private String[]
Deprecated.A set of Ant-like exclusion patterns used to prevent certain files from being processed.private String[]
Deprecated.A set of Ant-like inclusion patterns used to select files from the source directory for processing.private Boolean
Deprecated.Iftrue
, all generated comments will be wrapped in<pre>
tags so that they are formatted correctly in API docs.private String
Deprecated.This option specifies the package for the generated AST nodes.private String
Deprecated.The qualified name of a user-defined class from which all AST nodes will inherit.private File
Deprecated.The directory where the output Java files will be located.private String
Deprecated.This option is short fornodePackageName
=<packageName>.syntaxtree
andvisitorPackageName
=<packageName>.visitor
.private Boolean
Deprecated.Iftrue
, all nodes will contain fields for its parent node.private Boolean
Deprecated.Iftrue
, JTB will generate a syntax tree dumping visitor.private Boolean
Deprecated.Iftrue
, JTB will generate the following files to support the Schema programming language: Scheme records representing the grammar. A Scheme tree building visitor. Default value isfalse
.private File
Deprecated.The directory where the JavaCC grammar files (*.jtb
) are located.private Boolean
Deprecated.Iftrue
, JTB will include JavaCC "special tokens" in the AST.private int
Deprecated.The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.private Boolean
Deprecated.Iftrue
, JTB will suppress its semantic error checking.private File
Deprecated.The directory to store the processed input files for later detection of stale sources.private String
Deprecated.This option specifies the package for the generated visitors.Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String[]
Deprecated.Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.protected String[]
Deprecated.Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.private String
Deprecated.Gets the effective package name for the AST node files.protected File
Deprecated.Gets the absolute path to the directory where the generated Java files for the parser will be stored.protected File
Deprecated.Gets the absolute path to the directory where the grammar files are located.protected int
Deprecated.Gets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.protected File
Deprecated.Gets the absolute path to the directory where the processed input files will be stored for later detection of stale sources.private String
Deprecated.Gets the effective package name for the visitor files.private JTB
newJTB()
Deprecated.Creates a new facade to invoke JTB.protected void
processGrammar
(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
-
Field Details
-
packageName
Deprecated.This option is short fornodePackageName
=<packageName>.syntaxtree
andvisitorPackageName
=<packageName>.visitor
. Note that this option takes precedence overnodePackageName
andvisitorPackageName
if specified. -
nodePackageName
Deprecated.This option specifies the package for the generated AST nodes. This value may use a leading asterisk to reference the package of the corresponding parser. For example, if the parser package isorg.apache
and this parameter is set to*.demo
, the tree node classes will be located in the packageorg.apache.demo
. Default value is*.syntaxtree
. -
visitorPackageName
Deprecated.This option specifies the package for the generated visitors. This value may use a leading asterisk to reference the package of the corresponding parser. For example, if the parser package isorg.apache
and this parameter is set to*.demo
, the visitor classes will be located in the packageorg.apache.demo
. Default value is*.visitor
. -
supressErrorChecking
Deprecated.Iftrue
, JTB will suppress its semantic error checking. Default value isfalse
. -
javadocFriendlyComments
Deprecated.Iftrue
, all generated comments will be wrapped in<pre>
tags so that they are formatted correctly in API docs. Default value isfalse
. -
descriptiveFieldNames
Deprecated.Setting this option totrue
causes JTB to generate field names that reflect the structure of the tree instead of generic names likef0
,f1
etc. Default value isfalse
. -
nodeParentClass
Deprecated.The qualified name of a user-defined class from which all AST nodes will inherit. By default, AST nodes will inherit from the generated classNode
. -
parentPointers
Deprecated.Iftrue
, all nodes will contain fields for its parent node. Default value isfalse
. -
specialTokens
Deprecated.Iftrue
, JTB will include JavaCC "special tokens" in the AST. Default value isfalse
. -
scheme
Deprecated.Iftrue
, JTB will generate the following files to support the Schema programming language:- Scheme records representing the grammar.
- A Scheme tree building visitor.
false
. -
printer
Deprecated.Iftrue
, JTB will generate a syntax tree dumping visitor. Default value isfalse
. -
sourceDirectory
@Parameter(property="javacc.sourceDirectory", defaultValue="${basedir}/src/main/jtb") private File sourceDirectoryDeprecated.The directory where the JavaCC grammar files (*.jtb
) are located. It will be recursively scanned for input files to pass to JTB. -
outputDirectory
@Parameter(property="javacc.outputDirectory", defaultValue="${project.build.directory}/generated-sources/jtb") private File outputDirectoryDeprecated.The directory where the output Java files will be located. -
timestampDirectory
@Parameter(property="javacc.timestampDirectory", defaultValue="${project.build.directory}/generated-sources/jtb-timestamp") private File timestampDirectoryDeprecated.The directory to store the processed input files for later detection of stale sources. -
staleMillis
@Parameter(property="javacc.lastModGranularityMs", defaultValue="0") private int staleMillisDeprecated.The granularity in milliseconds of the last modification date for testing whether a source needs recompilation. -
includes
Deprecated.A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default, the patterns**/*.jtb
and**/*.JTB
are used to select grammar files. -
excludes
Deprecated.A set of Ant-like exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.
-
-
Constructor Details
-
JTBMojo
public JTBMojo()Deprecated.
-
-
Method Details
-
getSourceDirectory
Deprecated.Gets the absolute path to the directory where the grammar files are located.- Specified by:
getSourceDirectory
in classAbstractPreprocessorMojo
- Returns:
- The absolute path to the directory where the grammar files are located, never
null
.
-
getIncludes
Deprecated.Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.- Specified by:
getIncludes
in classAbstractPreprocessorMojo
- 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
Deprecated.Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.- Specified by:
getExcludes
in classAbstractPreprocessorMojo
- 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
Deprecated.Gets the absolute path to the directory where the generated Java files for the parser will be stored.- Specified by:
getOutputDirectory
in classAbstractPreprocessorMojo
- Returns:
- The absolute path to the directory where the generated Java files for the parser will be stored, never
null
.
-
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 classAbstractPreprocessorMojo
- 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 classAbstractPreprocessorMojo
- Returns:
- The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
-
processGrammar
protected void processGrammar(GrammarInfo grammarInfo) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Deprecated.Passes the specified grammar file through the tool.- Specified by:
processGrammar
in classAbstractPreprocessorMojo
- Parameters:
grammarInfo
- The grammar info describing the grammar file to process, must not benull
.- Throws:
org.apache.maven.plugin.MojoExecutionException
- If the invocation of the tool failed.org.apache.maven.plugin.MojoFailureException
- If the tool reported a non-zero exit code.
-
getNodePackageName
Deprecated.Gets the effective package name for the AST node files.- Returns:
- The effective package name for the AST node files, never
null
.
-
getVisitorPackageName
Deprecated.Gets the effective package name for the visitor files.- Returns:
- The effective package name for the visitor files, never
null
.
-
newJTB
Deprecated.Creates a new facade to invoke JTB. Most options for the invocation are derived from the current values of the corresponding mojo parameters. The caller is responsible to set the input file, output directories and packages on the returned facade.- Returns:
- The facade for the tool invocation, never
null
.
-
jtb-javacc
goal instead.