public abstract class AbstractPmdReport
extends org.apache.maven.reporting.AbstractMavenReport
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.
|
Constructor and Description |
---|
AbstractPmdReport() |
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() |
closeReport, execute, executeReport, generate, generate, generate, getCategoryName, getInputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory
getLog, getPluginContext, setLog, setPluginContext
@Parameter(property="project.build.directory", required=true) protected File targetDirectory
@Parameter(property="project.reporting.outputDirectory", required=true) protected File outputDirectory
@Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
@Parameter(property="format", defaultValue="xml") protected String format
@Parameter(defaultValue="false") protected boolean includeTests
@Parameter(property="aggregate", defaultValue="false") protected boolean aggregate
@Parameter(property="reactorProjects", readonly=true) protected List<org.apache.maven.project.MavenProject> reactorProjects
@Parameter(defaultValue="false") protected boolean includeXmlInSite
@Parameter(defaultValue="true") protected boolean skipEmptyReport
true
.protected Map<File,PmdFileInfo> filesToProcess
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
protected String constructXRefLocation(boolean test)
protected Map<File,PmdFileInfo> getFilesToProcess() throws IOException
IOException
protected boolean isHtml()
protected boolean isXml()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
protected String getSourceEncoding()
protected String getOutputEncoding()
getOutputEncoding
in class org.apache.maven.reporting.AbstractMavenReport
null
.Copyright © 2005–2016 The Apache Software Foundation. All rights reserved.