Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractPmdReport - Class in org.apache.maven.plugins.pmd
-
Base class for the PMD reports.
- AbstractPmdReport() - Constructor for class org.apache.maven.plugins.pmd.AbstractPmdReport
- AbstractPmdViolationCheckMojo<D> - Class in org.apache.maven.plugins.pmd
-
Base class for mojos that check if there were any PMD violations.
- AbstractPmdViolationCheckMojo(ExcludeFromFile<D>) - Constructor for class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
Initialize this abstract check mojo by giving the correct ExcludeFromFile helper.
- addDuplication(Duplication) - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Method addDuplication.
- addError(ProcessingError) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method addError.
- addFile(CpdFile) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Method addFile.
- addFile(PmdFile) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method addFile.
- addFiles(Collection<File>) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- addFiles(Collection<File>) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- addSuppressedViolation(SuppressedViolation) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method addSuppressedViolation.
- addViolation(Violation) - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Method addViolation.
- aggregate - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Deprecated.
- aggregate - Variable in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
Deprecated.since 3.15.0 Use the goal
pmd:aggregate-check
orpmd:aggregate-cpd-check
instead. - AggregatorCpdReport - Class in org.apache.maven.plugins.pmd
-
Creates a report for PMD's Copy/Paste Detector (CPD) tool in an aggregator project.
- AggregatorCpdReport(I18N, CpdServiceExecutor) - Constructor for class org.apache.maven.plugins.pmd.AggregatorCpdReport
- AggregatorCpdViolationCheckMojo - Class in org.apache.maven.plugins.pmd
-
Fail the build in an aggregator project if there were any CPD violations in the source code.
- AggregatorCpdViolationCheckMojo() - Constructor for class org.apache.maven.plugins.pmd.AggregatorCpdViolationCheckMojo
- AggregatorPmdNoForkReport - Class in org.apache.maven.plugins.pmd
-
Creates a PMD site report in an aggregator project without forking the
test-compile
phase again. - AggregatorPmdNoForkReport(ResourceManager, ConfigurationService, I18N, PmdServiceExecutor) - Constructor for class org.apache.maven.plugins.pmd.AggregatorPmdNoForkReport
- AggregatorPmdReport - Class in org.apache.maven.plugins.pmd
-
Creates a PMD site report in an aggregator project based on the rulesets and configuration set in the plugin.
- AggregatorPmdReport(ResourceManager, ConfigurationService, I18N, PmdServiceExecutor) - Constructor for class org.apache.maven.plugins.pmd.AggregatorPmdReport
- AggregatorPmdViolationCheckMojo - Class in org.apache.maven.plugins.pmd
-
Fails the build in an aggregator project if there were any PMD violations in the source code.
- AggregatorPmdViolationCheckMojo() - Constructor for class org.apache.maven.plugins.pmd.AggregatorPmdViolationCheckMojo
B
- buildClasspath() - Static method in class org.apache.maven.plugins.pmd.exec.CpdExecutor
- buildClasspath() - Static method in class org.apache.maven.plugins.pmd.exec.PmdExecutor
C
- canGenerateReport() - Method in class org.apache.maven.plugins.pmd.CpdReport
- canGenerateReport() - Method in class org.apache.maven.plugins.pmd.PmdReport
- canGenerateReportInternal() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- ConfigurationService - Class in org.apache.maven.plugins.pmd
-
utils service for provide configuration needed to execute CPD/PMD.
- ConfigurationService(Provider<MavenSession>, RepositorySystem) - Constructor for class org.apache.maven.plugins.pmd.ConfigurationService
- contentTransformer - Variable in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Field contentTransformer.
- contentTransformer - Variable in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Field contentTransformer.
- countExclusions() - Method in class org.apache.maven.plugins.pmd.ExcludeDuplicationsFromFile
- countExclusions() - Method in interface org.apache.maven.plugins.pmd.ExcludeFromFile
-
Determines how many exclusions are considered.
- countExclusions() - Method in class org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
- CpdErrorDetail - Class in org.apache.maven.plugins.pmd.model
-
Class CpdErrorDetail.
- CpdErrorDetail() - Constructor for class org.apache.maven.plugins.pmd.model.CpdErrorDetail
- CpdExecutor - Class in org.apache.maven.plugins.pmd.exec
-
Executes CPD with the configuration provided via
CpdRequest
. - CpdExecutor(CpdRequest) - Constructor for class org.apache.maven.plugins.pmd.exec.CpdExecutor
- CpdFile - Class in org.apache.maven.plugins.pmd.model
-
Class CpdFile.
- CpdFile() - Constructor for class org.apache.maven.plugins.pmd.model.CpdFile
- CpdReport - Class in org.apache.maven.plugins.pmd
-
Creates a report for PMD's Copy/Paste Detector (CPD) tool.
- CpdReport(I18N, CpdServiceExecutor) - Constructor for class org.apache.maven.plugins.pmd.CpdReport
- CpdReportRenderer - Class in org.apache.maven.plugins.pmd
-
Class that generated the CPD report.
- CpdReportRenderer(Sink, I18N, Locale, Map<File, PmdFileInfo>, Collection<Duplication>, boolean) - Constructor for class org.apache.maven.plugins.pmd.CpdReportRenderer
- CpdRequest - Class in org.apache.maven.plugins.pmd.exec
-
Data object to store all configuration options needed to execute CPD as a separate process.
- CpdRequest() - Constructor for class org.apache.maven.plugins.pmd.exec.CpdRequest
- CpdResult - Class in org.apache.maven.plugins.pmd.exec
-
Provides access to the result of the CPD analysis.
- CpdResult(File, String) - Constructor for class org.apache.maven.plugins.pmd.exec.CpdResult
- CpdServiceExecutor - Class in org.apache.maven.plugins.pmd.exec
-
Service for executing CPD.
- CpdServiceExecutor(ToolchainManager, Provider<MavenSession>) - Constructor for class org.apache.maven.plugins.pmd.exec.CpdServiceExecutor
- CpdViolationCheckMojo - Class in org.apache.maven.plugins.pmd
-
Fails the build if there were any CPD violations in the source code.
- CpdViolationCheckMojo() - Constructor for class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
-
Default constructor.
- CpdXpp3Reader - Class in org.apache.maven.plugins.pmd.model.io.xpp3
-
Class CpdXpp3Reader.
- CpdXpp3Reader() - Constructor for class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
- CpdXpp3Reader(CpdXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
- CpdXpp3Reader.ContentTransformer - Interface in org.apache.maven.plugins.pmd.model.io.xpp3
- createRenderer() - Method in class org.apache.maven.plugins.pmd.PmdReport
-
Deprecated.Use
PmdExecutor.createRenderer(String, String)
instead. - createRenderer(String, String) - Static method in class org.apache.maven.plugins.pmd.exec.CpdExecutor
-
Create and return the correct renderer for the output type.
- createRenderer(String, String) - Static method in class org.apache.maven.plugins.pmd.exec.PmdExecutor
-
Create and return the correct renderer for the output type.
D
- Duplication - Class in org.apache.maven.plugins.pmd.model
-
Class Duplication.
- Duplication() - Constructor for class org.apache.maven.plugins.pmd.model.Duplication
E
- EMPTY - Static variable in class org.apache.maven.plugins.pmd.exec.PmdResult
- ExcludeDuplicationsFromFile - Class in org.apache.maven.plugins.pmd
-
This class contains utility methods to load property files which define which files should be excluded from the CPD duplication results.
- ExcludeDuplicationsFromFile() - Constructor for class org.apache.maven.plugins.pmd.ExcludeDuplicationsFromFile
- excludeFromFailureFile - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
File that lists classes and rules to be excluded from failures.
- ExcludeFromFile<D> - Interface in org.apache.maven.plugins.pmd
- ExcludeViolationsFromFile - Class in org.apache.maven.plugins.pmd
-
This class contains utility for loading property files, which define which PMD violations from which classes should be ignored and not cause a failure.
- ExcludeViolationsFromFile() - Constructor for class org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
- execute() - Method in class org.apache.maven.plugins.maven_pmd_plugin.HelpMojo
- execute() - Method in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
- execute() - Method in class org.apache.maven.plugins.pmd.PmdViolationCheckMojo
- execute(CpdRequest) - Method in class org.apache.maven.plugins.pmd.exec.CpdServiceExecutor
- execute(PmdRequest) - Method in class org.apache.maven.plugins.pmd.exec.PmdServiceExecutor
- executeCheck(String, String, String, int) - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- executeReport(Locale) - Method in class org.apache.maven.plugins.pmd.CpdReport
- executeReport(Locale) - Method in class org.apache.maven.plugins.pmd.PmdReport
F
- failOnViolation - Variable in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
Whether to fail the build if the validation check fails.
- failOnViolation - Variable in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
-
Whether to fail the build if the validation check fails.
- filesToProcess - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
The files that are being analyzed.
- fork(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdExecutor
- fork(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdExecutor
- format - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Set the output format type, in addition to the HTML report.
G
- getAddDefaultEntities() - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAddDefaultEntities() - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAggregatedProjects() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- getAnalysisCacheLocation() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getAuxClasspath() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getBeginline() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the beginline field.
- getBenchmarkOutputLocation() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getCodefragment() - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Get the codefragment field.
- getDescription(Locale) - Method in class org.apache.maven.plugins.pmd.CpdReport
- getDescription(Locale) - Method in class org.apache.maven.plugins.pmd.PmdReport
- getDetail() - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Get the detail field.
- getDuplications() - Method in class org.apache.maven.plugins.pmd.exec.CpdResult
- getDuplications() - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Method getDuplications.
- getEndline() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the endline field.
- getErrorDetails(File) - Method in class org.apache.maven.plugins.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.plugins.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.plugins.pmd.PmdViolationCheckMojo
- getErrors() - Method in class org.apache.maven.plugins.pmd.exec.PmdResult
- getErrors() - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method getErrors.
- getExcludeFromFailureFile() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getExcludeFromFailureFile() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getExternalInfoUrl() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the externalInfoUrl field.
- getFailureDetails() - Method in class org.apache.maven.plugins.pmd.ViolationDetails
- getFilename() - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Get the filename field.
- getFilename() - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Get the filename field.
- getFileName() - Method in class org.apache.maven.plugins.pmd.model.Violation
- getFiles() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getFiles() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getFiles() - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Method getFiles.
- getFiles() - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method getFiles.
- getFilesToProcess() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Convenience method to get files the PMD tool will analyze.
- getFormat() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getFormat() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getI18nString(Locale, String) - Method in class org.apache.maven.plugins.pmd.CpdReport
- getI18nString(Locale, String) - Method in class org.apache.maven.plugins.pmd.PmdReport
- getJavaExecutable(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.CpdServiceExecutor
- getJavaExecutable(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.PmdServiceExecutor
- getJdkToolchain() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- getJdkToolchain() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getJdkToolchain() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getLanguage() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getLanguage() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getLanguageProperties() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getLanguageVersion() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getLine() - Method in class org.apache.maven.plugins.pmd.model.CpdFile
-
Get the line field.
- getLines() - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Get the lines field.
- getLocationTemp(String, int) - Method in class org.apache.maven.plugins.pmd.PmdReport
-
Convenience method to get the location of the specified file name.
- getLogLevel() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getMaxAllowedViolations() - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- getMinimumPriority() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getMinimumTokens() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getModelEncoding() - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Get the modelEncoding field.
- getModelEncoding() - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Get the modelEncoding field.
- getMojoExecution() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- getMsg() - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Get the msg field.
- getName() - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Get the name field.
- getName(Locale) - Method in class org.apache.maven.plugins.pmd.CpdReport
- getName(Locale) - Method in class org.apache.maven.plugins.pmd.PmdReport
- getOutputEncoding() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getOutputEncoding() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getOutputName() - Method in class org.apache.maven.plugins.pmd.CpdReport
-
Deprecated.
- getOutputName() - Method in class org.apache.maven.plugins.pmd.PmdReport
-
Deprecated.
- getOutputPath() - Method in class org.apache.maven.plugins.pmd.CpdReport
- getOutputPath() - Method in class org.apache.maven.plugins.pmd.PmdReport
- getPath() - Method in class org.apache.maven.plugins.pmd.model.CpdFile
-
Get the path field.
- getPriority() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the priority field.
- getPriority(D) - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- getPriority(Duplication) - Method in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
- getPriority(Violation) - Method in class org.apache.maven.plugins.pmd.PmdViolationCheckMojo
- getProject() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- getProject() - Method in class org.apache.maven.plugins.pmd.PmdFileInfo
- getReactorProjects() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- getReportOutputDirectory() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getReportOutputDirectory() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getRule() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the rule field.
- getRuleMessage() - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Get the ruleMessage field.
- getRulesets() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getSourceDirectory() - Method in class org.apache.maven.plugins.pmd.PmdFileInfo
- getSourceEncoding() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getSourceEncoding() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getSuppressedViolations() - Method in class org.apache.maven.plugins.pmd.exec.PmdResult
- getSuppressedViolations() - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method getSuppressedViolations.
- getSuppressionType() - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Get the suppressionType field.
- getSuppressMarker() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getTargetDirectory() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- getTargetDirectory() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- getText() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the text field.
- getTitle() - Method in class org.apache.maven.plugins.pmd.CpdReportRenderer
- getTitle() - Method in class org.apache.maven.plugins.pmd.PmdReportRenderer
- getTokens() - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Get the tokens field.
- getToolchain(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.CpdServiceExecutor
- getToolchain(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.PmdServiceExecutor
- getUserMessage() - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Get the userMessage field.
- getViolationClass() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the violationClass field.
- getViolationPackage() - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Get the violationPackage field.
- getViolations() - Method in class org.apache.maven.plugins.pmd.exec.PmdResult
- getViolations() - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Method getViolations.
- getWarningDetails() - Method in class org.apache.maven.plugins.pmd.ViolationDetails
- getXrefLocation() - Method in class org.apache.maven.plugins.pmd.PmdFileInfo
H
- hasDuplications() - Method in class org.apache.maven.plugins.pmd.exec.CpdResult
- hasViolations() - Method in class org.apache.maven.plugins.pmd.exec.PmdResult
- HelpMojo - Class in org.apache.maven.plugins.maven_pmd_plugin
-
Display help information on maven-pmd-plugin.
Callmvn pmd:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class org.apache.maven.plugins.maven_pmd_plugin.HelpMojo
I
- includeTests - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Run PMD on the tests as well.
- includeXmlInReports - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Whether to include the XML files generated by PMD/CPD in the
AbstractMavenReport.getReportOutputDirectory()
. - isAggregator() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
- isAggregator() - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- isAggregator() - Method in class org.apache.maven.plugins.pmd.AggregatorCpdReport
- isAggregator() - Method in class org.apache.maven.plugins.pmd.AggregatorCpdViolationCheckMojo
- isAggregator() - Method in class org.apache.maven.plugins.pmd.AggregatorPmdReport
- isAggregator() - Method in class org.apache.maven.plugins.pmd.AggregatorPmdViolationCheckMojo
- isDebugEnabled() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- isExcludedFromFailure(D) - Method in interface org.apache.maven.plugins.pmd.ExcludeFromFile
-
Checks whether the given violation is excluded.
- isExcludedFromFailure(Match) - Method in class org.apache.maven.plugins.pmd.ExcludeDuplicationsFromFile
-
Checks whether the given
Match
is excluded. - isExcludedFromFailure(RuleViolation) - Method in class org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
-
Checks whether the given
RuleViolation
is excluded. - isExcludedFromFailure(Duplication) - Method in class org.apache.maven.plugins.pmd.ExcludeDuplicationsFromFile
- isExcludedFromFailure(Violation) - Method in class org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
- isFailOnViolation() - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- isFailOnViolation() - Method in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
- isIgnoreAnnotations() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- isIgnoreIdentifiers() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- isIgnoreLiterals() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- isIncludeXmlInReports() - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- isIncludeXmlInReports() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- isSkipPmdError() - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- isXml() - Method in class org.apache.maven.plugins.pmd.AbstractPmdReport
L
- loadExcludeFromFailuresData(String) - Method in class org.apache.maven.plugins.pmd.ExcludeDuplicationsFromFile
- loadExcludeFromFailuresData(String) - Method in interface org.apache.maven.plugins.pmd.ExcludeFromFile
-
Loads the exclude definitions from the given file.
- loadExcludeFromFailuresData(String) - Method in class org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
M
- main(String[]) - Static method in class org.apache.maven.plugins.pmd.exec.CpdExecutor
-
Execute CPD analysis from CLI.
- main(String[]) - Static method in class org.apache.maven.plugins.pmd.exec.PmdExecutor
-
Execute PMD analysis from CLI.
N
- newViolationDetailsInstance() - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
- newViolationDetailsInstance() - Method in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
- newViolationDetailsInstance() - Method in class org.apache.maven.plugins.pmd.PmdViolationCheckMojo
O
- org.apache.maven.plugins.maven_pmd_plugin - package org.apache.maven.plugins.maven_pmd_plugin
- org.apache.maven.plugins.pmd - package org.apache.maven.plugins.pmd
- org.apache.maven.plugins.pmd.exec - package org.apache.maven.plugins.pmd.exec
- org.apache.maven.plugins.pmd.model - package org.apache.maven.plugins.pmd.model
- org.apache.maven.plugins.pmd.model.io.xpp3 - package org.apache.maven.plugins.pmd.model.io.xpp3
P
- PmdErrorDetail - Class in org.apache.maven.plugins.pmd.model
-
Class PmdErrorDetail.
- PmdErrorDetail() - Constructor for class org.apache.maven.plugins.pmd.model.PmdErrorDetail
- PmdExecutor - Class in org.apache.maven.plugins.pmd.exec
-
Executes PMD with the configuration provided via
PmdRequest
. - PmdExecutor(PmdRequest) - Constructor for class org.apache.maven.plugins.pmd.exec.PmdExecutor
- PmdFile - Class in org.apache.maven.plugins.pmd.model
-
Class PmdFile.
- PmdFile() - Constructor for class org.apache.maven.plugins.pmd.model.PmdFile
- PmdFileInfo - Class in org.apache.maven.plugins.pmd
- PmdFileInfo(MavenProject, File, String) - Constructor for class org.apache.maven.plugins.pmd.PmdFileInfo
- PmdReport - Class in org.apache.maven.plugins.pmd
-
Creates a PMD site report based on the rulesets and configuration set in the plugin.
- PmdReport(ResourceManager, ConfigurationService, I18N, PmdServiceExecutor) - Constructor for class org.apache.maven.plugins.pmd.PmdReport
- PmdReportRenderer - Class in org.apache.maven.plugins.pmd
-
Render the PMD violations into Doxia events.
- PmdReportRenderer(Log, Sink, I18N, Locale, Map<File, PmdFileInfo>, Collection<Violation>, boolean, boolean, boolean) - Constructor for class org.apache.maven.plugins.pmd.PmdReportRenderer
- PmdRequest - Class in org.apache.maven.plugins.pmd.exec
-
Data object to store all configuration options needed to execute PMD as a separate process.
- PmdRequest() - Constructor for class org.apache.maven.plugins.pmd.exec.PmdRequest
- PmdResult - Class in org.apache.maven.plugins.pmd.exec
-
Provides access to the result of the pmd analysis.
- PmdResult(File, String) - Constructor for class org.apache.maven.plugins.pmd.exec.PmdResult
- PmdServiceExecutor - Class in org.apache.maven.plugins.pmd.exec
-
Service for executing PMD.
- PmdServiceExecutor(ToolchainManager, Provider<MavenSession>) - Constructor for class org.apache.maven.plugins.pmd.exec.PmdServiceExecutor
- PmdViolationCheckMojo - Class in org.apache.maven.plugins.pmd
-
Fails the build if there were any PMD violations in the source code.
- PmdViolationCheckMojo() - Constructor for class org.apache.maven.plugins.pmd.PmdViolationCheckMojo
-
Default constructor.
- PmdXpp3Reader - Class in org.apache.maven.plugins.pmd.model.io.xpp3
-
Class PmdXpp3Reader.
- PmdXpp3Reader() - Constructor for class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
- PmdXpp3Reader(PmdXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
- PmdXpp3Reader.ContentTransformer - Interface in org.apache.maven.plugins.pmd.model.io.xpp3
- printError(D, String) - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
Formats the failure details and prints them as an INFO message
- printError(Duplication, String) - Method in class org.apache.maven.plugins.pmd.CpdViolationCheckMojo
-
Formats the failure details and prints them as an INFO message
- printError(Violation, String) - Method in class org.apache.maven.plugins.pmd.PmdViolationCheckMojo
-
Formats the failure details and prints them as an INFO message
- printErrors(List<D>, List<D>) - Method in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
Prints the warnings and failures
- ProcessingError - Class in org.apache.maven.plugins.pmd.model
-
Class ProcessingError.
- ProcessingError() - Constructor for class org.apache.maven.plugins.pmd.model.ProcessingError
- project - Variable in class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo
-
The project to analyze.
R
- read(InputStream) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Method read.
- read(InputStream) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Method read.
- read(InputStream, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Method read.
- read(InputStream, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Method read.
- read(Reader) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
- read(Reader) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
- read(Reader, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
- read(Reader, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
- read(XmlPullParser, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Method read.
- read(XmlPullParser, boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Method read.
- removeDuplication(Duplication) - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Method removeDuplication.
- removeError(ProcessingError) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method removeError.
- removeFile(CpdFile) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Method removeFile.
- removeFile(PmdFile) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method removeFile.
- removeSuppressedViolation(SuppressedViolation) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Method removeSuppressedViolation.
- removeViolation(Violation) - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Method removeViolation.
- renderBody() - Method in class org.apache.maven.plugins.pmd.CpdReportRenderer
- renderBody() - Method in class org.apache.maven.plugins.pmd.PmdReportRenderer
- resolveDependenciesAsFile(MavenProject, Collection<MavenProject>, boolean) - Method in class org.apache.maven.plugins.pmd.ConfigurationService
- run() - Method in class org.apache.maven.plugins.pmd.exec.CpdExecutor
- run() - Method in class org.apache.maven.plugins.pmd.exec.PmdExecutor
S
- session - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
The current build session instance.
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAnalysisCacheLocation(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setAuxClasspath(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setBeginline(int) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the beginline field.
- setBenchmarkOutputLocation(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setCodefragment(String) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Set the codefragment field.
- setDetail(String) - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Set the detail field.
- setDuplications(List<Duplication>) - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Set the duplications field.
- setEndline(int) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the endline field.
- setErrors(List<ProcessingError>) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Set the errors field.
- setExcludeFromFailureFile(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setExcludeFromFailureFile(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setExternalInfoUrl(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the externalInfoUrl field.
- setFailureDetails(List<D>) - Method in class org.apache.maven.plugins.pmd.ViolationDetails
- setFilename(String) - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Set the filename field.
- setFilename(String) - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Set the filename field.
- setFileName(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
- setFiles(List<CpdFile>) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Set the files field.
- setFiles(List<PmdFile>) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Set the files field.
- setFormat(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setFormat(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setIgnoreAnnotations(boolean) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setIgnoreIdentifiers(boolean) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setIgnoreLiterals(boolean) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setIncludeXmlInReports(boolean) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setIncludeXmlInReports(boolean) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setJdkToolchain(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setJdkToolchain(Map<String, String>) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setLanguage(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setLanguageAndVersion(String, String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
-
Configure language and language version.
- setLanguageProperties(Properties) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setLine(int) - Method in class org.apache.maven.plugins.pmd.model.CpdFile
-
Set the line field.
- setLines(int) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Set the lines field.
- setLogLevel(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setMinimumPriority(int) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setMinimumTokens(int) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setModelEncoding(String) - Method in class org.apache.maven.plugins.pmd.model.CpdErrorDetail
-
Set the modelEncoding field.
- setModelEncoding(String) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Set the modelEncoding field.
- setMsg(String) - Method in class org.apache.maven.plugins.pmd.model.ProcessingError
-
Set the msg field.
- setName(String) - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Set the name field.
- setOutputEncoding(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setOutputEncoding(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setPath(String) - Method in class org.apache.maven.plugins.pmd.model.CpdFile
-
Set the path field.
- setPriority(int) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the priority field.
- setProcessingErrors(Collection<ProcessingError>) - Method in class org.apache.maven.plugins.pmd.PmdReportRenderer
- setReportOutputDirectory(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setReportOutputDirectory(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setRule(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the rule field.
- setRuleMessage(String) - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Set the ruleMessage field.
- setRulesets(String[]) - Method in class org.apache.maven.plugins.pmd.PmdReport
-
Configures the PMD rulesets to be used directly.
- setRulesets(List<String>) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setSkipPmdError(boolean) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setSourceEncoding(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setSourceEncoding(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setSuppressedViolations(Collection<SuppressedViolation>) - Method in class org.apache.maven.plugins.pmd.PmdReportRenderer
- setSuppressedViolations(List<SuppressedViolation>) - Method in class org.apache.maven.plugins.pmd.model.PmdErrorDetail
-
Set the suppressedViolations field.
- setSuppressionType(String) - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Set the suppressionType field.
- setSuppressMarker(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setTargetDirectory(String) - Method in class org.apache.maven.plugins.pmd.exec.CpdRequest
- setTargetDirectory(String) - Method in class org.apache.maven.plugins.pmd.exec.PmdRequest
- setText(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the text field.
- setTokens(int) - Method in class org.apache.maven.plugins.pmd.model.Duplication
-
Set the tokens field.
- setUserMessage(String) - Method in class org.apache.maven.plugins.pmd.model.SuppressedViolation
-
Set the userMessage field.
- setViolationClass(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the violationClass field.
- setViolationPackage(String) - Method in class org.apache.maven.plugins.pmd.model.Violation
-
Set the violationPackage field.
- setViolations(List<Violation>) - Method in class org.apache.maven.plugins.pmd.model.PmdFile
-
Set the violations field.
- setWarningDetails(List<D>) - Method in class org.apache.maven.plugins.pmd.ViolationDetails
- showPmdLog - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Deprecated.With 3.22.0 and the upgrade to PMD 7, this parameter has no effect anymore. The PMD log is now always redirected into the maven log and this can't be disabled by this parameter anymore. In order to disable the logging, see Maven Logging. You'd need to start maven with
MAVEN_OPTS=-Dorg.slf4j.simpleLogger.log.net.sourceforge.pmd=off mvn <goals>
. - skipEmptyReport - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
Skip the PMD/CPD report generation if there are no violations or duplications found.
- SuppressedViolation - Class in org.apache.maven.plugins.pmd.model
-
Class SuppressedViolation.
- SuppressedViolation() - Constructor for class org.apache.maven.plugins.pmd.model.SuppressedViolation
T
- targetDirectory - Variable in class org.apache.maven.plugins.pmd.AbstractPmdReport
-
The output directory for the intermediate XML report.
- transform(String, String) - Method in interface org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader.ContentTransformer
-
Interpolate the value read from the xpp3 document
- transform(String, String) - Method in interface org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader.ContentTransformer
-
Interpolate the value read from the xpp3 document
V
- Violation - Class in org.apache.maven.plugins.pmd.model
-
Class Violation.
- Violation() - Constructor for class org.apache.maven.plugins.pmd.model.Violation
- ViolationDetails<D> - Class in org.apache.maven.plugins.pmd
-
Collector of warnings and failures.
- ViolationDetails() - Constructor for class org.apache.maven.plugins.pmd.ViolationDetails
All Classes and Interfaces|All Packages|Serialized Form
pmd:aggregate-pmd
andpmd:aggregate-cpd
instead. See FAQ: Why do I get sometimes false positive and/or false negative violations? for an explanation.