Class InvokerReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.invoker.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
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codehaus.plexus.i18n.I18N
    Internationalization component.
    protected File
    The output directory for the report.
    private NumberFormat
    The number format used to print percent values in the report locale.
    protected org.apache.maven.project.MavenProject
    The Maven Project.
    private File
    Base directory where all build reports have been written to.
    private NumberFormat
    The number format used to print time values in the report locale.
    protected org.apache.maven.doxia.siterenderer.Renderer
    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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    private void
    constructSummarySection(List<? extends BuildJob> buildJobs, Locale locale)
     
    protected void
     
     
    getName(Locale locale)
     
    protected String
     
     
    protected org.apache.maven.project.MavenProject
     
    protected org.apache.maven.doxia.siterenderer.Renderer
     
    private String
    getText(Locale locale, String key)
     
    private void
    renderBuildJob(BuildJob buildJob, Locale locale)
     
    private void
    sinkCell(org.apache.maven.doxia.sink.Sink sink, String text)
     
    private void
    sinkTableHeader(org.apache.maven.doxia.sink.Sink sink, String header)
     

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

    closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, 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 Details

    • 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.
    • reportsDirectory

      @Parameter(defaultValue="${project.build.directory}/invoker-reports", property="invoker.reportsDirectory") private File reportsDirectory
      Base directory where all build reports have been written to.
    • percentFormat

      private NumberFormat percentFormat
      The number format used to print percent values in the report locale.
    • secondsFormat

      private NumberFormat secondsFormat
      The number format used to print time values in the report locale.
  • Constructor Details

    • InvokerReport

      public InvokerReport()
  • Method Details

    • 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
    • constructSummarySection

      private void constructSummarySection(List<? extends BuildJob> buildJobs, Locale locale)
    • renderBuildJob

      private void renderBuildJob(BuildJob buildJob, Locale locale)
    • 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)
    • getName

      public String getName(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
    • getText

      private String getText(Locale locale, String key)
    • sinkTableHeader

      private void sinkTableHeader(org.apache.maven.doxia.sink.Sink sink, String header)
    • sinkCell

      private void sinkCell(org.apache.maven.doxia.sink.Sink sink, String text)