org.apache.maven.plugin.pmd

Class AbstractPmdReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugin.pmd.AbstractPmdReport

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:

CpdReport, PmdReport

public abstract class AbstractPmdReport
extends org.apache.maven.reporting.AbstractMavenReport

Base class for the PMD reports.

Version:

$Id: AbstractPmdReport.java 1620207 2014-08-24 22:04:38Z hboutemy $

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aggregate Whether to build an aggregated report at the root, or build individual reports.
protected Map<File,PmdFileInfo>	filesToProcess The files that are being analyzed.
protected String	format Set the output format type, in addition to the HTML report.
protected boolean	includeTests Run PMD on the tests.
protected boolean	includeXmlInSite Whether to include the xml files generated by PMD/CPD in the site.
protected File	outputDirectory The output directory for the final HTML report.
protected org.apache.maven.project.MavenProject	project The project to analyse.
protected List<org.apache.maven.project.MavenProject>	reactorProjects The projects in the reactor for aggregation report.
protected boolean	skipEmptyReport Skip the PMD/CPD report generation if there are no violations or duplications found.
protected File	targetDirectory The output directory for the intermediate XML report.

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
AbstractPmdReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected String	constructXRefLocation(boolean test)
protected Map<File,PmdFileInfo>	getFilesToProcess() Convenience method to get the list of files where the PMD tool will be executed
protected String	getOutputDirectory()
protected String	getOutputEncoding() Gets the effective reporting output files encoding.
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected String	getSourceEncoding()
protected boolean	isHtml()
protected boolean	isXml()

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

closeReport, execute, executeReport, generate, generate, generate, getCategoryName, 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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getDescription, getName, getOutputName

Field Detail

targetDirectory

@Parameter(property="project.build.directory",
           required=true)
protected File targetDirectory

The output directory for the intermediate XML report.

outputDirectory

@Parameter(property="project.reporting.outputDirectory",
           required=true)
protected File outputDirectory

The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

project

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

The project to analyse.

format

@Parameter(property="format",
           defaultValue="xml")
protected String format

Set the output format type, in addition to the HTML report. Must be one of: "none", "csv", "xml", "txt" or the full class name of the PMD renderer to use. See the net.sourceforge.pmd.renderers package javadoc for available renderers. XML is required if the pmd:check goal is being used.

includeTests

@Parameter(defaultValue="false")
protected boolean includeTests

Run PMD on the tests.

Since:

2.2

aggregate

@Parameter(property="aggregate",
           defaultValue="false")
protected boolean aggregate

Whether to build an aggregated report at the root, or build individual reports.

Since:

2.2

reactorProjects

@Parameter(property="reactorProjects",
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

The projects in the reactor for aggregation report.

includeXmlInSite

@Parameter(defaultValue="false")
protected boolean includeXmlInSite

Whether to include the xml files generated by PMD/CPD in the site.
Note: In versions 2.2 - 2.7.1 the default value for this was true. This was changed in version 3.0.

Since:

3.0

skipEmptyReport

@Parameter(defaultValue="true")
protected boolean skipEmptyReport

Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to true.

Since:

3.1

filesToProcess

protected Map<File,PmdFileInfo> filesToProcess

The files that are being analyzed.

Constructor Detail

AbstractPmdReport

public AbstractPmdReport()

Method Detail

getProject

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

Specified by:

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

getSiteRenderer

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

Specified by:

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

constructXRefLocation

protected String constructXRefLocation(boolean test)

getFilesToProcess

protected Map<File,PmdFileInfo> getFilesToProcess()
                                           throws IOException

Convenience method to get the list of files where the PMD tool will be executed

Returns:

a List of the files where the PMD tool will be executed

Throws:

IOException

isHtml

protected boolean isHtml()

isXml

protected boolean isXml()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

getSourceEncoding

protected String getSourceEncoding()

getOutputEncoding

protected String getOutputEncoding()

Gets the effective reporting output files encoding.

Returns:

The effective reporting output file encoding, never null.

Since:

2.5