Class 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 $
    Author:
    Vincent Siveton
    See Also:
    Command Line Options
    • Field Detail

      • i18n

        protected org.codehaus.plexus.i18n.I18N i18n
        Internationalization.
    • Constructor Detail

      • AntlrHtmlReport

        public AntlrHtmlReport()
    • Method Detail

      • 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)
      • 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
      • generate

        public void generate​(org.codehaus.doxia.sink.Sink sink,
                             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 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()