A

AbstractPmdReport - Class in org.apache.maven.plugin.pmd

Base class for the PMD reports.

AbstractPmdReport() - Constructor for class org.apache.maven.plugin.pmd.AbstractPmdReport

 

AbstractPmdViolationCheckMojo<D> - Class in org.apache.maven.plugin.pmd

Base class for mojos that check if there were any PMD violations.

AbstractPmdViolationCheckMojo() - Constructor for class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

addDuplication(Duplication) - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Method addDuplication.

addFile(CpdFile) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Method addFile.

addFile(PmdFile) - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Method addFile.

addViolation(Violation) - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Method addViolation.

aggregate - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

Whether to build an aggregated report at the root, or build individual reports.

aggregate - Variable in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

Whether to build an aggregated report at the root, or build individual reports.

apply(List<? extends Node>, RuleContext) - Method in class org.apache.maven.plugin.pmd.rules.DummyRule

 

asReport() - Method in class org.apache.maven.plugin.pmd.PmdReportListener

Create a new single report with all violations for further rendering into other formats than HTML.

B

beginDocument() - Method in class org.apache.maven.plugin.pmd.CpdReportGenerator

Method that generates the start of the CPD report.

beginDocument() - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

C

canGenerateReport() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

canGenerateReport() - Method in class org.apache.maven.plugin.pmd.CpdReport

 

canGenerateReport() - Method in class org.apache.maven.plugin.pmd.PmdReport

 

constructXRefLocation(boolean) - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

 

CpdErrorDetail - Class in org.apache.maven.plugin.pmd.model

Class CpdErrorDetail.

CpdErrorDetail() - Constructor for class org.apache.maven.plugin.pmd.model.CpdErrorDetail

 

CpdFile - Class in org.apache.maven.plugin.pmd.model

Class CpdFile.

CpdFile() - Constructor for class org.apache.maven.plugin.pmd.model.CpdFile

 

CpdReport - Class in org.apache.maven.plugin.pmd

Creates a report for PMD's CPD tool.

CpdReport() - Constructor for class org.apache.maven.plugin.pmd.CpdReport

 

CpdReportGenerator - Class in org.apache.maven.plugin.pmd

Class that generated the CPD report.

CpdReportGenerator(Sink, Map<File, PmdFileInfo>, ResourceBundle, boolean) - Constructor for class org.apache.maven.plugin.pmd.CpdReportGenerator

 

CpdViolationCheckMojo - Class in org.apache.maven.plugin.pmd

Fail the build if there were any CPD violations in the source code.

CpdViolationCheckMojo() - Constructor for class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

CpdXpp3Reader - Class in org.apache.maven.plugin.pmd.model.io.xpp3

Class CpdXpp3Reader.

CpdXpp3Reader() - Constructor for class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

 

createRenderer() - Method in class org.apache.maven.plugin.pmd.CpdReport

Create and return the correct renderer for the output type.

createRenderer() - Method in class org.apache.maven.plugin.pmd.PmdReport

Create and return the correct renderer for the output type.

D

DummyRule - Class in org.apache.maven.plugin.pmd.rules

A dummy rule that does nothing.

DummyRule() - Constructor for class org.apache.maven.plugin.pmd.rules.DummyRule

 

Duplication - Class in org.apache.maven.plugin.pmd.model

Class Duplication.

Duplication() - Constructor for class org.apache.maven.plugin.pmd.model.Duplication

 

E

endDocument() - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

execute() - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

execute() - Method in class org.apache.maven.plugin.pmd.HelpMojo

execute() - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

executeCheck(String, String, String, int) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

executeReport(Locale) - Method in class org.apache.maven.plugin.pmd.CpdReport

executeReport(Locale) - Method in class org.apache.maven.plugin.pmd.PmdReport

F

failOnViolation - Variable in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

Whether to fail the build if the validation check fails.

failOnViolation - Variable in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

Whether to fail the build if the validation check fails.

filesToProcess - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

The files that are being analyzed.

format - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

Set the output format type, in addition to the HTML report.

G

generate(Iterator<Match>) - Method in class org.apache.maven.plugin.pmd.CpdReportGenerator

Method that generates the contents of the CPD report

getAddDefaultEntities() - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

Returns the state of the "add default entities" flag.

getAddDefaultEntities() - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

Returns the state of the "add default entities" flag.

getBeginline() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the beginline field.

getCodefragment() - Method in class org.apache.maven.plugin.pmd.model.Duplication

Get the codefragment field.

getDescription(Locale) - Method in class org.apache.maven.plugin.pmd.CpdReport

getDescription(Locale) - Method in class org.apache.maven.plugin.pmd.PmdReport

getDuplications() - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Method getDuplications.

getErrorDetails(File) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

Gets the attributes and text for the violation tag and puts them in a HashMap

getErrorDetails(File) - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

Gets the attributes and text for the violation tag and puts them in a HashMap

getErrorDetails(File) - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

getFailureDetails() - Method in class org.apache.maven.plugin.pmd.ViolationDetails

 

getFileName() - Method in class org.apache.maven.plugin.pmd.model.Violation

 

getFiles() - Method in class org.apache.maven.plugin.pmd.model.Duplication

Method getFiles.

getFiles() - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Method getFiles.

getFilesToProcess() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

Convenience method to get the list of files where the PMD tool will be executed

getLine() - Method in class org.apache.maven.plugin.pmd.model.CpdFile

Get the line field.

getLines() - Method in class org.apache.maven.plugin.pmd.model.Duplication

Get the lines field.

getLocationTemp(String) - Method in class org.apache.maven.plugin.pmd.PmdReport

Convenience method to get the location of the specified file name.

getModelEncoding() - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Get the modelEncoding field.

getModelEncoding() - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Get the modelEncoding field.

getName(Locale) - Method in class org.apache.maven.plugin.pmd.CpdReport

getName() - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Get the name field.

getName(Locale) - Method in class org.apache.maven.plugin.pmd.PmdReport

getOutputDirectory() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

getOutputEncoding() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

Gets the effective reporting output files encoding.

getOutputName() - Method in class org.apache.maven.plugin.pmd.CpdReport

getOutputName() - Method in class org.apache.maven.plugin.pmd.PmdReport

getPath() - Method in class org.apache.maven.plugin.pmd.model.CpdFile

Get the path field.

getPMDConfiguration() - Method in class org.apache.maven.plugin.pmd.PmdReport

Constructs the PMD configuration class, passing it an argument that configures the target JDK.

getPriority(D) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

getPriority(Duplication) - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

getPriority() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the priority field.

getPriority(Violation) - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

getProject() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

getProject() - Method in class org.apache.maven.plugin.pmd.PmdFileInfo

 

getRule() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the rule field.

getSiteRenderer() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

getSourceDirectory() - Method in class org.apache.maven.plugin.pmd.PmdFileInfo

 

getSourceEncoding() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

 

getText() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the text field.

getTokens() - Method in class org.apache.maven.plugin.pmd.model.Duplication

Get the tokens field.

getViolationClass() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the violationClass field.

getViolationPackage() - Method in class org.apache.maven.plugin.pmd.model.Violation

Get the violationPackage field.

getViolations() - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Method getViolations.

getViolations() - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

getViolations() - Method in class org.apache.maven.plugin.pmd.PmdReportListener

 

getWarningDetails() - Method in class org.apache.maven.plugin.pmd.ViolationDetails

 

getXrefLocation() - Method in class org.apache.maven.plugin.pmd.PmdFileInfo

 

H

hasViolations() - Method in class org.apache.maven.plugin.pmd.PmdReportListener

 

HelpMojo - Class in org.apache.maven.plugin.pmd

Display help information on maven-pmd-plugin.

HelpMojo() - Constructor for class org.apache.maven.plugin.pmd.HelpMojo

 

I

includeTests - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

Run PMD on the tests.

includeXmlInSite - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

Whether to include the xml files generated by PMD/CPD in the site.

isExcludedFromFailure(D) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

isExcludedFromFailure(Duplication) - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

isExcludedFromFailure(Violation) - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

isFailOnViolation() - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

isFailOnViolation() - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

isHtml() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

 

isXml() - Method in class org.apache.maven.plugin.pmd.AbstractPmdReport

 

L

loadExcludeFromFailuresData(String) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

loadExcludeFromFailuresData(String) - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

loadExcludeFromFailuresData(String) - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

M

metricAdded(Metric) - Method in class org.apache.maven.plugin.pmd.PmdReportListener

N

newViolationDetailsInstance() - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

 

newViolationDetailsInstance() - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

 

newViolationDetailsInstance() - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

O

org.apache.maven.plugin.pmd - package org.apache.maven.plugin.pmd

 

org.apache.maven.plugin.pmd.model - package org.apache.maven.plugin.pmd.model

 

org.apache.maven.plugin.pmd.model.io.xpp3 - package org.apache.maven.plugin.pmd.model.io.xpp3

 

org.apache.maven.plugin.pmd.rules - package org.apache.maven.plugin.pmd.rules

 

outputDirectory - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

The output directory for the final HTML report.

P

PmdErrorDetail - Class in org.apache.maven.plugin.pmd.model

Class PmdErrorDetail.

PmdErrorDetail() - Constructor for class org.apache.maven.plugin.pmd.model.PmdErrorDetail

 

PmdFile - Class in org.apache.maven.plugin.pmd.model

Class PmdFile.

PmdFile() - Constructor for class org.apache.maven.plugin.pmd.model.PmdFile

 

PmdFileInfo - Class in org.apache.maven.plugin.pmd

 

PmdFileInfo(MavenProject, File, String) - Constructor for class org.apache.maven.plugin.pmd.PmdFileInfo

 

PmdReport - Class in org.apache.maven.plugin.pmd

Creates a PMD report.

PmdReport() - Constructor for class org.apache.maven.plugin.pmd.PmdReport

 

PmdReportGenerator - Class in org.apache.maven.plugin.pmd

Render the PMD violations into Doxia events.

PmdReportGenerator(Log, Sink, ResourceBundle, boolean) - Constructor for class org.apache.maven.plugin.pmd.PmdReportGenerator

 

PmdReportListener - Class in org.apache.maven.plugin.pmd

Handle events from PMD and collect violations.

PmdReportListener() - Constructor for class org.apache.maven.plugin.pmd.PmdReportListener

 

PmdViolationCheckMojo - Class in org.apache.maven.plugin.pmd

Fail the build if there were any PMD violations in the source code.

PmdViolationCheckMojo() - Constructor for class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

 

PmdXpp3Reader - Class in org.apache.maven.plugin.pmd.model.io.xpp3

Class PmdXpp3Reader.

PmdXpp3Reader() - Constructor for class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

 

printError(D, String) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

Formats the failure details and prints them as an INFO message

printError(Duplication, String) - Method in class org.apache.maven.plugin.pmd.CpdViolationCheckMojo

Formats the failure details and prints them as an INFO message

printError(Violation, String) - Method in class org.apache.maven.plugin.pmd.PmdViolationCheckMojo

Formats the failure details and prints them as an INFO message

printErrors(List<D>, List<D>) - Method in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

Prints the warnings and failures

project - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

The project to analyse.

project - Variable in class org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo

The project to analyze.

R

reactorProjects - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

The projects in the reactor for aggregation report.

read(Reader, boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

 

read(Reader) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

 

read(InputStream, boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

Method read.

read(Reader, boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

 

read(Reader) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

 

read(InputStream, boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

Method read.

removeDuplication(Duplication) - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Method removeDuplication.

removeFile(CpdFile) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Method removeFile.

removeFile(PmdFile) - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Method removeFile.

removeViolation(Violation) - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Method removeViolation.

render() - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

ruleViolationAdded(RuleViolation) - Method in class org.apache.maven.plugin.pmd.PmdReportListener

S

setAddDefaultEntities(boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.CpdXpp3Reader

Sets the state of the "add default entities" flag.

setAddDefaultEntities(boolean) - Method in class org.apache.maven.plugin.pmd.model.io.xpp3.PmdXpp3Reader

Sets the state of the "add default entities" flag.

setBeginline(int) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the beginline field.

setCodefragment(String) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Set the codefragment field.

setDuplications(List<Duplication>) - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Set the duplications field.

setFailureDetails(List<D>) - Method in class org.apache.maven.plugin.pmd.ViolationDetails

 

setFileName(String) - Method in class org.apache.maven.plugin.pmd.model.Violation

 

setFiles(List<CpdFile>) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Set the files field.

setFiles(List<PmdFile>) - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Set the files field.

setFiles(Map<File, PmdFileInfo>) - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

setLine(int) - Method in class org.apache.maven.plugin.pmd.model.CpdFile

Set the line field.

setLines(int) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Set the lines field.

setModelEncoding(String) - Method in class org.apache.maven.plugin.pmd.model.CpdErrorDetail

Set the modelEncoding field.

setModelEncoding(String) - Method in class org.apache.maven.plugin.pmd.model.PmdErrorDetail

Set the modelEncoding field.

setName(String) - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Set the name field.

setPath(String) - Method in class org.apache.maven.plugin.pmd.model.CpdFile

Set the path field.

setPriority(int) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the priority field.

setRule(String) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the rule field.

setRulesets(String[]) - Method in class org.apache.maven.plugin.pmd.PmdReport

 

setText(String) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the text field.

setTokens(int) - Method in class org.apache.maven.plugin.pmd.model.Duplication

Set the tokens field.

setViolationClass(String) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the violationClass field.

setViolationPackage(String) - Method in class org.apache.maven.plugin.pmd.model.Violation

Set the violationPackage field.

setViolations(List<Violation>) - Method in class org.apache.maven.plugin.pmd.model.PmdFile

Set the violations field.

setViolations(Collection<RuleViolation>) - Method in class org.apache.maven.plugin.pmd.PmdReportGenerator

 

setWarningDetails(List<D>) - Method in class org.apache.maven.plugin.pmd.ViolationDetails

 

skipEmptyReport - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

Skip the PMD/CPD report generation if there are no violations or duplications found.

T

targetDirectory - Variable in class org.apache.maven.plugin.pmd.AbstractPmdReport

The output directory for the intermediate XML report.

V

Violation - Class in org.apache.maven.plugin.pmd.model

Class Violation.

Violation() - Constructor for class org.apache.maven.plugin.pmd.model.Violation

 

ViolationDetails<D> - Class in org.apache.maven.plugin.pmd

Collector of warnings and failures.

ViolationDetails() - Constructor for class org.apache.maven.plugin.pmd.ViolationDetails