org.apache.maven.plugin.antlr
Class AntlrHtmlReport

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

public class AntlrHtmlReport
extends AbstractAntlrMojo
implements org.apache.maven.reporting.MavenReport

Generates Antlr documentation from grammar files.

Version:
$Id: AntlrHtmlReport.java 539385 2007-05-18 11:11:37Z vsiveton $
Author:
Vincent Siveton
See Also:
Command Line Options

Field Summary
protected  org.codehaus.plexus.i18n.I18N i18n
          Internationalization.
 
Fields inherited from class org.apache.maven.plugin.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(java.util.List arguments)
          Add arguments to be included in Antlr call
 boolean canGenerateReport()
           
 void execute()
           
 void generate(org.apache.maven.doxia.sink.Sink sink, java.util.Locale locale)
           
 java.lang.String getCategoryName()
           
 java.lang.String getDescription(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale)
           
 java.lang.String getOutputName()
           
 java.io.File getReportOutputDirectory()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(java.io.File reportOutputDirectory)
           
 
Methods inherited from class org.apache.maven.plugin.antlr.AbstractAntlrMojo
addArgIf, executeAntlr
 
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 Detail

i18n

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

Constructor Detail

AntlrHtmlReport

public AntlrHtmlReport()
Method Detail

getName

public java.lang.String getName(java.util.Locale locale)
Specified by:
getName in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getName(java.util.Locale)

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Specified by:
getDescription in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getDescription(java.util.Locale)

addArgs

protected void addArgs(java.util.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,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException
Specified by:
generate in interface org.apache.maven.reporting.MavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
MavenReport.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)

getOutputName

public java.lang.String getOutputName()
Specified by:
getOutputName in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getOutputName()

isExternalReport

public boolean isExternalReport()
Specified by:
isExternalReport in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.isExternalReport()

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.canGenerateReport()

getCategoryName

public java.lang.String getCategoryName()
Specified by:
getCategoryName in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getCategoryName()

getReportOutputDirectory

public java.io.File getReportOutputDirectory()
Specified by:
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getReportOutputDirectory()

setReportOutputDirectory

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

execute

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


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.