Package org.apache.maven.plugins.pmd

Klasse 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

Alle implementierten Schnittstellen:

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

Bekannte direkte Unterklassen:

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.

Seit:

2.0

Version:

$Id$

Autor:

Mike Perham

Feldübersicht

Von Klasse geerbte Felder org.apache.maven.plugins.pmd.AbstractPmdReport

aggregate, excludeFromFailureFile, filesToProcess, format, includeTests, includeXmlInSite, reactorProjects, session, showPmdLog, skipEmptyReport, targetDirectory

Von Klasse geerbte Felder org.apache.maven.reporting.AbstractMavenReport

localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool

Von Schnittstelle geerbte Felder org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Von Schnittstelle geerbte Felder org.apache.maven.plugin.Mojo

ROLE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CpdReport()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	canGenerateReport()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
protected String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
String	getOutputName()

Von Klasse geerbte Methoden org.apache.maven.plugins.pmd.AbstractPmdReport

constructXRefLocation, determineCurrentRootLogLevel, getAggregatedProjects, getFilesToProcess, getProject, getToolchain, isAggregator, isXml

Von Klasse geerbte Methoden org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory

Von Klasse geerbte Methoden org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

CpdReport

public CpdReport()

Methodendetails

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getI18nString

protected String getI18nString(Locale locale,
 String key)

Parameter:

locale - The locale

key - The key to search for

Gibt zurück:

The text appropriate for the locale.

executeReport

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

Angegeben von:

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

Löst aus:

org.apache.maven.reporting.MavenReportException

canGenerateReport

public boolean canGenerateReport()

Beschreibung aus Klasse kopiert: AbstractPmdReport

Angegeben von:

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

Setzt außer Kraft:

canGenerateReport in Klasse AbstractPmdReport

getOutputName

public String getOutputName()