Package org.codehaus.mojo.antlr

Class AbstractAntlrMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, Environment
    Direct Known Subclasses:
    AntlrHtmlReport, AntlrPlugin
    public abstract class AbstractAntlrMojo
extends org.apache.maven.plugin.AbstractMojo
implements Environment
    Base class with majority of Antlr functionalities.
    Version:
    $Id$
    Author:
    Vincent Siveton

    • Field Detail

      • sourceDirectory

        protected File sourceDirectory
        Specifies the Antlr directory containing grammar files.

      • project

        protected org.apache.maven.project.MavenProject project
        The Maven Project Object

      • outputDirectory

        protected File outputDirectory
        Specifies the destination directory where Antlr should generate files.
        See Command Line Options

      • grammars

        protected String grammars
        Comma separated grammar file names or grammar pattern file names present in the sourceDirectory directory.
        See Command Line Options

      • grammarDefs

        protected Grammar[] grammarDefs
        Grammar list presents in the sourceDirectory directory.
        See Command Line Options
        Example: 
         <grammarDefs>
        
   <grammar>
        
     <name>myGrammar.g</name>
        
     <glib>mySuperGrammar.g;myOtherSuperGrammar.g</glib>
        
   </grammar>
        
 </grammarDefs>

    • Constructor Detail

      • AbstractAntlrMojo

        public AbstractAntlrMojo()

    • Method Detail

      • executeAntlr

        protected void executeAntlr()
                     throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • performGeneration

        protected void performGeneration​(GenerationPlan plan,
                                 org.apache.maven.artifact.Artifact antlrArtifact)
                          throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • addArgs

        protected abstract void addArgs​(List<String> arguments)
        Add arguments to be included in Antlr call
        Parameters:
        arguments -

      • addArgIf

        protected static void addArgIf​(List<String> arguments,
                               boolean b,
                               String value)
        Convenience method to add an argument
        Parameters:
        arguments -
        b -
        value -