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.reporting.MavenReport, org.apache.maven.plugin.Mojo

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 java.lang.String	format Set the output format type, in addition to the HTML report.
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.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()
protected java.lang.String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
protected boolean	isHtml()

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

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

Constructor Detail

AbstractPmdReport

public AbstractPmdReport()

Method Detail

getProject

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

See Also:

AbstractMavenReport.getSiteRenderer()

constructXRefLocation

protected java.lang.String constructXRefLocation()

isHtml

protected boolean isHtml()

canGenerateReport

public boolean canGenerateReport()

See Also:

AbstractMavenReport.canGenerateReport()

getOutputDirectory

protected java.lang.String getOutputDirectory()

See Also:

AbstractMavenReport.getOutputDirectory()