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. ThreadSafeReportListenerMarker interface for report listeners that, being thread-safe, need not extra synchronization.
Class Summary Class Description AbstractConfigurationBase configuration class for both PMD and CPD. PMDThis is the main class for interacting with PMD. PMDConfigurationThis class contains the details for the runtime configuration of PMD. PMDVersionStores the current PMD version and provides utility methods around it. ReportA
Reportcollects all informations during 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 RuleContext provides access to Rule processing state. RuleSetThis class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files. RuleSetFactoryRuleSetFactory is responsible for creating RuleSet instances from XML content. RuleSetFactoryCompatibilityProvides a simple filter mechanism to avoid failing to parse an old ruleset, which references rules, that have either been removed from PMD already or renamed or moved to another ruleset. RuleSetReferenceThis class represents a reference to RuleSet. RuleSetReferenceIdThis class is used to parse a RuleSet reference value. RuleSets Deprecated.Internal API RulesetsFactoryUtils RuleSetWriterThis class represents a way to serialize a RuleSet to an XML configuration file. RuleViolationComparatorCompares RuleViolations using the following criteria: Source file name Begin line Description Begin column End line End column Rule name SourceCodeProcessor
Enum Summary Enum Description RulePriorityThese are the possible Rule priority values.
Exception Summary Exception Description PMDExceptionA convenience exception wrapper. RuleSetNotFoundException