This is the PMD programming mistake detector. In order to use it,
create a new instance of
PMD and use its
PMD.processFiles(net.sourceforge.pmd.PMDConfiguration, net.sourceforge.pmd.RuleSetFactory, java.util.List<net.sourceforge.pmd.util.datasource.DataSource>, net.sourceforge.pmd.RuleContext, java.util.List<net.sourceforge.pmd.renderers.Renderer>) method.
Interface Summary Interface Description RuleThis is the basic Rule interface for PMD rules. RuleViolationA RuleViolation is created by a Rule when it identifies a violation of the Rule constraints. ThreadSafeReportListener Deprecated.All entry points of PMD that allowed usage of this are now deprecated.
Class Summary Class Description AbstractConfigurationBase configuration class for both PMD and CPD. PMDEntry point for PMD's CLI. PmdAnalysisMain programmatic API of PMD. PMDConfigurationThis class contains the details for the runtime configuration of a PMD run. PMDVersionStores the current PMD version and provides utility methods around it. ReportA
Reportis the output of a PMD execution.
Report.ConfigurationErrorRepresents a configuration error. Report.ProcessingErrorRepresents a processing error, such as a parse error. Report.ReadableDuration Deprecated.Not used within PMD. Report.SuppressedViolationRepresents a violation, that has been suppressed. RuleChain Deprecated.Internal API, will be removed with PMD 7.0.0. RuleContextThe API for rules to report violations or errors during analysis. RuleSetThis class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files. RuleSetFactory Deprecated.Use a
RuleSetLoader.enableCompatibility(boolean)to enable this feature.
RuleSetLoaderConfigurable object to load rulesets from XML resources. RuleSetReference Deprecated.This is part of the internals of the
RuleSetReferenceId Deprecated.This is part of the internals of the
RuleSets Deprecated.Internal API RulesetsFactoryUtils Deprecated.Use a
RuleSetWriterThis class represents a way to serialize a RuleSet to an XML configuration file. RuleViolationComparator Deprecated. SourceCodeProcessor Deprecated.
Enum Summary Enum Description PMD.StatusCodeRepresents status codes that are used as exit codes during CLI runs. RulePriorityThese are the possible Rule priority values.
Exception Summary Exception Description PMDException Deprecated. RuleSetLoadExceptionAn exception that is thrown when something wrong occurs while loading rulesets. RuleSetNotFoundException Deprecated.This is now only thrown by deprecated apis.