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, includeXmlInReports, session, showPmdLog, skipEmptyReport, targetDirectory

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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(org.codehaus.plexus.i18n.I18N i18n, CpdServiceExecutor serviceExecutor)

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
protected String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
String	getOutputName()	Deprecated.
String	getOutputPath()

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

canGenerateReportInternal, getAggregatedProjects, getFilesToProcess, getJdkToolchain, getMojoExecution, getProject, getReactorProjects, isAggregator, isXml

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

@Inject
public CpdReport(org.codehaus.plexus.i18n.I18N i18n,
 CpdServiceExecutor serviceExecutor)

Method Details

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getI18nString

protected String getI18nString(Locale locale,
 String key)

Parameters:

locale - The locale

key - The key to search for

Returns:

The text appropriate for the 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()
                          throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Overrides:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

@Deprecated
public String getOutputName()

Deprecated.

getOutputPath

public String getOutputPath()