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
@Mojo(name="cpd", threadSafe=true) public class CpdReport extends AbstractPmdReport
Creates a report for PMD's CPD tool. 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
Constructors Constructor Description CpdReport()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canGenerateReport()
net.sourceforge.pmd.cpd.renderer.CPDRenderer
createRenderer()
Deprecated.UseCpdExecutor.createRenderer(String, String)
instead.void
executeReport(java.util.Locale locale)
java.lang.String
getDescription(java.util.Locale locale)
java.lang.String
getName(java.util.Locale locale)
java.lang.String
getOutputName()
-
Methods inherited from class org.apache.maven.plugins.pmd.AbstractPmdReport
constructXRefLocation, determineCurrentRootLogLevel, getFilesToProcess, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, getSourceEncoding, getToolchain, 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
-
-
-
-
Method Detail
-
getName
public java.lang.String getName(java.util.Locale locale)
-
getDescription
public java.lang.String getDescription(java.util.Locale locale)
-
executeReport
public void executeReport(java.util.Locale locale) throws MavenReportException
- 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
public java.lang.String getOutputName()
-
createRenderer
@Deprecated public net.sourceforge.pmd.cpd.renderer.CPDRenderer createRenderer() throws MavenReportException
Deprecated.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
-
-