Package org.apache.maven.plugins.pmd

Class AggregatorPmdReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.pmd.AbstractPmdReport

org.apache.maven.plugins.pmd.PmdReport

org.apache.maven.plugins.pmd.AggregatorPmdReport

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorPmdNoForkReport

@Mojo(name="aggregate-pmd",
      aggregator=true,
      threadSafe=true,
      requiresDependencyResolution=TEST)
@Execute(phase=TEST_COMPILE)
public class AggregatorPmdReport
extends PmdReport

Creates a PMD site report in an aggregator project based on the rulesets and configuration set in the plugin. It can also generate a pmd output file aside from the site report in any of the following formats: xml, csv or txt.

Since:

3.15.0

Field Summary

Fields inherited from class org.apache.maven.plugins.pmd.AbstractPmdReport

aggregate, excludeFromFailureFile, filesToProcess, format, includeTests, includeXmlInReports, session, showPmdLog, skipEmptyReport, targetDirectory

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, 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
AggregatorPmdReport(org.codehaus.plexus.resource.ResourceManager locator, ConfigurationService configurationService, org.codehaus.plexus.i18n.I18N i18n, PmdServiceExecutor serviceExecutor)

Method Summary

Modifier and Type	Method	Description
protected boolean	isAggregator()

Methods inherited from class org.apache.maven.plugins.pmd.PmdReport

canGenerateReport, createRenderer, executeReport, getDescription, getI18nString, getLocationTemp, getName, getOutputName, getOutputPath, setRulesets

Methods inherited from class org.apache.maven.plugins.pmd.AbstractPmdReport

canGenerateReportInternal, getAggregatedProjects, getFilesToProcess, getJdkToolchain, getMojoExecution, getProject, getReactorProjects, isXml

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

Constructor Details

AggregatorPmdReport

@Inject
public AggregatorPmdReport(org.codehaus.plexus.resource.ResourceManager locator,
 ConfigurationService configurationService,
 org.codehaus.plexus.i18n.I18N i18n,
 PmdServiceExecutor serviceExecutor)

Method Details

isAggregator

protected boolean isAggregator()

Overrides:

isAggregator in class AbstractPmdReport