Package org.codehaus.mojo.javacc
Class JJTreeMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.codehaus.mojo.javacc.AbstractPreprocessorMojo
-
- org.codehaus.mojo.javacc.JJTreeMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
public class JJTreeMojo extends AbstractPreprocessorMojo
Deprecated.As of version 2.4, use thejjtree-javacc
goal instead.Parses a JJTree grammar file (*.jjt
) and transforms it to Java source files and a JavaCC grammar file. Please see the JJTree Reference Documentation for more information.- Since:
- 2.0
- Version:
- $Id: JJTreeMojo.java 7847 2008-10-05 17:52:15Z bentmann $
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Boolean
buildNodeFiles
Deprecated.A flag whether to generate sample implementations forSimpleNode
and any other nodes used in the grammar.private java.lang.String[]
excludes
Deprecated.A set of Ant-like exclusion patterns used to prevent certain files from being processed.private java.lang.String[]
includes
Deprecated.A set of Ant-like inclusion patterns used to select files from the source directory for processing.private java.lang.Boolean
isStatic
Deprecated.A flag whether to generate code for a static parser.private java.lang.String
jdkVersion
Deprecated.The Java version for which to generate source code.private java.lang.Boolean
multi
Deprecated.A flag whether to generate a multi mode parse tree or a single mode parse tree.private java.lang.String
nodeClass
Deprecated.The name of a custom class that extendsSimpleNode
and will be used as the super class for the generated tree node classes.private java.lang.Boolean
nodeDefaultVoid
Deprecated.A flag whether to make each non-decorated production void instead of an indefinite node.private java.lang.String
nodeFactory
Deprecated.The name of a custom factory class used to createNode
objects.private java.lang.String
nodePackage
Deprecated.The package to generate the AST node classes into.private java.lang.String
nodePrefix
Deprecated.The prefix used to construct node class names from node identifiers in multi mode.private java.lang.Boolean
nodeScopeHook
Deprecated.A flag whether user-defined parser methods should be called on entry and exit of every node scope.private java.lang.Boolean
nodeUsesParser
Deprecated.A flag whether the node construction routines need an additional method parameter to receive the parser object.private java.io.File
outputDirectory
Deprecated.Directory where the output Java files for the node classes and the JavaCC grammar file will be located.private java.io.File
sourceDirectory
Deprecated.Directory where the input JJTree files (*.jjt
) are located.private int
staleMillis
Deprecated.The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.private java.io.File
timestampDirectory
Deprecated.The directory to store the processed input files for later detection of stale sources.private java.lang.Boolean
trackTokens
Deprecated.A flag whether to insert the methodsjjtGetFirstToken()
,jjtSetFirstToken()
,getLastToken()
andjjtSetLastToken()
into the classSimpleNode
.private java.lang.Boolean
visitor
Deprecated.A flag whether to insert ajjtAccept()
method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar.private java.lang.String
visitorDataType
Deprecated.The name of a class to use for the data argument of thejjtAccept()
andvisit()
methods.private java.lang.String
visitorException
Deprecated.The name of an exception class to include in the signature of the generatedjjtAccept()
andvisit()
methods.private java.lang.String
visitorReturnType
Deprecated.The name of a class to use as the return type of thejjtAccept()
andvisit()
methods.
-
Constructor Summary
Constructors Constructor Description JJTreeMojo()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addCompileSourceRoot()
Deprecated.Prevents registration of our output or a following invocation of the javacc mojo will cause duplicate sources which in turn will make compilation fail.protected java.lang.String[]
getExcludes()
Deprecated.Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing.protected java.lang.String[]
getIncludes()
Deprecated.Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing.protected java.io.File
getOutputDirectory()
Deprecated.Gets the absolute path to the directory where the generated Java files for the parser will be stored.protected java.io.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 java.io.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 JJTree
newJJTree()
Deprecated.Creates a new facade to invoke JJTree.protected void
processGrammar(GrammarInfo grammarInfo)
Deprecated.Passes the specified grammar file through the tool.-
Methods inherited from class org.codehaus.mojo.javacc.AbstractPreprocessorMojo
createTimestamp, execute
-
-
-
-
Field Detail
-
jdkVersion
private java.lang.String jdkVersion
Deprecated.The Java version for which to generate source code. Default value is1.4
.- Since:
- 2.4
-
buildNodeFiles
private java.lang.Boolean buildNodeFiles
Deprecated.A flag whether to generate sample implementations forSimpleNode
and any other nodes used in the grammar. Default value istrue
.
-
multi
private java.lang.Boolean multi
Deprecated.A flag whether to generate a multi mode parse tree or a single mode parse tree. Default value isfalse
.
-
nodeDefaultVoid
private java.lang.Boolean nodeDefaultVoid
Deprecated.A flag whether to make each non-decorated production void instead of an indefinite node. Default value isfalse
.
-
nodeClass
private java.lang.String nodeClass
Deprecated.The name of a custom class that extendsSimpleNode
and will be used as the super class for the generated tree node classes. By default, the tree node classes will directly extend the classSimpleNode
.- Since:
- 2.5
-
nodeFactory
private java.lang.String nodeFactory
Deprecated.The name of a custom factory class used to createNode
objects. This class must have a method with the signaturepublic static Node jjtCreate(int id)
. By default, the classSimpleNode
will be used as the factory class.
-
nodePackage
private java.lang.String nodePackage
Deprecated.The package to generate the AST node classes into. 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
. By default, the package of the corresponding parser is used.
-
nodePrefix
private java.lang.String nodePrefix
Deprecated.The prefix used to construct node class names from node identifiers in multi mode. Default value isAST
.
-
nodeScopeHook
private java.lang.Boolean nodeScopeHook
Deprecated.A flag whether user-defined parser methods should be called on entry and exit of every node scope. Default value isfalse
.
-
nodeUsesParser
private java.lang.Boolean nodeUsesParser
Deprecated.A flag whether the node construction routines need an additional method parameter to receive the parser object. Default value isfalse
.
-
isStatic
private java.lang.Boolean isStatic
Deprecated.A flag whether to generate code for a static parser. Note that this setting must match the corresponding option for thejavacc
mojo. Default value istrue
.
-
trackTokens
private java.lang.Boolean trackTokens
Deprecated.A flag whether to insert the methodsjjtGetFirstToken()
,jjtSetFirstToken()
,getLastToken()
andjjtSetLastToken()
into the classSimpleNode
. Default value isfalse
.- Since:
- 2.5
-
visitor
private java.lang.Boolean visitor
Deprecated.A flag whether to insert ajjtAccept()
method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar. Default value isfalse
.
-
visitorDataType
private java.lang.String visitorDataType
Deprecated.The name of a class to use for the data argument of thejjtAccept()
andvisit()
methods. Default value isjava.lang.Object
.- Since:
- 2.5
-
visitorReturnType
private java.lang.String visitorReturnType
Deprecated.The name of a class to use as the return type of thejjtAccept()
andvisit()
methods. Default value isjava.lang.Object
.- Since:
- 2.5
-
visitorException
private java.lang.String visitorException
Deprecated.The name of an exception class to include in the signature of the generatedjjtAccept()
andvisit()
methods. By default, thethrows
clause of the generated methods is empty such that only unchecked exceptions can be thrown.
-
sourceDirectory
private java.io.File sourceDirectory
Deprecated.Directory where the input JJTree files (*.jjt
) are located.
-
outputDirectory
private java.io.File outputDirectory
Deprecated.Directory where the output Java files for the node classes and the JavaCC grammar file will be located.
-
timestampDirectory
private java.io.File timestampDirectory
Deprecated.The directory to store the processed input files for later detection of stale sources.
-
staleMillis
private int staleMillis
Deprecated.The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
-
includes
private java.lang.String[] includes
Deprecated.A set of Ant-like inclusion patterns used to select files from the source directory for processing. By default, the patterns**/*.jjt
and**/*.JJT
are used to select grammar files.
-
excludes
private java.lang.String[] 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.
-
-
Method Detail
-
getSourceDirectory
protected java.io.File 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
protected java.lang.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 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
protected java.lang.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 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
protected java.io.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 classAbstractPreprocessorMojo
- Returns:
- The absolute path to the directory where the generated Java files for the parser will be stored, never
null
.
-
getTimestampDirectory
protected java.io.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 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.
-
newJJTree
protected JJTree newJJTree()
Deprecated.Creates a new facade to invoke JJTree. 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 directory and package on the returned facade.- Returns:
- The facade for the tool invocation, never
null
.
-
addCompileSourceRoot
protected void addCompileSourceRoot()
Deprecated.Prevents registration of our output or a following invocation of the javacc mojo will cause duplicate sources which in turn will make compilation fail.- Overrides:
addCompileSourceRoot
in classAbstractPreprocessorMojo
-
-