public abstract class AbstractPmdReport
extends org.apache.maven.reporting.AbstractMavenReport
Modifier and Type | Field and Description |
---|---|
protected boolean |
aggregate
Deprecated.
since 3.15.0 Use the goals
pmd:aggregate-pmd and pmd:aggregate-cpd
instead. |
protected String |
excludeFromFailureFile
File that lists classes and rules to be excluded from failures.
|
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 List<org.apache.maven.project.MavenProject> |
reactorProjects
The projects in the reactor for aggregation report.
|
protected org.apache.maven.execution.MavenSession |
session
The current build session instance.
|
protected boolean |
showPmdLog
Redirect PMD log into maven log out.
|
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.
|
localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool
Constructor and Description |
---|
AbstractPmdReport() |
Modifier and Type | Method and Description |
---|---|
boolean |
canGenerateReport() |
protected String |
constructXRefLocation(boolean test) |
protected String |
determineCurrentRootLogLevel() |
protected Collection<org.apache.maven.project.MavenProject> |
getAggregatedProjects() |
protected Map<File,PmdFileInfo> |
getFilesToProcess()
Convenience method to get the list of files where the PMD tool will be executed
|
protected org.apache.maven.project.MavenProject |
getProject() |
protected org.apache.maven.toolchain.Toolchain |
getToolchain() |
protected boolean |
isAggregator() |
protected boolean |
isXml() |
closeReport, execute, executeReport, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
getLog, getPluginContext, setLog, setPluginContext
@Parameter(property="project.build.directory", required=true) protected File targetDirectory
@Parameter(property="format", defaultValue="xml") protected String format
@Parameter(defaultValue="false") protected boolean includeTests
@Parameter(property="aggregate", defaultValue="false") @Deprecated protected boolean aggregate
pmd:aggregate-pmd
and pmd:aggregate-cpd
instead.@Parameter(defaultValue="false") protected boolean includeXmlInSite
@Parameter(defaultValue="false") protected boolean skipEmptyReport
false
.
Note: the default value was changed from true
to false
with version 3.13.0.
@Parameter(property="pmd.excludeFromFailureFile", defaultValue="") protected String excludeFromFailureFile
@Parameter(defaultValue="true", property="pmd.showPmdLog") protected boolean showPmdLog
-X
or --debug
),
the PMD logger is also configured for debug.@Parameter(property="reactorProjects", readonly=true) protected List<org.apache.maven.project.MavenProject> reactorProjects
@Parameter(defaultValue="${session}", required=true, readonly=true) protected org.apache.maven.execution.MavenSession session
protected Map<File,PmdFileInfo> filesToProcess
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
protected String constructXRefLocation(boolean test)
protected Map<File,PmdFileInfo> getFilesToProcess() throws IOException
IOException
- If an I/O error occurs during construction of the
canonical pathnames of the filesprotected boolean isXml()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
protected String determineCurrentRootLogLevel()
protected final org.apache.maven.toolchain.Toolchain getToolchain()
protected boolean isAggregator()
protected Collection<org.apache.maven.project.MavenProject> getAggregatedProjects()
Copyright © 2005–2023 The Apache Software Foundation. All rights reserved.