All Classes

Class	Description
AbstractAccumulatingRenderer	Abstract base class for Renderer implementations which only produce output once all source files are processed.
AbstractConfiguration	Base configuration class for both PMD and CPD.
AbstractIncrementingRenderer	Abstract base class for Renderer implementations which can produce output incrementally for RuleViolations as source files are processed.
AbstractJjtreeNode<B extends AbstractJjtreeNode<B,N>,N extends JjtreeNode<N>>	Base class for node produced by JJTree.
AbstractLanguageVersionHandler	This is a generic implementation of the LanguageVersionHandler interface.
AbstractNameDeclaration	Base class for all name declarations.
AbstractNode<B extends AbstractNode<B,N>,N extends Node & GenericNode<N>>	Base class for implementations of the Node interface whose children are stored in an array.
AbstractPmdLanguageVersionHandler	Base language version handler for languages that support PMD, i.e.
AbstractPropertySource	Base class for PropertySource.
AbstractRenderer	Abstract base class for Renderer implementations.
AbstractRule	Basic abstract implementation of all parser-independent methods of the Rule interface.
AbstractScope	Base class for any Scope.
AbstractTokenManager	A base class for the token managers generated by JavaCC.
AbstractVisitorRule
AntlrBaseParser<N extends AntlrNode<N>,R extends BaseAntlrInnerNode<N> & RootNode>	Generic Antlr parser adapter for all Antlr parsers.
AntlrCpdLexer	Generic implementation of a CpdLexer useful to any Antlr grammar.
AntlrGeneratedParserBase<N extends AntlrNode<N>>	This is the base class for antlr generated parsers.
AntlrNameDictionary	Stores the XPath name of antlr terminals.
AntlrNode<N extends AntlrNode<N>>	Base interface for all Antlr-based implementation of the Node interface.
AntlrToken	Generic Antlr representation of a token.
AntlrTokenFilter	A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream
AntlrTokenManager	Generic token manager implementation for all Antlr lexers.
AnyCpdLexer	Simple tokenization into words and separators.
Applier
AssertionUtil
AstInfo<T extends RootNode>	The output of Parser.parse(ParserTask).
AstVisitor<P,R>	Root interface for AST visitors.
AstVisitorBase<P,R>	Base implementation of AstVisitor, that performs a top-down (preorder) visit and may accumulate a result.
Attribute	Represents an XPath attribute of a specific node.
AttributeAxisIterator	Explores an AST node reflectively to iterate over its XPath attributes.
BackslashEscapeTranslator	A base class for readers that handle escapes starting with a backslash.
BaseAntlrErrorNode<N extends AntlrNode<N>>
BaseAntlrInnerNode<N extends AntlrNode<N>>	Base class for the inner nodes (corresponds to ParserRuleContext).
BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>>
BaseAntlrNode<A extends BaseAntlrNode.AntlrToPmdParseTreeAdapter<N>,N extends AntlrNode<N>>	Base class for an antlr node.
BaseAntlrNode.AntlrToPmdParseTreeAdapter<N extends AntlrNode<N>>
BaseAntlrTerminalNode<N extends AntlrNode<N>>	Base class for terminal nodes (they wrap a TerminalNode).
BaseAntlrTerminalNode.AntlrErrorPmdAdapter<N extends AntlrNode<N>>
BaseAntlrTerminalNode.AntlrTerminalPmdAdapter<N extends AntlrNode<N>>
BaseResultProducingCloseable<T>	Base class for an autocloseable that produce a result once it has been closed.
BaseTokenFilter<T extends GenericToken<T>>	A generic filter for PMD token managers that allows to use comments to enable / disable analysis of parts of the stream
BatchLanguageProcessor<P extends LanguagePropertyBundle>	A base class for language processors.
Chars	View on a string which doesn't copy the array for subsequence operations.
CharStream	PMD flavour of character streams used by JavaCC parsers.
CodeClimateIssue	Structure for the Code Climate Issue spec (https://github.com/codeclimate/spec/blob/master/SPEC.md#issues)
CodeClimateIssue.Content	Content structure
CodeClimateIssue.Location	Location structure
CodeClimateRenderer	Renderer for Code Climate JSON format
CollectionUtil	Generic collection-related utility functions for java.util types.
CommentNode
ConfigurableFileNameRenderer
ConstraintViolatedException	Thrown when a property constraint is violated.
ContextedAssertionError	An AssertionError with nice messages.
ContextedStackOverflowError	A StackOverflowError with nice messages.
CpdAnalysis	Main programmatic API of CPD.
CpdCapableLanguage	A language that supports CPD.
CPDConfiguration
CpdLanguageProperties	These are language properties common to multiple CpdCapableLanguages.
CpdLexer	Tokenizes a source file into tokens consumable by CPD.
CpdLexerBase<T extends GenericToken<T>>	Generic base class for a CpdLexer.
CPDListener
CPDNullListener
CpdOnlyLanguageModuleBase	Base class for language modules that only support CPD and not PMD.
CPDReport	The result of a CPD analysis.
CPDReportRenderer	Render a CPDReport to a file.
CSVRenderer	Renders a report to CSV.
CSVRenderer	Renderer the results to a comma-delimited text format.
CSVWithLinecountPerFileRenderer
DataMap<K>	An opaque, strongly typed heterogeneous data container.
DataMap.DataKey<K extends DataMap.DataKey<K,T>,T>	A key for type-safe access into a DataMap.
DataMap.SimpleDataKey<T>
DBMSMetadata	Wrap JDBC connection for use by PMD: DBURI parameters specify the source code to be passed to PMD.
DBType	Encapsulate the settings needed to access database source code.
DBType.Property	The names of the properties
DBURI	Provide a single parameter to specify database objects to process.
DeprecatedAttribute	Node attribute getter methods might be annotated with DeprecatedAttribute to mark the attribute as deprecated for XPath.
DesignerBindings	Gathers some services to customise how language implementations bind to the designer.
DesignerBindings.AdditionalInfo	An entry for the "additional info" panel.
DesignerBindings.DefaultDesignerBindings	A base implementation for DesignerBindings.
DesignerBindings.TreeIconId	See DesignerBindings.getIcon(Node).
EmacsRenderer	Renderer to GNU Emacs parsable format.
EmptyRenderer	An empty renderer, for when you really don't want a report.
EscapeTranslator	An object that can translate an input document into an output document, typically by replacing escape sequences with the character they represent.
Experimental	Tagged API members are subject to change.
FileAnalysisException	An exception that occurs while processing a file.
FileAnalysisListener	A handler for events occuring during analysis of a single file.
FileCollector	Collects files to analyse before a PMD run.
FileId	An identifier for a TextFile.
FileLocation	Represents the coordinates of a text region, used for reporting.
FileNameRenderer	Strategy to render a FileId into a display name.
FragmentedDocBuilder
GenericNode<N extends GenericNode<N>>	Interface that binds the return type of some node methods to a type parameter.
GenericToken<T extends GenericToken<T>>	Represents a token, part of a token chain in a source file.
GlobalAnalysisListener	Listens to an analysis.
GlobalAnalysisListener.ViolationCounterListener	A listener that just counts recorded violations.
GraphUtil
GraphUtil.DotColor
GUI
HTMLRenderer	Renderer to basic HTML format.
IDEAJRenderer	Renderer for IntelliJ IDEA integration.
ImageFinderFunction
InternalApi	Tags API members that are not publicly supported API but have to live in public packages (outside `internal` packages).
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge	Internal API.
InternalApiBridge.InternalPropertySerializer<T>
IteratorUtil	Operations for dealing with Iterators.
IteratorUtil.AbstractIterator<T>	Note, that this iterator doesn't support the remove operation.
IteratorUtil.AbstractPausingIterator<T>
JavaccCpdLexer	Base class for a CpdLexer for a language implemented by a JavaCC tokenizer.
JavaccToken	A generic token implementation for JavaCC parsers.
JavaccTokenDocument	Token document for Javacc implementations.
JavaccTokenDocument.TokenDocumentBehavior	Overridable configuration of a token document.
JavaCCTokenFilter	A generic filter for JavaCC-based token managers that allows to use comments to enable / disable analysis of parts of the stream
JavaEscapeTranslator	An implementation of EscapeTranslator that translates Java unicode escapes.
JjtreeBuilder<N extends AbstractJjtreeNode<N,?>>	Shared implementation of the tree builder generated by JJTree.
JjtreeNode<N extends JjtreeNode<N>>	Base interface for nodes that are produced by a JJTree parser.
JjtreeParserAdapter<R extends RootNode>	Base implementation of the Parser interface for JavaCC language implementations.
JsonRenderer
JvmLanguagePropertyBundle	Base properties class for JVM languages that use a classpath to resolve references.
Language	Represents a language module, and provides access to language-specific functionality.
LanguageFilenameFilter	This is an implementation of the FilenameFilter interface which compares a file against a collection of Languages to see if the any are applicable.
LanguageMetricsProvider	Language-specific provider for metrics.
LanguageModuleBase	Base class for language modules.
LanguageModuleBase.LanguageMetadata	Metadata about a language, basically a builder pattern for the language instance.
LanguageProcessor	Stateful object managing the analysis for a given language.
LanguageProcessor.AnalysisTask	Configuration of an analysis, as given to LanguageProcessor.launchAnalysis(AnalysisTask).
LanguageProcessorRegistry	Stores all currently initialized LanguageProcessors during analysis.
LanguageProcessorRegistry.LanguageTerminationException	An exception that occurs during the closing of a LanguageProcessor,
LanguagePropertyBundle	A bundle of properties used by languages (see Language.newPropertyBundle()).
LanguageRegistry	A set of languages with convenient methods.
LanguageVersion	Represents a version of a Language.
LanguageVersionDiscoverer	This class can discover the LanguageVersion of a source file.
LanguageVersionHandler	Interface for obtaining the classes necessary for checking source files of a specific language.
LexException	An error thrown during lexical analysis of a file.
ListenerInitializer	An initializer for GlobalAnalysisListener that gets notified of general analysis parameters.
MalformedSourceException	A FileAnalysisException thrown when the source format is invalid, for example if some unicode escapes cannot be translated.
Mark	A range of tokens in a source file, identified by a start and end token (both included in the range).
Match
Metric<N extends Node,R extends Number>	A named computation that can be carried out on some nodes.
MetricOption	Option to pass to a metric.
MetricOptions	Bundles a set of options to pass to a metric.
MetricsUtil	Utilities to use Metric instances.
NameDeclaration	This is a declaration of a name, e.g.
NameOccurrence	A NameOccurrence represents one usage of a name declaration.
NoAttribute	Filters out some methods from the XPath attributes of a node.
NoAttribute.NoAttrScope
Node	Root interface for all AST nodes.
NodeStream<T extends Node>	A sequence of AST nodes.
NodeStream.DescendantNodeStream<T extends Node>	A specialization of NodeStream that allows configuring tree traversal behaviour when traversing the descendants of a node.
NumericConstraints	Common constraints for properties dealing with numbers.
OptionalBool	Represents a boolean that may not be present.
ParseException
Parser	Produces an AST from a source file.
Parser.ParserTask	Parameters passed to a parsing task.
PlainTextLanguage	A dummy language implementation whose parser produces a single node.
PlainTextLanguage.PlainTextFile	The only node produced by the parser of PlainTextLanguage.
PmdAnalysis	Main programmatic API of PMD.
PmdCapableLanguage	A language that supports PMD.
PMDConfiguration	This class contains the details for the runtime configuration of a PMD run.
PmdReporter	Façade to report user-facing messages (info, warning and error).
PMDVersion	Stores the current PMD version and provides utility methods around it.
PmdXPathException	Unchecked exception wrapper for XPathException.
PmdXPathException.Phase
PropertyBuilder<B extends PropertyBuilder<B,T>,T>	Base class for generic property builders.
PropertyBuilder.GenericCollectionPropertyBuilder<V,C extends Iterable<V>>	Generic builder for a collection-valued property.
PropertyBuilder.GenericPropertyBuilder<T>	Generic builder for a single-value property.
PropertyBuilder.RegexPropertyBuilder	Specialized builder for regex properties.
PropertyConstraint<T>	Validates the value of a property.
PropertyDescriptor<T>	Describes a property of a rule or a renderer.
PropertyFactory	Provides factory methods for common property types.
PropertySerializer<T>	Strategy to serialize a value to and from strings.
PropertySource	Entity that manages a list of properties.
ReadOnlyFileException	Thrown when an attempt to write through a TextFile fails because the file is read-only.
RelatedNodesSelector	Provides a way for the designer to highlight related nodes upon selection, eg those nodes referring to the same variable or method.
Renderer	This is an interface for rendering a Report.
RendererFactory	This class handles the creation of Renderers.
Report	A Report collects all information during a PMD execution.
Report.ConfigurationError	Represents a configuration error for a specific rule.
Report.GlobalReportBuilderListener	A GlobalAnalysisListener that accumulates the events of all files into a Report.
Report.ProcessingError	Represents a recovered error that occurred during analysis.
Report.ReportBuilderListener	A FileAnalysisListener that accumulates events into a Report.
Report.SuppressedViolation	Represents a violation, that has been suppressed.
Reportable	Interface implemented by those objects that can be the target of a RuleViolation.
ReportStats	Summarized info about a report.
ReportStatsListener	Collects summarized info about a PMD run.
ResourceLoader	Helper class for retrieving resources relative to the installation.
ResourceResolver
RootNode	This interface identifies the root node of an AST.
Rule	This is the basic Rule interface for PMD rules.
RuleContext	The API for rules to report violations or errors during analysis.
RulePriority	These are the possible Rule priority values.
RuleReference	This class represents a Rule which is a reference to Rule defined in another RuleSet.
RuleSet	This class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files.
RuleSetLoader	Configurable object to load rulesets from XML resources.
RuleSetLoadException	An exception that is thrown when something wrong occurs while loading rulesets.
RuleSetWriter	This class represents a way to serialize a RuleSet to an XML configuration file.
RuleTargetSelector	A strategy for selecting nodes that will be targeted by a rule.
RuleViolation	A RuleViolation is created by a Rule when it identifies a violation of the Rule constraints.
SarifRenderer
Scope	A scope is a region within variables and other declarations are visible.
ScopedNode	A Node which knows about the scope within it has been declared.
SemanticErrorReporter	Reports errors that occur after parsing.
SemanticException	An error that occurs after validating a file.
SimpleLanguageModuleBase	The simplest implementation of a language, where only a LanguageVersionHandler needs to be implemented.
SimpleRenderer
SourceObject	Instantiate the fields required to retrieve the source code.
StringUtil	String-related utility functions.
StringUtil.CaseConvention
SummaryHTMLRenderer	Renderer to a summarized HTML format.
TextAvailableNode	Refinement of Node for nodes that can provide the underlying source text.
TextColorRenderer	A console renderer with color support for terminal supporting ansi color codes.
TextDocument	Represents a textual document, providing methods to edit it incrementally and address regions of text.
TextFile	Represents some location containing character data.
TextFileBuilder	A builder for a new text file.
TextFileContent	Contents of a text file.
TextNode
TextPadRenderer	A Renderer for running PMD via a TextPad 'tool'.
TextPos2d	A place in a text document, represented as line/column information.
TextRange2d	A place in a text document, represented as line/column information.
TextRegion	A contiguous range of text in a TextDocument.
TextRenderer	Renderer to simple text format.
TextTimingReportRenderer	A text based renderer for TimingReport.
TextTreeRenderer	A simple recursive printer.
TimedOperation	Describes a timed operation.
TimedOperationCategory	A category for a TimedOperation, rendered either as a section if several operations are registered on the same category but with distinct labels, or put into the "remaining categories" section.
TimeTracker	A time tracker class to measure time spent on different sections of PMD analysis.
TimingReport	A report on timing data obtained through the execution of PMD
TimingReportRenderer	Defines a renderer for TimingReport.
TokenDocument<T extends GenericToken>	Token layer of a parsed file.
TokenEntry
TokenFactory	Proxy to record tokens from within CpdLexer.tokenize(TextDocument, TokenFactory).
TokenManager<T extends GenericToken<T>>	Common interface for interacting with parser Token Managers.
Tokens	Global token collector for CPD.
TreeExportConfiguration
TreeExporter
TreeRenderer	An object that can export a tree to an external text format.
TreeRendererDescriptor	Describes the configuration options of a specific TreeRenderer.
TreeRenderers	Entry point to fetch and register tree renderers.
VBHTMLRenderer	Renderer to another HTML format.
ViolationDecorator	Adds additional key/value pairs to a violation in a language-specific manner.
ViolationSuppressor	An object that suppresses rule violations.
VSRenderer
XMLOldRenderer	Deprecated. Update your tools to use the standard XML renderer "xml" again.
XMLRenderer
XMLRenderer	Renderer to XML format.
XmlTreeRenderer	Renders a tree to XML.
XmlTreeRenderer.XmlRenderingConfig	A strategy to parameterize an XmlTreeRenderer.
XPathFunctionDefinition	Base impl for an XPath function definition.
XPathFunctionDefinition.FunctionCall	Provides the actual implementation of a custom XPath function.
XPathFunctionDefinition.Type	Supported types of a custom XPath function.
XPathFunctionException	Indicates a problem during the execution of a custom XPath function.
XPathHandler	Interface for performing Language specific XPath handling, such as initialization and navigation.
XPathRule	Rule that tries to match an XPath expression against a DOM view of an AST.
XPathVersion	Constants for XPath language version used in XPath queries.
XSLTRenderer	Renderer to XML format with a XSL Transformation applied.
YAHTMLRenderer	Renderer to another HTML format.