Package org.apache.maven.plugins.invoker

Class InvokerReport

  • 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="report",
      threadSafe=true)
public class InvokerReport
extends org.apache.maven.reporting.AbstractMavenReport
    Generate a report based on the results of the Maven invocations. Note: This mojo doesn't fork any lifecycle, if you have a clean working copy, you have to use a command like mvn clean integration-test site to ensure the build results are present when this goal is invoked.
    Since:
    1.4
    Author:
    Olivier Lamy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.codehaus.plexus.i18n.I18N i18n
      Internationalization component.
      protected File outputDirectory
      The output directory for the report.
      protected org.apache.maven.project.MavenProject project
      The Maven Project.
      protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
      Doxia Site Renderer component.

      • 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
      InvokerReport()  

    • Field Detail

      • project

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

      • siteRenderer

        @Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
        Doxia Site Renderer component.

      • i18n

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

      • outputDirectory

        @Parameter(defaultValue="${project.reporting.outputDirectory}",
           required=true)
protected 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.

    • Constructor Detail

      • InvokerReport

        public InvokerReport()

    • Method Detail

      • executeReport

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

      • getOutputDirectory

        protected 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

      • getSiteRenderer

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

      • getDescription

        public String getDescription​(Locale locale)

      • getOutputName

        public String getOutputName()

      • canGenerateReport

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