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

@Mojo(name="jjtree", defaultPhase=GENERATE_SOURCES) public class JJTreeMojo extends AbstractPreprocessorMojo
Deprecated.
As of version 2.4, use the jjtree-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
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private Boolean
    Deprecated.
    A flag whether to generate sample implementations for SimpleNode and any other nodes used in the grammar.
    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.
    A flag whether to generate code for a static parser.
    private String
    Deprecated.
    The Java version for which to generate source code.
    private Boolean
    Deprecated.
    A flag whether to generate a multi mode parse tree or a single mode parse tree.
    private String
    Deprecated.
    The name of a custom class that extends SimpleNode and will be used as the super class for the generated tree node classes.
    private Boolean
    Deprecated.
    A flag whether to make each non-decorated production void instead of an indefinite node.
    private String
    Deprecated.
    The name of a custom factory class used to create Node objects.
    private String
    Deprecated.
    The package to generate the AST node classes into.
    private String
    Deprecated.
    The prefix used to construct node class names from node identifiers in multi mode.
    private Boolean
    Deprecated.
    A flag whether user-defined parser methods should be called on entry and exit of every node scope.
    private Boolean
    Deprecated.
    A flag whether the node construction routines need an additional method parameter to receive the parser object.
    private File
    Deprecated.
    Directory where the output Java files for the node classes and the JavaCC grammar file will be located.
    private File
    Deprecated.
    Directory where the input JJTree files (*.jjt) are located.
    private int
    Deprecated.
    The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
    private File
    Deprecated.
    The directory to store the processed input files for later detection of stale sources.
    private Boolean
    Deprecated.
    A flag whether to insert the methods jjtGetFirstToken(), jjtSetFirstToken(), getLastToken() and jjtSetLastToken() into the class SimpleNode.
    private Boolean
    Deprecated.
    A flag whether to insert a jjtAccept() method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar.
    private String
    Deprecated.
    The name of a class to use for the data argument of the jjtAccept() and visit() methods.
    private String
    Deprecated.
    The name of an exception class to include in the signature of the generated jjtAccept() and visit() methods.
    private String
    Deprecated.
    The name of a class to use as the return type of the jjtAccept() and visit() methods.

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

    ROLE
  • Constructor Summary

    Constructors
    Constructor
    Description
    Deprecated.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    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 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.
    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.
    protected JJTree
    Deprecated.
    Creates a new facade to invoke JJTree.
    protected void
    Deprecated.
    Passes the specified grammar file through the tool.

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

    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
  • Field Details

    • jdkVersion

      @Parameter(property="javacc.jdkVersion") private String jdkVersion
      Deprecated.
      The Java version for which to generate source code. Default value is 1.4.
      Since:
      2.4
    • buildNodeFiles

      @Parameter(property="javacc.buildNodeFiles") private Boolean buildNodeFiles
      Deprecated.
      A flag whether to generate sample implementations for SimpleNode and any other nodes used in the grammar. Default value is true.
    • multi

      @Parameter(property="javacc.multi") private Boolean multi
      Deprecated.
      A flag whether to generate a multi mode parse tree or a single mode parse tree. Default value is false.
    • nodeDefaultVoid

      @Parameter(property="javacc.nodeDefaultVoid") private Boolean nodeDefaultVoid
      Deprecated.
      A flag whether to make each non-decorated production void instead of an indefinite node. Default value is false.
    • nodeClass

      @Parameter(property="javacc.nodeClass") private String nodeClass
      Deprecated.
      The name of a custom class that extends SimpleNode and will be used as the super class for the generated tree node classes. By default, the tree node classes will directly extend the class SimpleNode.
      Since:
      2.5
    • nodeFactory

      @Parameter(property="javacc.nodeFactory") private String nodeFactory
      Deprecated.
      The name of a custom factory class used to create Node objects. This class must have a method with the signature public static Node jjtCreate(int id). By default, the class SimpleNode will be used as the factory class.
    • nodePackage

      @Parameter(property="javacc.nodePackage") private 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 is org.apache and this parameter is set to *.demo, the tree node classes will be located in the package org.apache.demo. By default, the package of the corresponding parser is used.
    • nodePrefix

      private String nodePrefix
      Deprecated.
      The prefix used to construct node class names from node identifiers in multi mode. Default value is AST.
    • nodeScopeHook

      @Parameter(property="javacc.nodeScopeHook") private Boolean nodeScopeHook
      Deprecated.
      A flag whether user-defined parser methods should be called on entry and exit of every node scope. Default value is false.
    • nodeUsesParser

      @Parameter(property="javacc.nodeUsesParser") private Boolean nodeUsesParser
      Deprecated.
      A flag whether the node construction routines need an additional method parameter to receive the parser object. Default value is false.
    • isStatic

      @Parameter(property="javacc.isStatic", alias="javacc.staticOption") private Boolean isStatic
      Deprecated.
      A flag whether to generate code for a static parser. Note that this setting must match the corresponding option for the javacc mojo. Default value is true.
    • trackTokens

      @Parameter(property="javacc.trackTokens") private Boolean trackTokens
      Deprecated.
      A flag whether to insert the methods jjtGetFirstToken(), jjtSetFirstToken(), getLastToken() and jjtSetLastToken() into the class SimpleNode. Default value is false.
      Since:
      2.5
    • visitor

      @Parameter(property="javacc.visitor") private Boolean visitor
      Deprecated.
      A flag whether to insert a jjtAccept() method in the node classes and to generate a visitor implementation with an entry for every node type used in the grammar. Default value is false.
    • visitorDataType

      @Parameter(property="javacc.visitorDataType") private String visitorDataType
      Deprecated.
      The name of a class to use for the data argument of the jjtAccept() and visit() methods. Default value is java.lang.Object.
      Since:
      2.5
    • visitorReturnType

      @Parameter(property="javacc.visitorReturnType") private String visitorReturnType
      Deprecated.
      The name of a class to use as the return type of the jjtAccept() and visit() methods. Default value is java.lang.Object.
      Since:
      2.5
    • visitorException

      @Parameter(property="javacc.visitorException") private String visitorException
      Deprecated.
      The name of an exception class to include in the signature of the generated jjtAccept() and visit() methods. By default, the throws clause of the generated methods is empty such that only unchecked exceptions can be thrown.
    • sourceDirectory

      @Parameter(property="javacc.sourceDirectory", defaultValue="${basedir}/src/main/jjtree") private File sourceDirectory
      Deprecated.
      Directory where the input JJTree files (*.jjt) are located.
    • outputDirectory

      @Parameter(property="javacc.outputDirectory", defaultValue="${project.build.directory}/generated-sources/jjtree") private File outputDirectory
      Deprecated.
      Directory where the output Java files for the node classes and the JavaCC grammar file will be located.
    • timestampDirectory

      @Parameter(property="javacc.timestampDirectory", defaultValue="${project.build.directory}/generated-sources/jjtree-timestamp") private File timestampDirectory
      Deprecated.
      The directory to store the processed input files for later detection of stale sources.
    • staleMillis

      @Parameter(property="javacc.lastModGranularityMs", defaultValue="0") private int staleMillis
      Deprecated.
      The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
    • includes

      @Parameter private 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

      @Parameter private 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.
  • Constructor Details

    • JJTreeMojo

      public JJTreeMojo()
      Deprecated.
  • Method Details

    • 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(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 class AbstractPreprocessorMojo
      Parameters:
      grammarInfo - The grammar info describing the grammar file to process, must not be null.
      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 class AbstractPreprocessorMojo