org.apache.maven.plugin.pmd
Class PmdReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.pmd.AbstractPmdReport
              org.apache.maven.plugin.pmd.PmdReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

public class PmdReport
extends AbstractPmdReport

Creates a PMD report.

Since:

2.0

Version:

$Id: PmdReport.html 816691 2012-05-08 15:16:42Z hboutemy $

Author:

Brett Porter

Is defined by the goal name:

pmd

Field Summary

Fields inherited from class org.apache.maven.plugin.pmd.AbstractPmdReport

aggregate, format, includeTests, outputDirectory, project, reactorProjects, targetDirectory

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

PmdReport()

Method Summary

Renderer	createRenderer() Create and return the correct renderer for the output type.
void	executeReport(Locale locale)
String	getDescription(Locale locale)
protected String	getLocationTemp(String name) Convenience method to get the location of the specified file name.
String	getName(Locale locale)
String	getOutputName()
PMD	getPMD() Constructs the PMD class, passing it an argument that configures the target JDK.
void	setRulesets(String[] rules)

Methods inherited from class org.apache.maven.plugin.pmd.AbstractPmdReport

canGenerateReport, constructXRefLocation, getFilesToProcess, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, getSourceEncoding, isHtml

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

closeReport, execute, 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

Constructor Detail

PmdReport

public PmdReport()

Method Detail

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

setRulesets

public void setRulesets(String[] rules)

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

getLocationTemp

protected String getLocationTemp(String name)

Convenience method to get the location of the specified file name.

Parameters:

name - the name of the file whose location is to be resolved

Returns:

a String that contains the absolute file name of the file

getPMD

public PMD getPMD()
           throws MavenReportException

Constructs the PMD class, passing it an argument that configures the target JDK.

Returns:

the resulting PMD

Throws:

MavenReportException - if targetJdk is not supported

getOutputName

public String getOutputName()

createRenderer

public final Renderer createRenderer()
                              throws MavenReportException

Create and return the correct renderer for the output type.

Returns:

the renderer based on the configured output

Throws:

MavenReportException - if no renderer found for the output type