CpdReport (Apache Maven PMD Plugin 3.4 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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
```
@Mojo(name="cpd",
      threadSafe=true)
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 938498 2015-01-31 17:43:24Z michaelo $

Author:

Mike Perham

Field Summary
- Fields inherited from class org.apache.maven.plugin.pmd.AbstractPmdReport
  aggregate, filesToProcess, format, includeTests, includeXmlInSite, outputDirectory, project, reactorProjects, 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 and Description

CpdReport()

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canGenerateReport()`
`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
constructXRefLocation, getFilesToProcess, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, getSourceEncoding, isHtml, 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 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
  - canGenerateReport
```
public boolean canGenerateReport()
```
    Description copied from class: AbstractPmdReport
    
    Specified by:
    
    canGenerateReport in interface MavenReport
    
    Overrides:
    
    canGenerateReport in class AbstractPmdReport
  - 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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.