com.github.sarahbuisson.maven.universal.module.aggregator.plugin

Class AggregatorReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

com.github.sarahbuisson.maven.universal.module.aggregator.plugin.AggregatorReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

@Mojo(name="aggregate",
      defaultPhase=PRE_SITE)
public class AggregatorReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Merge the report of the pit mutation testing from the module to the parent.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	copyModules copy the files of the modules into the parent's target.
protected String	filesToAggregateModulePath relative path, in a module, to the files who will-be aggregate in the parent.
protected org.apache.maven.execution.MavenSession	mavenSession
protected boolean	useDefaultTemplate use default template to resume all the modules. default = true

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 and Description
AggregatorReportMojo()

Method Summary

Modifier and Type	Method and Description
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
String	getReportsDirectory() Getter for property 'reportsDirectory'.
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport()

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

canGenerateReport, closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

filesToAggregateModulePath

@Parameter(property="filesToAggregateModulePath",
           required=true)
protected String filesToAggregateModulePath

relative path, in a module, to the files who will-be aggregate in the parent. regexp are allowed.

copyModules

@Parameter(property="copyModules",
           defaultValue="true")
protected boolean copyModules

copy the files of the modules into the parent's target.

useDefaultTemplate

@Parameter(property="useDefaultTemplate",
           defaultValue="true")
protected boolean useDefaultTemplate

use default template to resume all the modules. default = true

mavenSession

@Parameter(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession mavenSession

Constructor Detail

AggregatorReportMojo

public AggregatorReportMojo()

Method Detail

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

getReportsDirectory

public String getReportsDirectory()

Getter for property 'reportsDirectory'.

Returns:

Value for property 'reportsDirectory'.

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

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport