Package org.codehaus.mojo.gwt.reports

Class CompileReport

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    @Mojo(name="compile-report",
      threadSafe=true)
public class CompileReport
extends org.apache.maven.reporting.AbstractMavenReport
    see http://code.google.com/webtoolkit/doc/latest/DevGuideCompileReport.html#Usage
    Since:
    2.1.0-1
    Author:
    Olivier Lamy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected ClasspathBuilder classpathBuilder  
      protected org.codehaus.plexus.i18n.I18N i18n
      Internationalization component.
      protected java.io.File outputDirectory
      The output directory for the report.
      protected org.apache.maven.project.MavenProject project
      The Maven Project.
      protected java.io.File reportingOutputDirectory
      The output directory of the gwt compiler reports.
      protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
      Doxia Site Renderer component.

      • Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

        localRepository, remoteRepositories, siteTool

      • 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 
      Constructor Description
      CompileReport()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canGenerateReport()
      protected void executeReport​(java.util.Locale locale)  
      java.lang.String getCategoryName()
      java.lang.String getDescription​(java.util.Locale locale)
      java.lang.String getName​(java.util.Locale locale)
      protected java.lang.String getOutputDirectory()  
      java.lang.String getOutputName()
      protected org.apache.maven.project.MavenProject getProject()  
      protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()  
      boolean isExternalReport()

      • Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

        closeReport, execute, generate, generate, generate, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory

      • 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

      • reportingOutputDirectory

        @Parameter(defaultValue="${project.reporting.outputDirectory}/gwtCompileReports",
           required=true,
           readonly=true)
protected java.io.File reportingOutputDirectory
        The output directory of the gwt compiler reports.

      • siteRenderer

        @Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
        Doxia Site Renderer component.
        Since:
        2.1.0-1

      • outputDirectory

        @Parameter(defaultValue="${project.reporting.outputDirectory}",
           required=true)
protected java.io.File outputDirectory
        The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
        Since:
        2.1.0-1

      • project

        @Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project
        The Maven Project.
        Since:
        2.1.0-1

      • classpathBuilder

        @Component
protected ClasspathBuilder classpathBuilder
        Since:
        2.1.0-1

      • i18n

        @Component
protected org.codehaus.plexus.i18n.I18N i18n
        Internationalization component.
        Since:
        2.1.0-1

    • Constructor Detail

      • CompileReport

        public CompileReport()

    • Method Detail

      • canGenerateReport

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

      • getCategoryName

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

      • getDescription

        public java.lang.String getDescription​(java.util.Locale locale)
        See Also:
        MavenReport.getDescription(java.util.Locale)

      • getName

        public java.lang.String getName​(java.util.Locale locale)
        See Also:
        MavenReport.getName(java.util.Locale)

      • getOutputName

        public java.lang.String getOutputName()
        See Also:
        MavenReport.getOutputName()

      • isExternalReport

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

      • getSiteRenderer

        protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
        Overrides:
        getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

      • getOutputDirectory

        protected java.lang.String getOutputDirectory()
        Overrides:
        getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

      • getProject

        protected org.apache.maven.project.MavenProject getProject()
        Overrides:
        getProject in class org.apache.maven.reporting.AbstractMavenReport

      • executeReport

        protected void executeReport​(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
        Specified by:
        executeReport in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.reporting.MavenReportException
        See Also:
        AbstractMavenReport.executeReport(java.util.Locale)