Package org.apache.maven.plugins.pmd
Class AbstractPmdReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.pmd.AbstractPmdReport
- All Implemented Interfaces:
ContextEnabled
,Mojo
,MavenMultiPageReport
,MavenReport
Base class for the PMD reports.
- Version:
- $Id$
- Author:
- Brett Porter
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
Deprecated.protected String
File that lists classes and rules to be excluded from failures.protected Map<File,
PmdFileInfo> The files that are being analyzed.protected String
Set the output format type, in addition to the HTML report.protected boolean
Run PMD on the tests.protected boolean
Whether to include the xml files generated by PMD/CPD in the site.protected File
The output directory for the final HTML report.protected MavenProject
The project to analyse.protected List<MavenProject>
The projects in the reactor for aggregation report.protected MavenSession
The current build session instance.protected boolean
Redirect PMD log into maven log out.protected boolean
Skip the PMD/CPD report generation if there are no violations or duplications found.protected File
The output directory for the intermediate XML report.Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
protected String
constructXRefLocation
(boolean test) protected String
protected Collection<MavenProject>
protected Map<File,
PmdFileInfo> Convenience method to get the list of files where the PMD tool will be executedprotected String
protected String
Gets the effective reporting output files encoding.protected MavenProject
protected Renderer
protected String
protected final Toolchain
protected boolean
protected boolean
isXml()
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, executeReport, generate, generate, generate, getCategoryName, getInputEncoding, 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 Details
-
targetDirectory
The output directory for the intermediate XML report. -
outputDirectory
@Parameter(property="project.reporting.outputDirectory", required=true) protected File outputDirectoryThe 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. -
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 produced in any case, since this format is needed for the check goals (pmd:check, pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check). -
includeTests
Run PMD on the tests.- Since:
- 2.2
-
aggregate
Deprecated.since 3.15.0 Use the goalspmd:aggregate-pmd
andpmd:aggregate-cpd
instead.Whether to build an aggregated report at the root, or build individual reports.- Since:
- 2.2
-
includeXmlInSite
Whether to include the xml files generated by PMD/CPD in the site.- Since:
- 3.0
-
skipEmptyReport
Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults tofalse
.Note: the default value was changed from
true
tofalse
with version 3.13.0.- Since:
- 3.1
-
excludeFromFailureFile
@Parameter(property="pmd.excludeFromFailureFile", defaultValue="") protected String excludeFromFailureFileFile that lists classes and rules to be excluded from failures. For PMD, this is a properties file. For CPD, this is a text file that contains comma-separated lists of classes that are allowed to duplicate.- Since:
- 3.7
-
showPmdLog
Redirect PMD log into maven log out. When enabled, the PMD log output is redirected to maven, so that it is visible in the console together with all the other log output. Also, if maven is started with the debug flag (-X
or--debug
), the PMD logger is also configured for debug.- Since:
- 3.9.0
-
project
The project to analyse. -
reactorProjects
The projects in the reactor for aggregation report. -
session
The current build session instance. This is used for toolchain manager API calls and for dependency resolver API calls. -
filesToProcess
The files that are being analyzed.
-
-
Constructor Details
-
AbstractPmdReport
public AbstractPmdReport()
-
-
Method Details
-
getProject
- Overrides:
getProject
in classAbstractMavenReport
-
getSiteRenderer
- Overrides:
getSiteRenderer
in classAbstractMavenReport
-
constructXRefLocation
-
getFilesToProcess
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
- If an I/O error occurs during construction of the canonical pathnames of the files
-
isXml
protected boolean isXml() -
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceMavenReport
- Overrides:
canGenerateReport
in classAbstractMavenReport
-
getOutputDirectory
- Overrides:
getOutputDirectory
in classAbstractMavenReport
-
getSourceEncoding
-
getOutputEncoding
Gets the effective reporting output files encoding.- Overrides:
getOutputEncoding
in classAbstractMavenReport
- Returns:
- The effective reporting output file encoding, never
null
. - Since:
- 2.5
-
determineCurrentRootLogLevel
-
getToolchain
-
isAggregator
protected boolean isAggregator() -
getAggregatedProjects
-
pmd:aggregate-pmd
andpmd:aggregate-cpd
instead.