Package org.apache.maven.plugins.pmd

Class CpdReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.pmd.AbstractPmdReport

org.apache.maven.plugins.pmd.CpdReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AggregatorCpdReport

@Mojo(name="cpd",
      threadSafe=true)
public class CpdReport
extends AbstractPmdReport

Creates a report for PMD's Copy/Paste Detector (CPD) tool. It can also generate a cpd results file in any of these formats: xml, csv or txt.

See Finding duplicated code for more details.

Since:

2.0

Version:

$Id$

Author:

Mike Perham

Field Summary

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

aggregate, excludeFromFailureFile, filesToProcess, format, includeTests, includeXmlInSite, outputDirectory, project, reactorProjects, session, showPmdLog, skipEmptyReport, 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

Constructors

Constructor	Description
CpdReport()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
net.sourceforge.pmd.cpd.renderer.CPDRenderer	createRenderer()	Deprecated. Use CpdExecutor.createRenderer(String, String) instead.
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()

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

constructXRefLocation, determineCurrentRootLogLevel, getAggregatedProjects, getFilesToProcess, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, getSourceEncoding, getToolchain, isAggregator, isXml

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, 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 Details

CpdReport

public CpdReport()

Method Details

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

canGenerateReport

public boolean canGenerateReport()

Description copied from class: AbstractPmdReport

Specified by:

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

Overrides:

canGenerateReport in class AbstractPmdReport

getOutputName

public String getOutputName()

createRenderer

@Deprecated
public net.sourceforge.pmd.cpd.renderer.CPDRenderer createRenderer()
                                                            throws org.apache.maven.reporting.MavenReportException

Deprecated.

Use CpdExecutor.createRenderer(String, String) instead.

Create and return the correct renderer for the output type.

Returns:

the renderer based on the configured output

Throws:

org.apache.maven.reporting.MavenReportException - if no renderer found for the output type