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:
ContextEnabled
,Mojo
,MavenMultiPageReport
,MavenReport
- Direct Known Subclasses:
AggregatorCpdReport
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
net.sourceforge.pmd.cpd.renderer.CPDRenderer
Deprecated.void
executeReport
(Locale locale) getDescription
(Locale locale) 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
-
Constructor Details
-
CpdReport
public CpdReport()
-
-
Method Details
-
getName
-
getDescription
-
executeReport
- Specified by:
executeReport
in classAbstractMavenReport
- Throws:
MavenReportException
-
canGenerateReport
public boolean canGenerateReport()Description copied from class:AbstractPmdReport
- Specified by:
canGenerateReport
in interfaceMavenReport
- Overrides:
canGenerateReport
in classAbstractPmdReport
-
getOutputName
-
createRenderer
@Deprecated public net.sourceforge.pmd.cpd.renderer.CPDRenderer createRenderer() throws MavenReportExceptionDeprecated.UseCpdExecutor.createRenderer(String, String)
instead.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
-
CpdExecutor.createRenderer(String, String)
instead.