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
@Mojo(name="html")
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Renderer reportNested classes/interfaces inherited from class org.codehaus.mojo.antlr.AbstractAntlrMojo
AbstractAntlrMojo.NoAntlrDependencyDefinedException
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The description of the Antlr report.protected org.codehaus.plexus.i18n.I18N
Internationalization.private String
The name of the Antlr report.private File
Specifies the destination directory where Antlr generates HTML files.private org.apache.maven.doxia.siterenderer.Renderer
Generates the site reportFields 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Add arguments to be included in Antlr callboolean
void
execute()
void
getDescription
(Locale locale) boolean
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
Methods inherited from interface org.apache.maven.reporting.MavenReport
getOutputPath
-
Field Details
-
siteRenderer
@Component private org.apache.maven.doxia.siterenderer.Renderer siteRendererGenerates the site report -
i18n
@Component protected org.codehaus.plexus.i18n.I18N i18nInternationalization. -
reportOutputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-site/antlr") private File reportOutputDirectorySpecifies the destination directory where Antlr generates HTML files. -
name
The name of the Antlr report. -
description
@Parameter(property="description", defaultValue="Generated Antlr report from grammars.") private String descriptionThe description of the Antlr report.
-
-
Constructor Details
-
AntlrHtmlReport
public AntlrHtmlReport()
-
-
Method Details
-
getName
- Specified by:
getName
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
getDescription
- Specified by:
getDescription
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
addArgs
Description copied from class:AbstractAntlrMojo
Add arguments to be included in Antlr call- Specified by:
addArgs
in classAbstractAntlrMojo
- Parameters:
arguments
-- See Also:
-
generate
public void generate(org.apache.maven.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException - Specified by:
generate
in interfaceorg.apache.maven.reporting.MavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
- See Also:
-
getOutputName
- Specified by:
getOutputName
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
isExternalReport
public boolean isExternalReport()- Specified by:
isExternalReport
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
getCategoryName
- Specified by:
getCategoryName
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
getReportOutputDirectory
- Specified by:
getReportOutputDirectory
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
setReportOutputDirectory
- Specified by:
setReportOutputDirectory
in interfaceorg.apache.maven.reporting.MavenReport
- See Also:
-
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:
-