Package org.codehaus.mojo.antlr
Class AbstractAntlrMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.codehaus.mojo.antlr.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: AbstractAntlrMojo.java 13111 2010-11-16 22:16:36Z pgier $
- Author:
- Vincent Siveton
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AbstractAntlrMojo.NoAntlrDependencyDefinedException
-
Field Summary
Fields Modifier and Type Field Description protected Grammar[]
grammarDefs
Grammar list presents in thesourceDirectory
directory.protected String
grammars
Comma separated grammar file names or grammar pattern file names present in thesourceDirectory
directory.protected File
outputDirectory
Specifies the destination directory where Antlr should generate files.protected org.apache.maven.project.MavenProject
project
The Maven Project Objectprotected File
sourceDirectory
Specifies the Antlr directory containing grammar files.
-
Constructor Summary
Constructors Constructor Description AbstractAntlrMojo()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected static void
addArgIf(List arguments, boolean b, String value)
Convenience method to add an argumentprotected abstract void
addArgs(List arguments)
Add arguments to be included in Antlr callprotected void
executeAntlr()
File
getOutputDirectory()
File
getSourceDirectory()
protected org.apache.maven.artifact.Artifact
locateAntlrArtifact()
protected void
performGeneration(GenerationPlan plan, org.apache.maven.artifact.Artifact antlrArtifact)
-
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
-
Methods inherited from interface org.codehaus.mojo.antlr.Environment
getLog
-
-
-
-
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 thesourceDirectory
directory.
See Command Line Options
-
grammarDefs
protected Grammar[] grammarDefs
Grammar list presents in thesourceDirectory
directory.
See Command Line Options
Example:<grammarDefs>
<grammar>
<name>myGrammar.g</name>
<glib>mySuperGrammar.g;myOtherSuperGrammar.g</glib>
</grammar>
</grammarDefs>
-
-
Method Detail
-
getSourceDirectory
public File getSourceDirectory()
- Specified by:
getSourceDirectory
in interfaceEnvironment
-
getOutputDirectory
public File getOutputDirectory()
- Specified by:
getOutputDirectory
in interfaceEnvironment
-
executeAntlr
protected void executeAntlr() throws org.apache.maven.plugin.MojoExecutionException
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
locateAntlrArtifact
protected final org.apache.maven.artifact.Artifact locateAntlrArtifact() throws AbstractAntlrMojo.NoAntlrDependencyDefinedException
-
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 arguments)
Add arguments to be included in Antlr call- Parameters:
arguments
-
-
-