org.codehaus.mojo.antlr
Class AntlrHtmlReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.antlr.AbstractAntlrMojo
          extended by org.codehaus.mojo.antlr.AntlrHtmlReport
All Implemented Interfaces:
ContextEnabled, Mojo, MavenReport, Environment

public class AntlrHtmlReport
extends AbstractAntlrMojo
implements MavenReport

Generates Antlr documentation from grammar files.

Version:
$Id: AntlrHtmlReport.java 13111 2010-11-16 22:16:36Z pgier $
Author:
Vincent Siveton
See Also:
Command Line Options
Is defined by the goal name:
html

Nested Class Summary
 
Nested classes/interfaces inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
AbstractAntlrMojo.NoAntlrDependencyDefinedException
 
Field Summary
protected  org.codehaus.plexus.i18n.I18N i18n
          Internationalization.
 
Fields inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
grammarDefs, grammars, outputDirectory, project, sourceDirectory
 
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AntlrHtmlReport()
           
 
Method Summary
protected  void addArgs(List arguments)
          Add arguments to be included in Antlr call
 boolean canGenerateReport()
           
 void execute()
           
 void generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)
           
 String getCategoryName()
           
 String getDescription(Locale locale)
           
 String getName(Locale locale)
           
 String getOutputName()
           
 File getReportOutputDirectory()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(File reportOutputDirectory)
           
 
Methods inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
addArgIf, executeAntlr, getOutputDirectory, getSourceDirectory, locateAntlrArtifact, performGeneration
 
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

i18n

protected org.codehaus.plexus.i18n.I18N i18n
Internationalization.

Is a Plexus component defined by:
Constructor Detail

AntlrHtmlReport

public AntlrHtmlReport()
Method Detail

getName

public String getName(Locale locale)
Specified by:
getName in interface MavenReport
See Also:
MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)
Specified by:
getDescription in interface MavenReport
See Also:
MavenReport.getDescription(java.util.Locale)

addArgs

protected void addArgs(List arguments)
Description copied from class: AbstractAntlrMojo
Add arguments to be included in Antlr call

Specified by:
addArgs in class AbstractAntlrMojo
See Also:
AbstractAntlrMojo.addArgs(java.util.List)

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
                     Locale locale)
              throws MavenReportException
Specified by:
generate in interface MavenReport
Throws:
MavenReportException
See Also:
MavenReport.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)

getOutputName

public String getOutputName()
Specified by:
getOutputName in interface MavenReport
See Also:
MavenReport.getOutputName()

isExternalReport

public boolean isExternalReport()
Specified by:
isExternalReport in interface MavenReport
See Also:
MavenReport.isExternalReport()

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface MavenReport
See Also:
MavenReport.canGenerateReport()

getCategoryName

public String getCategoryName()
Specified by:
getCategoryName in interface MavenReport
See Also:
MavenReport.getCategoryName()

getReportOutputDirectory

public File getReportOutputDirectory()
Specified by:
getReportOutputDirectory in interface MavenReport
See Also:
MavenReport.getReportOutputDirectory()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)
Specified by:
setReportOutputDirectory in interface MavenReport
See Also:
MavenReport.setReportOutputDirectory(java.io.File)

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException
Specified by:
execute in interface Mojo
Throws:
MojoExecutionException
MojoFailureException
See Also:
AbstractMavenReport.execute()


Copyright © 2004-2012 Codehaus. All Rights Reserved.