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:

  • Field Details

    • siteRenderer

      @Component private org.apache.maven.doxia.siterenderer.Renderer siteRenderer
      Generates the site report

    • i18n

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

    • reportOutputDirectory

      @Parameter(defaultValue="${project.build.directory}/generated-site/antlr") private File reportOutputDirectory
      Specifies the destination directory where Antlr generates HTML files.

    • name

      @Parameter(property="name", defaultValue="Antlr Grammars") private String name
      The name of the Antlr report.

    • description

      @Parameter(property="description", defaultValue="Generated Antlr report from grammars.") private String description
      The description of the Antlr report.

  • Constructor Details

    • AntlrHtmlReport

      public AntlrHtmlReport()

  • Method Details

    • getName

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

    • getDescription

      public String getDescription(Locale locale)
      Specified by:
      getDescription in interface org.apache.maven.reporting.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
      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 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 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 String getCategoryName()
      Specified by:
      getCategoryName in interface org.apache.maven.reporting.MavenReport
      See Also:
      • MavenReport.getCategoryName()

    • getReportOutputDirectory

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

    • setReportOutputDirectory

      public void setReportOutputDirectory(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()