Package org.codehaus.mojo.antlr
Class AntlrHtmlReport
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.codehaus.mojo.antlr.AbstractAntlrMojo
-
- org.codehaus.mojo.antlr.AntlrHtmlReport
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenReport
,Environment
public class AntlrHtmlReport extends AbstractAntlrMojo implements org.apache.maven.reporting.MavenReport
Generates Antlr documentation from grammar files.- Version:
- $Id: AntlrHtmlReport.java 13111 2010-11-16 22:16:36Z pgier $
- See Also:
- Command Line Options
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
AntlrHtmlReport.AntlrRenderer
Renderer report-
Nested classes/interfaces inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
AbstractAntlrMojo.NoAntlrDependencyDefinedException
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
description
The description of the Antlr report.protected org.codehaus.plexus.i18n.I18N
i18n
Internationalization.private java.lang.String
name
The name of the Antlr report.private java.io.File
reportOutputDirectory
Specifies the destination directory where Antlr generates HTML files.private org.apache.maven.doxia.siterenderer.Renderer
siteRenderer
Generates the site report-
Fields inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
grammarDefs, grammars, outputDirectory, project, sourceDirectory
-
-
Constructor Summary
Constructors Constructor Description AntlrHtmlReport()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addArgs(java.util.List arguments)
Add arguments to be included in Antlr callboolean
canGenerateReport()
void
execute()
void
generate(org.apache.maven.doxia.sink.Sink sink, java.util.Locale locale)
void
generate(org.codehaus.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.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
-
siteRenderer
private org.apache.maven.doxia.siterenderer.Renderer siteRenderer
Generates the site report
-
i18n
protected org.codehaus.plexus.i18n.I18N i18n
Internationalization.
-
reportOutputDirectory
private java.io.File reportOutputDirectory
Specifies the destination directory where Antlr generates HTML files.
-
name
private java.lang.String name
The name of the Antlr report.
-
description
private java.lang.String description
The description of the Antlr report.
-
-
Method Detail
-
getName
public java.lang.String getName(java.util.Locale locale)
- Specified by:
getName
in interfaceorg.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 interfaceorg.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 classAbstractAntlrMojo
- 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 interfaceorg.apache.maven.reporting.MavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
-
generate
public void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
- Throws:
org.apache.maven.reporting.MavenReportException
- See Also:
org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)
-
getOutputName
public java.lang.String getOutputName()
- Specified by:
getOutputName
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
MavenReport.getOutputName()
-
isExternalReport
public boolean isExternalReport()
- Specified by:
isExternalReport
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
MavenReport.isExternalReport()
-
canGenerateReport
public boolean canGenerateReport()
- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
MavenReport.canGenerateReport()
-
getCategoryName
public java.lang.String getCategoryName()
- Specified by:
getCategoryName
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
MavenReport.getCategoryName()
-
getReportOutputDirectory
public java.io.File getReportOutputDirectory()
- Specified by:
getReportOutputDirectory
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
MavenReport.getReportOutputDirectory()
-
setReportOutputDirectory
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
- Specified by:
setReportOutputDirectory
in interfaceorg.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 interfaceorg.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
- See Also:
AbstractMavenReport.execute()
-
-