Package net.sourceforge.pmd

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
Rule	This is the basic Rule interface for PMD rules.
RuleViolation	A RuleViolation is created by a Rule when it identifies a violation of the Rule constraints.
ThreadSafeReportListener	Marker interface for report listeners that, being thread-safe, need not extra synchronization.

Class Summary

Class	Description
AbstractConfiguration	Base configuration class for both PMD and CPD.
PMD	This is the main class for interacting with PMD.
PMDConfiguration	This class contains the details for the runtime configuration of PMD.
PMDVersion	Stores the current PMD version and provides utility methods around it.
Report	A Report collects all informations during a PMD execution.
Report.ConfigurationError	Represents a configuration error.
Report.ProcessingError	Represents a processing error, such as a parse error.
Report.ReadableDuration	Deprecated. Not used within PMD.
Report.SuppressedViolation	Represents a violation, that has been suppressed.
RuleChain	Deprecated. Internal API, will be removed with PMD 7.0.0.
RuleContext	The RuleContext provides access to Rule processing state.
RuleSet	This class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files.
RuleSetFactory	RuleSetFactory is responsible for creating RuleSet instances from XML content.
RuleSetFactoryCompatibility	Provides 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.
RuleSetReference	This class represents a reference to RuleSet.
RuleSetReferenceId	This class is used to parse a RuleSet reference value.
RuleSets	Deprecated. Internal API
RulesetsFactoryUtils
RuleSetWriter	This class represents a way to serialize a RuleSet to an XML configuration file.
RuleViolationComparator	Compares RuleViolations using the following criteria: Source file name Begin line Description Begin column End line End column Rule name
SourceCodeProcessor

Enum Summary

Enum	Description
RulePriority	These are the possible Rule priority values.

Exception Summary

Exception	Description
PMDException	A convenience exception wrapper.
RuleSetNotFoundException