org.apache.maven.plugin.pmd
Class CpdReport

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

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

public class CpdReport
extends AbstractPmdReport

Creates a report for PMD's CPD tool. See http://pmd.sourceforge.net/cpd.html for more detail.

Since:

2.0

Version:

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

Author:

Mike Perham

Is defined by the goal name:

cpd

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

CpdReport()

Method Summary

Renderer	createRenderer() Create and return the correct renderer for the output type.
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()

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

CpdReport

public CpdReport()

Method Detail

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

getOutputName

public String getOutputName()

createRenderer

public 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