PitReportAggregationModuleMojo (pitest-maven 1.20.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.reporting.AbstractMavenReport
  - - org.pitest.maven.report.PitReportMojo
    - - org.pitest.maven.report.PitReportAggregationModuleMojo

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-aggregate-module",
      defaultPhase=PREPARE_PACKAGE,
      aggregator=true)
public class PitReportAggregationModuleMojo
extends PitReportMojo
```
Goal which aggregates the results of multiple tests into a single result.
Based upon Jacoco's ReportAggregateMojo, creates a structured report (HTML, XML, or CSV) from multiple projects. The report is created the all modules this project includes as dependencies.

To successfully aggregate reports, each of the individual sub-module reports must have the exportLineCoverage set to true, and must export an XML formatted report. then call the mojo ONLY on the parent mvn pitest:report-aggregate-module --non-recursive

- Field Summary
  - Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
    outputDirectory
  - 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
  
  PitReportAggregationModuleMojo()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  protected void executeReport(Locale locale)
  
  String getDescription(Locale locale)
  - Methods inherited from class org.pitest.maven.report.PitReportMojo
    canGenerateReport, getInputEncoding, getName, getOutputDirectory, getOutputEncoding, getOutputName, getProject, getReportsDirectory, getSiteRenderer, getSourceDataFormats, isExternalReport, isSkip
  - Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
    closeReport, execute, generate, generate, generate, getCategoryName, 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

- Constructor Detail
  - PitReportAggregationModuleMojo
```
public PitReportAggregationModuleMojo()
```
- Method Detail
  - getDescription
```
public String getDescription(Locale locale)
```
    Specified by:
    
    getDescription in interface org.apache.maven.reporting.MavenReport
    
    Overrides:
    
    getDescription in class PitReportMojo
  - executeReport
```
protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
```
    Overrides:
    
    executeReport in class PitReportMojo
    
    Throws:
    
    org.apache.maven.reporting.MavenReportException