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.MavenReport

Direct Known Subclasses:

CpdReport, PmdReport

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

Base class for the PMD reports.

Author:

Brett Porter

Field Summary

protected boolean	aggregate Whether to build an aggregated report at the root, or build individual reports.
protected java.lang.String	format Set the output format type, in addition to the HTML report.
protected boolean	includeTests Run PMD on the tests
protected java.lang.String	outputDirectory The output directory for the final HTML report.
protected org.apache.maven.project.MavenProject	project The project to analyse.
protected java.util.List	reactorProjects The projects in the reactor for aggregation report.
protected java.io.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

AbstractPmdReport()

Method Summary

boolean	canGenerateReport()
protected java.lang.String	constructXRefLocation(boolean test)
protected java.util.Map	getFilesToProcess() Convenience method to get the list of files where the PMD tool will be executed
protected java.lang.String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected boolean	isHtml()

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

protected java.io.File targetDirectory

The output directory for the intermediate XML report.

outputDirectory

protected java.lang.String outputDirectory

The output directory for the final HTML report.

project

protected org.apache.maven.project.MavenProject project

The project to analyse.

format

protected java.lang.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

protected boolean includeTests

Run PMD on the tests

Since:

2.2

aggregate

protected boolean aggregate

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

Since:

2.2

reactorProjects

protected java.util.List reactorProjects

The projects in the reactor for aggregation report.

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

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

Specified by:

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

See Also:

AbstractMavenReport.getSiteRenderer()

constructXRefLocation

protected java.lang.String constructXRefLocation(boolean test)

getFilesToProcess

protected java.util.Map getFilesToProcess()
                                   throws java.io.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:

java.io.IOException

isHtml

protected boolean isHtml()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

See Also:

AbstractMavenReport.canGenerateReport()

getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:

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

See Also:

AbstractMavenReport.getOutputDirectory()