All Classes and Interfaces
Class
Description
Abstract base class for
Renderer implementations which only produce
output once all source files are processed.Base class for a
ViolationSuppressor that uses annotations
of the source language to suppress some warnings.Callbacks for a walk over an annotation.
Base configuration class for both PMD and CPD.
Abstract base class for
Renderer implementations which can produce
output incrementally for RuleViolations as source files are
processed.Base class for node produced by JJTree.
This is a generic implementation of the LanguageVersionHandler interface.
Base class for all name declarations.
Base class for implementations of the Node interface whose children
are stored in an array.
Base language version handler for languages that support PMD, i.e. can build an AST
and support AST processing stages.
Base class for
PropertySource.Abstract base class for
Renderer implementations.Basic abstract implementation of all parser-independent methods of the Rule
interface.
Base class for any
Scope.A base class for the token managers generated by JavaCC.
Generic Antlr parser adapter for all Antlr parsers.
Generic implementation of a
CpdLexer useful to any Antlr grammar.This is the base class for antlr generated parsers.
Stores the XPath name of antlr terminals.
Base interface for all Antlr-based implementation of the Node interface.
Generic Antlr representation of a token.
A generic filter for Antlr-based token managers that allows to use comments
to enable / disable analysis of parts of the stream
Generic token manager implementation for all Antlr lexers.
Simple tokenization into words and separators.
The output of
Parser.parse(ParserTask).Root interface for AST visitors.
Base implementation of
AstVisitor, that performs a top-down
(preorder) visit and may accumulate a result.Represents an XPath attribute of a specific node.
Explores an AST node reflectively to iterate over its XPath
attributes.
A base class for readers that handle escapes starting with a backslash.
Base class for the inner nodes (corresponds to
ParserRuleContext).Base class for an antlr node.
Base class for terminal nodes (they wrap a
TerminalNode).Base language version handler for dialect languages that support PMD, i.e. can build an AST
and support AST processing stages.
Base class for an autocloseable that produce a result once it has
been closed.
A generic filter for PMD token managers that allows to use comments
to enable / disable analysis of parts of the stream
A base class for language processors.
View on a string which doesn't copy the array for subsequence operations.
PMD flavour of character streams used by JavaCC parsers.
A delegating listener wrapper that can override the closing behavior.
Structure for the Code Climate Issue spec
(https://github.com/codeclimate/spec/blob/master/SPEC.md#issues)
Content structure
Location structure
Renderer for Code Climate JSON format
Generic collection-related utility functions for java.util types.
Thrown when a property constraint is violated.
An
AssertionError with nice messages.A
StackOverflowError with nice messages.Main programmatic API of CPD.
A language that supports
CPD.These are language properties common to multiple
CpdCapableLanguages.Tokenizes a source file into tokens consumable by CPD.
Generic base class for a
CpdLexer.Base class for language modules that only support CPD and not PMD.
The result of a CPD analysis.
Render a
CPDReport to a file.Renders a report to CSV.
Renderer the results to a comma-delimited text format.
An opaque, strongly typed heterogeneous data container.
A key for type-safe access into a
DataMap.Wrap JDBC connection for use by PMD:
DBURI parameters specify the
source code to be passed to PMD.Encapsulate the settings needed to access database source code.
The names of the properties
Provide a single parameter to specify database objects to process.
Node attribute getter methods might be annotated with
DeprecatedAttribute
to mark the attribute as deprecated for XPath.Gathers some services to customise how language implementations bind
to the designer.
An entry for the "additional info" panel.
A base implementation for
DesignerBindings.A listener that mediates access to another listener to order events
in a predetermined, stable way.
Renderer to GNU Emacs parsable format.
An empty renderer, for when you really don't want a report.
An object that can translate an input document into an output document,
typically by replacing escape sequences with the character they represent.
Tagged API members are subject to change.
An exception that occurs while processing a file.
A handler for events occuring during analysis of a single file.
Collects files to analyse before a PMD run.
An identifier for a
TextFile.Represents the coordinates of a text region, used for reporting.
Strategy to render a
FileId into a display name.Marks a class as generated code, and therefore to be ignored for code coverage purposes.
Interface that binds the return type of some node methods to a type
parameter.
Represents a token, part of a token chain in a source file.
Listens to an analysis.
A listener that just counts recorded violations.
Renderer to basic HTML format.
Renderer for IntelliJ IDEA integration.
Tags API members that are not publicly supported API but have to live in
public packages (outside `internal` packages).
Internal API.
Internal API.
Internal API.
Internal API.
Internal API.
Internal API.
Internal API.
Operations for dealing with
Iterators.Note, that this iterator doesn't support the
remove operation.Base class for a
CpdLexer for a language implemented by a JavaCC tokenizer.A generic token implementation for JavaCC parsers.
Token document for Javacc implementations.
Overridable configuration of a token document.
A generic filter for JavaCC-based token managers that allows to use comments
to enable / disable analysis of parts of the stream
An implementation of
EscapeTranslator that translates Java
unicode escapes.Shared implementation of the tree builder generated by JJTree.
Base interface for nodes that are produced by a JJTree parser.
Base implementation of the
Parser interface for JavaCC language
implementations.Base properties class for JVM languages that use a classpath to resolve
references.
Represents a language module, and provides access to language-specific
functionality.
This is an implementation of the
FilenameFilter interface which
compares a file against a collection of Languages to see if the any are
applicable.Language-specific provider for metrics.
Base class for language modules.
Expresses the language as a dialect of another language.
Metadata about a language, basically a builder pattern for the
language instance.
Stateful object managing the analysis for a given language.
Configuration of an analysis, as given to
LanguageProcessor.launchAnalysis(AnalysisTask).Stores all currently initialized
LanguageProcessors during analysis.An exception that occurs during the closing of a
LanguageProcessor,A bundle of properties used by languages (see
Language.newPropertyBundle()).A set of languages with convenient methods.
Represents a version of a
Language.This class can discover the LanguageVersion of a source file.
Interface for obtaining the classes necessary for checking source files of a
specific language.
An error thrown during lexical analysis of a file.
An initializer for
GlobalAnalysisListener that gets notified of
general analysis parameters.A
FileAnalysisException thrown when the source format is invalid,
for example if some unicode escapes cannot be translated.A range of tokens in a source file, identified by a start and end
token (both included in the range).
A named computation that can be carried out on some nodes.
Option to pass to a metric.
Bundles a set of options to pass to a metric.
Utilities to use
Metric instances.This is a declaration of a name, e.g. a variable or method name.
A
NameOccurrence represents one usage of a name declaration.Filters out some methods from the XPath attributes of a node.
Root interface for all AST nodes.
A sequence of AST nodes.
A specialization of
NodeStream that allows configuring
tree traversal behaviour when traversing the descendants of a node.Common constraints for properties dealing with numbers.
Represents a boolean that may not be present.
Produces an AST from a source file.
Parameters passed to a parsing task.
A dummy language implementation whose parser produces a single node.
The only node produced by the parser of
PlainTextLanguage.Main programmatic API of PMD.
A language that supports
PMD.This class contains the details for the runtime configuration of a
PMD run.
Façade to report user-facing messages (info, warning and error).
Stores the current PMD version and provides utility methods around it.
Unchecked exception wrapper for
XPathException.Base class for generic property builders.
Generic builder for a collection-valued property.
Generic builder for a single-value property.
Specialized builder for regex properties.
Validates the value of a property.
Describes a property of a rule or a renderer.
Provides factory methods for common property types.
Strategy to serialize a value to and from strings.
Entity that manages a list of properties.
Thrown when an attempt to write through a
TextFile
fails because the file is read-only.Provides a way for the designer to highlight related nodes upon selection,
eg those nodes referring to the same variable or method.
This is an interface for rendering a Report.
This class handles the creation of Renderers.
A
Report collects all information during a PMD execution.Represents a configuration error for a specific rule.
A
GlobalAnalysisListener that accumulates the events of
all files into a Report.Represents a recovered error that occurred during analysis.
A
FileAnalysisListener that accumulates events into a
Report.Represents a violation, that has been suppressed.
Interface implemented by those objects that can be the target of
a
RuleViolation.Summarized info about a report.
Collects summarized info about a PMD run.
Helper class for retrieving resources relative to the installation.
This interface identifies the root node of an AST.
This is the basic Rule interface for PMD rules.
The API for rules to report violations or errors during analysis.
These are the possible Rule priority values.
This class represents a Rule which is a reference to Rule defined in another
RuleSet.
This class represents a collection of rules along with some optional filter
patterns that can preclude their application on specific files.
A builder class to create a ruleset.
Configurable object to load rulesets from XML resources.
An exception that is thrown when something wrong occurs while
loading rulesets.
This class represents a way to serialize a RuleSet to an XML configuration
file.
A strategy for selecting nodes that will be targeted by a rule.
A RuleViolation is created by a Rule when it identifies a violation of the
Rule constraints.
A scope is a region within variables and other declarations are visible.
A
Node which knows about the scope within it has been declared.Reports errors that occur after parsing.
An error that occurs after validating a file.
The simplest implementation of a dialect, where only a
LanguageModuleBase.LanguageMetadata
needs to be implemented.The simplest implementation of a language, where only a
LanguageVersionHandler
needs to be implemented.Instantiate the fields required to retrieve the source code.
String-related utility functions.
Renderer to a summarized HTML format.
Simple implementation of
ViolationSuppressor.SuppressionCommentWrapper.Refinement of
Node for nodes that can provide the underlying
source text.
A console renderer with color support for terminal supporting ansi color codes.
Represents a textual document, providing methods to edit it incrementally
and address regions of text.
Represents some location containing character data.
A builder for a new text file.
Contents of a text file.
A Renderer for running PMD via a TextPad 'tool'.
A place in a text document, represented as line/column information.
A place in a text document, represented as line/column information.
A contiguous range of text in a
TextDocument.Renderer to simple text format.
A text based renderer for
TimingReport.A simple recursive printer.
Describes a timed operation.
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.A time tracker class to measure time spent on different sections of PMD analysis.
A report on timing data obtained through the execution of PMD
Defines a renderer for
TimingReport.Token layer of a parsed file.
Proxy to record tokens from within
CpdLexer.tokenize(TextDocument, TokenFactory).Common interface for interacting with parser Token Managers.
Global token collector for CPD.
An object that can export a tree to an external text format.
Describes the configuration options of a specific
TreeRenderer.Entry point to fetch and register tree renderers.
A rule that reports unused suppression annotations and comments.
Renderer to another HTML format.
Adds additional key/value pairs to a violation in a language-specific manner.
An object that suppresses rule violations.
Wrapper around a suppression comment.
Represents an instance of a "suppressor" that didn't suppress anything.
Deprecated.
Update your tools to use the standard XML renderer "xml" again.
Renderer to XML format.
Renders a tree to XML.
A strategy to parameterize an
XmlTreeRenderer.Base impl for an XPath function definition.
Provides the actual implementation of a custom XPath function.
Supported types of a custom XPath function.
Indicates a problem during the execution of a custom
XPath function.
Interface for performing Language specific XPath handling, such as
initialization and navigation.
Rule that tries to match an XPath expression against a DOM view of an AST.
Constants for XPath language version used in XPath queries.
Renderer to XML format with a XSL Transformation applied.
Renderer to another HTML format.