Index (PMD Core 7.0.0-SNAPSHOT API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes All Packages

A

abortEscape(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
above(N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints: Requires the number to be greater than a lower bound.
absorb(FileCollector) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add all files collected in the other collector into this one.
AbstractAccumulatingRenderer - Class in net.sourceforge.pmd.renderers: Abstract base class for Renderer implementations which only produce output once all source files are processed.
AbstractAccumulatingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
AbstractAnalysisCache - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
AbstractAnalysisCache() - Constructor for class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.

Creates a new empty cache
AbstractConfiguration - Class in net.sourceforge.pmd: Base configuration class for both PMD and CPD.
AbstractConfiguration(LanguageRegistry, MessageReporter) - Constructor for class net.sourceforge.pmd.AbstractConfiguration
AbstractDelegateRule - Class in net.sourceforge.pmd.lang.rule: Deprecated.
This is only relevant to RuleReference, but prevents sharing the implementation of AbstractPropertySource. Will be removed in 7.0.0
AbstractDelegateRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
AbstractIncrementingRenderer - Class in net.sourceforge.pmd.renderers: Abstract base class for Renderer implementations which can produce output incrementally for RuleViolations as source files are processed.
AbstractIncrementingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
AbstractIterator() - Constructor for class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
AbstractJjtreeNode<B extends AbstractJjtreeNode<B,N>,N extends JjtreeNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.javacc: Base class for node produced by JJTree.
AbstractJjtreeNode(int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode: The id is an index in the constant names array generated by jjtree, it must be set to some value that depends on the node type, not some arbitrary "1" or "2", and not necessarily a unique value.
AbstractLanguageVersionHandler - Class in net.sourceforge.pmd.lang: This is a generic implementation of the LanguageVersionHandler interface.
AbstractLanguageVersionHandler() - Constructor for class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
AbstractNameDeclaration - Class in net.sourceforge.pmd.lang.symboltable: Base class for all name declarations.
AbstractNameDeclaration(ScopedNode) - Constructor for class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
AbstractNode<B extends AbstractNode<B,N>,N extends Node & GenericNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl: Base class for implementations of the Node interface whose children are stored in an array.
AbstractNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.AbstractNode
AbstractPausingIterator() - Constructor for class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
AbstractPmdLanguageVersionHandler - Class in net.sourceforge.pmd.lang: Base language version handler for languages that support PMD, i.e.
AbstractPmdLanguageVersionHandler() - Constructor for class net.sourceforge.pmd.lang.AbstractPmdLanguageVersionHandler
AbstractPropertySource - Class in net.sourceforge.pmd.properties: Base class for PropertySource.
AbstractPropertySource() - Constructor for class net.sourceforge.pmd.properties.AbstractPropertySource
AbstractRenderer - Class in net.sourceforge.pmd.renderers: Abstract base class for Renderer implementations.
AbstractRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractRenderer
AbstractRule - Class in net.sourceforge.pmd.lang.rule: Basic abstract implementation of all parser-independent methods of the Rule interface.
AbstractRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractRule
AbstractScope - Class in net.sourceforge.pmd.lang.symboltable: Base class for any Scope.
AbstractScope() - Constructor for class net.sourceforge.pmd.lang.symboltable.AbstractScope
AbstractTokenManager - Class in net.sourceforge.pmd.lang.ast.impl.javacc: A base class for the token managers generated by JavaCC.
AbstractTokenManager() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
AbstractVisitorRule - Class in net.sourceforge.pmd.lang.rule
AbstractVisitorRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractVisitorRule
AbstractXPathFunctionDef - Class in net.sourceforge.pmd.lang.rule.xpath.impl: Base impl for an XPath function definition.
AbstractXPathFunctionDef(String) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.AbstractXPathFunctionDef
AbstractXPathFunctionDef(String, Language) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.AbstractXPathFunctionDef
accept(File, String) - Method in class net.sourceforge.pmd.lang.LanguageFilenameFilter: Check if a file should be checked by PMD.
accept(ParseTreeVisitor<? extends T>) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
accept(ParseTreeVisitor<? extends T>) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrErrorPmdAdapter
acceptVisitor(AstVisitor<? super P, ? extends R>, P) - Method in interface net.sourceforge.pmd.lang.ast.Node: Calls back the visitor's visit method corresponding to the runtime type of this Node.
add(RuleViolation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
addAllVersionsOf(Language) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Add all the versions of the given language, including the default version.
addAnyChild(T) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
addChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode: Set the child at the given index to the given node.
addChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
addConfigError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.Report: Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addConfigurationError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
addContextValue(String, Object) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
addDeclaration(NameDeclaration) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
addDeclaration(NameDeclaration) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Adds a new declaration to this scope.
addDefaultVersion(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Add a new version by its name and make it the default version.
addDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a directory recursively using FileCollector.addFile(Path) on all regular files.
addDirectory(Path, boolean) - Method in class net.sourceforge.pmd.lang.document.FileCollector
addedFile(int) - Method in interface net.sourceforge.pmd.cpd.CPDListener
addedFile(int) - Method in class net.sourceforge.pmd.cpd.CPDNullListener
addedFile(int) - Method in class net.sourceforge.pmd.cpd.GUI
addError(Report.ProcessingError) - Method in class net.sourceforge.pmd.Report: Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
addExample(String) - Method in interface net.sourceforge.pmd.Rule: Add a single example for this Rule.
addFile(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a file, language is determined automatically from the extension/file patterns.
addFile(Path, Language) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a file with the given language (which overrides the file patterns).
addFile(TextFile) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a pre-configured text file.
addFileOrDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a file or directory recursively.
addFileOrDirectory(Path, boolean) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a file or directory recursively.
addInputPath(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration: Add an input path.
AdditionalInfo(String) - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
AdditionalInfo(String, String) - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
addListener(GlobalAnalysisListener) - Method in class net.sourceforge.pmd.PmdAnalysis: Add a new listener.
addListeners(Collection<? extends GlobalAnalysisListener>) - Method in class net.sourceforge.pmd.PmdAnalysis: Add several listeners at once.
addNameOccurrence(NameOccurrence) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
addNameOccurrence(NameOccurrence) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Adds a NameOccurrence to this scope - only call this after getting a true back from Scope.contains(NameOccurrence).
addRelativizeRoot(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration: Set the path used to shorten paths output in the report.
addRelativizeRoots(List<Path>) - Method in class net.sourceforge.pmd.AbstractConfiguration: Add several paths to shorten paths that are output in the report.
addRenderer(Renderer) - Method in class net.sourceforge.pmd.PmdAnalysis: Add a new renderer.
addRenderers(Collection<Renderer>) - Method in class net.sourceforge.pmd.PmdAnalysis: Add several renderers at once.
addRuleChainVisit(Class<? extends Node>) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Override AbstractRule.buildTargetSelector(), this is provided for legacy compatibility
addRuleName(String) - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
addRuleSet(String) - Method in class net.sourceforge.pmd.PMDConfiguration: Add a new ruleset paths to load when starting the analysis.
addRuleSet(RuleSet) - Method in class net.sourceforge.pmd.PmdAnalysis: Add a new ruleset.
addRuleSets(Collection<RuleSet>) - Method in class net.sourceforge.pmd.PmdAnalysis: Add several rulesets at once.
addRuleViolation(RuleViolation) - Method in class net.sourceforge.pmd.Report: Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addRunTimeError(Report.ProcessingError) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
addSourceFile(FileId, String) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Add a text file given its contents and a name.
addVersion(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Add a new version by its name.
addViolation(Object, Node) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolation(node).
addViolation(Object, Node, Object...) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolation(node, arg1, arg2).
addViolation(Object, Node, String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolation(node, arg).
addViolation(Node) - Method in class net.sourceforge.pmd.RuleContext: Record a new violation of the contextual rule, at the given node.
addViolation(Node, Object...) - Method in class net.sourceforge.pmd.RuleContext: Record a new violation of the contextual rule, at the given node.
addViolation(RuleViolation) - Method in class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
addViolationNoSuppress(RuleViolation) - Method in class net.sourceforge.pmd.RuleContext: Force the recording of a violation, ignoring the violation suppression mechanism (ViolationSuppressor).
addViolations(List<RuleViolation>) - Method in class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
addViolationWithMessage(Object, Node, String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolationWithMessage(node, message).
addViolationWithMessage(Object, Node, String, int, int) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolationWithPosition(node, beginLine, endLine, message).
addViolationWithMessage(Object, Node, String, Object[]) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Replace with asCtx(data).addViolationWithMessage(node, message, args).
addViolationWithMessage(Node, String) - Method in class net.sourceforge.pmd.RuleContext: Record a new violation of the contextual rule, at the given node.
addViolationWithMessage(Node, String, Object...) - Method in class net.sourceforge.pmd.RuleContext: Record a new violation of the contextual rule, at the given node.
addViolationWithPosition(Node, int, int, String, Object...) - Method in class net.sourceforge.pmd.RuleContext: Record a new violation of the contextual rule, at the given node.
addZipFile(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Deprecated.
Use FileCollector.addZipFileWithContent(Path) instead.
addZipFileWithContent(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Opens a zip file and adds all files of the zip file to the list of files to be processed.
advance(Iterator<?>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Advance n times.
all(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns true if all elements of the iterable match the predicate.
all(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns whether all elements of this stream match the provided predicate.
ALL - net.sourceforge.pmd.lang.rule.xpath.NoAttribute.NoAttrScope: All attributes are suppressed, except those from Node and AbstractNode.
allMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Returns whether all elements match the predicate.
always() - Static method in class net.sourceforge.pmd.internal.util.PredicateUtil: A predicate that always returns true.
ANALYSIS_CACHE - net.sourceforge.pmd.benchmark.TimedOperationCategory
AnalysisCache - Interface in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
AnalysisCacheListener - Class in net.sourceforge.pmd.cache: Deprecated.
AnalysisCacheListener(AnalysisCache, RuleSets, ClassLoader, Collection<? extends TextFile>) - Constructor for class net.sourceforge.pmd.cache.AnalysisCacheListener: Deprecated.
analysisFailed(TextDocument) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
analysisFailed(TextDocument) - Method in interface net.sourceforge.pmd.cache.AnalysisCache: Deprecated.

Notifies the cache that analysis of the given file has failed and should not be cached.
analysisFailed(TextDocument) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
AnalysisResult - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
AnalysisResult(long) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
AnalysisResult(long, List<RuleViolation>) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
AnalysisTask(RuleSets, List<TextFile>, GlobalAnalysisListener, int, AnalysisCache, MessageReporter, LanguageProcessorRegistry) - Constructor for class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask: Create a new task.
analyzeToken(T) - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter: Extension point for subclasses to analyze all tokens (before filtering) and update internal status to decide on custom discard rules.
analyzeTokens(T, Iterable<T>) - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter: Extension point for subclasses to analyze all tokens (before filtering) and update internal status to decide on custom discard rules.
ancestors() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
ancestors() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing all the strict ancestors of this node, in innermost to outermost order.
ancestors() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the ancestors of the nodes contained in this stream.
ancestors(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the ancestor stream of this node filtered by the given node type.
ancestors(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the ancestor stream of each node in this stream, filtered by the given node type.
ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing this node and its ancestors.
ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing the nodes contained in this stream and their ancestors.
AntlrBaseParser<N extends AntlrNode<N>,R extends BaseAntlrInnerNode<N> & RootNode> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Generic Antlr parser adapter for all Antlr parsers.
AntlrBaseParser() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
AntlrErrorPmdAdapter(BaseAntlrTerminalNode<N>, Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrErrorPmdAdapter
AntlrGeneratedParserBase<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: This is the base class for antlr generated parsers.
AntlrGeneratedParserBase(TokenStream) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
AntlrNameDictionary - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Stores the XPath name of antlr terminals.
AntlrNameDictionary(Vocabulary, String[]) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
AntlrNode<N extends AntlrNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.antlr4: Base interface for all Antlr-based implementation of the Node interface.
AntlrTerminalPmdAdapter(BaseAntlrTerminalNode<N>, Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrTerminalPmdAdapter
AntlrToken - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Generic Antlr representation of a token.
AntlrToken(Token, AntlrToken, TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken: Constructor
AntlrTokenFilter - Class in net.sourceforge.pmd.cpd.impl: A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream
AntlrTokenFilter(TokenManager<AntlrToken>) - Constructor for class net.sourceforge.pmd.cpd.impl.AntlrTokenFilter: Creates a new AntlrTokenFilter
AntlrTokenizer - Class in net.sourceforge.pmd.cpd.impl: Generic implementation of a Tokenizer useful to any Antlr grammar.
AntlrTokenizer() - Constructor for class net.sourceforge.pmd.cpd.impl.AntlrTokenizer
AntlrTokenManager - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Generic token manager implementation for all Antlr lexers.
AntlrTokenManager(Lexer, TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
any(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns true if any element of the iterable matches the predicate.
any(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns whether any elements of this stream match the provided predicate.
anyMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Returns whether some element match the predicate.
AnyTokenizer - Class in net.sourceforge.pmd.cpd: Simple tokenization into words and separators.
AnyTokenizer() - Constructor for class net.sourceforge.pmd.cpd.AnyTokenizer
AnyTokenizer(String) - Constructor for class net.sourceforge.pmd.cpd.AnyTokenizer
append(StringBuilder, CharSequence) - Static method in class net.sourceforge.pmd.util.StringUtil: Like StringBuilder.append(CharSequence), but uses an optimized implementation if the charsequence happens to be a Chars.
append(NodeStream<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a new node stream that contains all the elements of this stream, then all the elements of the given stream.
appendBoundaryForNodeLn(Node, Appendable, String) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
appendChars(StringBuilder) - Method in class net.sourceforge.pmd.lang.document.Chars: Append this character sequence on the given stringbuilder.
appendChars(StringBuilder, int, int) - Method in class net.sourceforge.pmd.lang.document.Chars: Appends the character range identified by start and end offset into the string builder.
appendIndent(Appendable, String, boolean) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
appendNodeInfoLn(Appendable, Node) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer: Append info about the node.
appendSuffix(StringBuilder, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Appends the suffix of length 'len' of the current token to the given string builder.
Applier - Class in net.sourceforge.pmd.lang.symboltable
applies(FileId) - Method in class net.sourceforge.pmd.RuleSet: Check if a given source file should be checked by rules in this RuleSet.
applies(TextFile) - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Check if a given source file should be checked by rules in this RuleSets.
applies(Rule, LanguageVersion) - Static method in class net.sourceforge.pmd.RuleSet: Deprecated.
This is internal API, removed in PMD 7. You should not use a ruleset directly.
apply(Predicate<E>, Iterator<? extends E>) - Static method in class net.sourceforge.pmd.lang.symboltable.Applier
apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractVisitorRule
apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.XPathRule
apply(Node, RuleContext) - Method in interface net.sourceforge.pmd.Rule: Process the given node.
apply(RootNode, FileAnalysisListener) - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Apply all applicable rules to the compilation units.
apply(ViolationDecorator, Node) - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator
artifactLocation(SarifLog.ArtifactLocation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation.PhysicalLocationBuilder: The location of the artifact.
asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
asChildOf(FileId, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a file ID whose methods behave the same as the first parameter, and whose FileId.getParentFsPath() returns the second parameter.
asCtx(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Cast the argument to a RuleContext.
asInstanceOf(Class<? extends O>, Class<? extends O>...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a map function, that checks whether the parameter is an instance of any of the given classes.
asPmdNode(RuleContext) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
asReadOnly() - Method in class net.sourceforge.pmd.lang.document.TextFileBuilder: Specify that the built file is read only.
asReversed(List<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
AssertionUtil - Class in net.sourceforge.pmd.util
assertValidJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
assertValidJavaBinaryNameNoArray(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
assertValidStringRange(CharSequence, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil: Like AssertionUtil.validateStringRange(CharSequence, int, int) but eliminated at runtime if running without assertions.
asSingle(Set<T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: If the set has a single element, returns it, otherwise returns null.
associateBy(Collection<? extends V>, Function<? super V, ? extends K>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
associateByTo(Map<K, V>, Collection<? extends V>, Function<? super V, ? extends K>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
associatedRule(SarifLog.AssociatedRule) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder: An associated rule
associateWith(Collection<? extends K>, Function<? super K, ? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
associateWithTo(Map<K, V>, Collection<? extends K>, Function<? super K, ? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
asStream() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
asStream() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing only this node.
asString(Object[], String) - Static method in class net.sourceforge.pmd.util.StringUtil: Formats all items onto a string with separators if more than one exists, return an empty string if the items are null or empty.
AstInfo<T extends RootNode> - Class in net.sourceforge.pmd.lang.ast: The output of Parser.parse(ParserTask).
AstInfo(Parser.ParserTask, T) - Constructor for class net.sourceforge.pmd.lang.ast.AstInfo
AstVisitor<P,R> - Interface in net.sourceforge.pmd.lang.ast: Root interface for AST visitors.
AstVisitorBase<P,R> - Class in net.sourceforge.pmd.lang.ast: Base implementation of AstVisitor, that performs a top-down (preorder) visit and may accumulate a result.
AstVisitorBase() - Constructor for class net.sourceforge.pmd.lang.ast.AstVisitorBase
Attribute - Class in net.sourceforge.pmd.lang.rule.xpath: Represents an XPath attribute of a specific node.
Attribute(Node, String, MethodHandle, Method) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.Attribute: Creates a new attribute belonging to the given node using its accessor.
Attribute(Node, String, String) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.Attribute: Creates a new attribute belonging to the given node using its string value.
AttributeAxisIterator - Class in net.sourceforge.pmd.lang.rule.xpath.impl: Explores an AST node reflectively to iterate over its XPath attributes.
AttributeAxisIterator(Node) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator: Creates a new iterator that enumerates the attributes of the given node.
AUX_CLASSPATH - Static variable in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
auxClassPathChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
availableInXPath(boolean) - Method in class net.sourceforge.pmd.properties.PropertyBuilder: If true, the property will be made available to XPath queries as an XPath variable.

B

BackslashEscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc: A base class for readers that handle escapes starting with a backslash.
BackslashEscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
backup(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Pushes a given number of already read chars into the buffer.
BaseAntlrErrorNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
BaseAntlrErrorNode(Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
BaseAntlrInnerNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Base class for the inner nodes (corresponds to ParserRuleContext).
BaseAntlrInnerNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
BaseAntlrInnerNode(ParserRuleContext, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
BaseAntlrNode<A extends BaseAntlrNode.AntlrToPmdParseTreeAdapter<N>,N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Base class for an antlr node.
BaseAntlrNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
BaseAntlrNode.AntlrToPmdParseTreeAdapter<N extends AntlrNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.antlr4
BaseAntlrTerminalNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4: Base class for terminal nodes (they wrap a TerminalNode).
BaseAntlrTerminalNode(Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
BaseAntlrTerminalNode.AntlrErrorPmdAdapter<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
BaseAntlrTerminalNode.AntlrTerminalPmdAdapter<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
BaseCloseable - Class in net.sourceforge.pmd.internal.util
BaseCloseable() - Constructor for class net.sourceforge.pmd.internal.util.BaseCloseable
BaseResultProducingCloseable<T> - Class in net.sourceforge.pmd.util: Base class for an autocloseable that produce a result once it has been closed.
BaseResultProducingCloseable() - Constructor for class net.sourceforge.pmd.util.BaseResultProducingCloseable
BaseTokenFilter<T extends GenericToken<T>> - Class in net.sourceforge.pmd.cpd.impl: A generic filter for PMD token managers that allows to use comments to enable / disable analysis of parts of the stream
BaseTokenFilter(TokenManager<T>) - Constructor for class net.sourceforge.pmd.cpd.impl.BaseTokenFilter: Creates a new BaseTokenFilter
BatchLanguageProcessor<P extends LanguagePropertyBundle> - Class in net.sourceforge.pmd.lang.impl: A base class for language processors.
BatchLanguageProcessor(P) - Constructor for class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
below(N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints: Requires the number to be lower than an upper bound.
bench(String, Runnable) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
bench(String, Supplier<T>) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
BLACK - net.sourceforge.pmd.util.GraphUtil.DotColor
body - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Content
BODY_PLACEHOLDER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
BomAwareInputStream(InputStream) - Constructor for class net.sourceforge.pmd.internal.util.IOUtil.BomAwareInputStream
BOOLEAN - net.sourceforge.pmd.properties.PropertyTypeId
booleanProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a boolean property.
bufpos - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator: Position of the next char to read in the input.
build() - Method in class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
build() - Method in class net.sourceforge.pmd.lang.document.TextFileBuilder: Creates and returns the new text file.
build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder: Builds the descriptor and returns it.
build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation.ArtifactLocationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule.AssociatedRuleBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception.ExceptionBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation.InvocationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location.LocationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message.MessageBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage.MultiformatMessageBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation.PhysicalLocationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag.PropertyBagBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.SarifLogBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool.ToolBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
builderForCharSeq(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns a read-only TextFile reading from a string.
builderForPath(Path, Charset, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns a builder for a textfile that reads and write to the file.
builderForReader(Reader, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns a read-only builder reading from a reader.
buildMap(Consumer<Map<K, V>>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
buildMap(Map<K, V>, Consumer<Map<K, V>>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
buildRegexFilterIncludeOverExclude(Collection<Pattern>, Collection<Pattern>) - Static method in class net.sourceforge.pmd.internal.util.PredicateUtil: Builds a string filter using a set of include and exclude regular expressions.
buildReport(Consumer<? super FileAnalysisListener>) - Static method in class net.sourceforge.pmd.Report: Create a report by making side effects on a FileAnalysisListener.
buildRule(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.rules.RuleFactory: Deprecated.

Parses a rule element and returns a new rule instance.
buildTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Create the targeting strategy for this rule.
buildTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
buildVisitor() - Method in class net.sourceforge.pmd.lang.rule.AbstractVisitorRule: Returns a rule visitor that can visit nodes for the given rule context.

C

cached() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the elements of this node stream, but which will evaluate the upstream pipeline only once.
CachedRuleMapper - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
CachedRuleMapper() - Constructor for class net.sourceforge.pmd.cache.CachedRuleMapper: Deprecated.
CachedRuleViolation - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
cacheExists() - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.

Returns true if the cache exists.
cacheExists() - Method in class net.sourceforge.pmd.cache.FileAnalysisCache: Deprecated.
callableStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: CallableStatement to return source code.
CAMEL_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention: camelCase.
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
cannotVisit(Node, P) - Method in interface net.sourceforge.pmd.lang.ast.AstVisitor: Called by a node when it detects that the visitor is not of the language it is used to visiting.
caret(FileId, int, int) - Static method in class net.sourceforge.pmd.lang.document.FileLocation: Returns a new location that starts and ends at the same position.
caretAt(int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion: Builds a new region with zero length and placed at the given offset.
castIfSupported(Node) - Method in interface net.sourceforge.pmd.lang.metrics.Metric: Casts the node to the more specific type <N> if this metric can be computed on it.
categories - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
chain(List<? extends ViolationDecorator>) - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator: Apply several decorators in a chain.
CHARACTER - net.sourceforge.pmd.properties.PropertyTypeId
CHARACTER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
CHARACTERSET - net.sourceforge.pmd.util.database.DBType.Property
charAt(int) - Method in class net.sourceforge.pmd.lang.document.Chars
charListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of characters.
charProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a character property.
Chars - Class in net.sourceforge.pmd.lang.document: View on a string which doesn't copy the array for subsequence operations.
CharStream - Class in net.sourceforge.pmd.lang.ast.impl.javacc: PMD flavour of character streams used by JavaCC parsers.
check_name - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
ChecksumAware - Interface in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
checkValidity(RuleSets, ClassLoader, Collection<? extends TextFile>) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
checkValidity(RuleSets, ClassLoader, Collection<? extends TextFile>) - Method in interface net.sourceforge.pmd.cache.AnalysisCache: Deprecated.

Checks if the cache is valid for the configured rulesets and class loader.
checkValidity(RuleSets, ClassLoader, Collection<? extends TextFile>) - Method in class net.sourceforge.pmd.cache.FileAnalysisCache: Deprecated.
checkValidity(RuleSets, ClassLoader, Collection<? extends TextFile>) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
children() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
children() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
children() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing all the children of this node.
children() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the children of the nodes contained in this stream.
children(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream of the children of this node that are of the given type.
children(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the children stream of each node in this stream, filtered by the given node type.
CLASS - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
CLASS - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
CLASS_AND_METHOD_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
CLASS_NAME - Static variable in interface net.sourceforge.pmd.RuleViolation: Key in RuleViolation.getAdditionalInfo() for the name of the class in which the violation was identified.
ClasspathClassLoader - Class in net.sourceforge.pmd.internal.util: Create a ClassLoader which loads classes using a CLASSPATH like String.
ClasspathClassLoader(String, ClassLoader) - Constructor for class net.sourceforge.pmd.internal.util.ClasspathClassLoader
ClasspathClassLoader(List<File>, ClassLoader) - Constructor for class net.sourceforge.pmd.internal.util.ClasspathClassLoader
clearNodeScope(N) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
clearResults() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
close() - Method in interface net.sourceforge.pmd.benchmark.TimedOperation: Stops tracking if not already stopped.
close() - Method in class net.sourceforge.pmd.cache.AnalysisCacheListener: Deprecated.
close() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
close() - Method in interface net.sourceforge.pmd.cpd.TokenFactory: This adds the EOF token, it must be called when Tokenizer.tokenize(TextDocument, TokenFactory) is done.
close() - Method in class net.sourceforge.pmd.internal.util.BaseCloseable: Noop if called several times.
close() - Method in class net.sourceforge.pmd.lang.document.FileCollector: Close registered resources like zip files.
close() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Closing a document closes the underlying TextFile.
close() - Method in interface net.sourceforge.pmd.lang.document.TextFile: Release resources associated with this text file.
close() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
close() - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry: Close all processors in this registry.
close() - Method in class net.sourceforge.pmd.PmdAnalysis
close() - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener: Signals the end of the analysis: no further calls will be made to this listener.
close() - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener: Notify the implementation that the analysis ended, ie all files have been processed.
close() - Method in interface net.sourceforge.pmd.reporting.ListenerInitializer: Signals the end of initialization: no further calls will be made to this object.
close() - Method in class net.sourceforge.pmd.RuleSetWriter
close() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable: Close this object.
close() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource: Deprecated.
close(int) - Method in interface net.sourceforge.pmd.benchmark.TimedOperation: Stops tracking if not already stopped.
closeAll(Collection<? extends AutoCloseable>) - Static method in class net.sourceforge.pmd.internal.util.IOUtil: Close all closeable resources in order.
closeImpl() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable: Close this closeable as per the contract of Closeable.close().
closeNodeScope(N, boolean, JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Close the node scope if the condition is true.
closeNodeScope(N, int, JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Close the node scope and adds the given number of children to the node.
closeQuietly(Closeable) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
CODECLIMATE_DEFAULT_CATEGORIES - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
CodeClimateIssue - Class in net.sourceforge.pmd.renderers: Structure for the Code Climate Issue spec (https://github.com/codeclimate/spec/blob/master/SPEC.md#issues)
CodeClimateIssue() - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue
CodeClimateIssue.Content - Class in net.sourceforge.pmd.renderers: Content structure
CodeClimateIssue.Location - Class in net.sourceforge.pmd.renderers: Location structure
CodeClimateRenderer - Class in net.sourceforge.pmd.renderers: Renderer for Code Climate JSON format
CodeClimateRenderer() - Constructor for class net.sourceforge.pmd.renderers.CodeClimateRenderer
coerceWildcard(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Coerce an iterator with a wildcard.
collect(Collector<? super T, A, R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Collects the elements of this node stream using the specified Collector.
COLLECT_FILES - net.sourceforge.pmd.benchmark.TimedOperationCategory
collectDB(FileCollector, URI) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
collectFileList(FileCollector, Path) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
collectFiles(AbstractConfiguration, FileCollector) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
collectFiles(FileCollector, List<Path>) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
collectFilesRecursively() - Method in class net.sourceforge.pmd.AbstractConfiguration
collectFilesRecursively(boolean) - Method in class net.sourceforge.pmd.AbstractConfiguration
CollectionUtil - Class in net.sourceforge.pmd.util: Generic collection-related utility functions for java.util types.
COLOR - Static variable in class net.sourceforge.pmd.renderers.TextColorRenderer
columnNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil: Returns the (1-based) column number of the character at the given index.
commaSeparatedList(Function<? super Language, String>) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Formats the set of languages with the given formatter, sort and join everything with commas.
COMPARATOR - Static variable in class net.sourceforge.pmd.lang.document.FileLocation
compareLocation(Node) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
compareLocation(Node) - Method in interface net.sourceforge.pmd.lang.ast.Node: Compare the coordinates of this node with the other one as if with Node.COORDS_COMPARATOR.
compareTo(TextPos2d) - Method in class net.sourceforge.pmd.lang.document.TextPos2d: Compares the start offset, then the length of a region.
compareTo(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Compares the start offset, then the length of a region.
compareTo(Mark) - Method in class net.sourceforge.pmd.cpd.Mark
compareTo(Match) - Method in class net.sourceforge.pmd.cpd.Match
compareTo(TokenEntry) - Method in class net.sourceforge.pmd.cpd.TokenEntry
compareTo(AntlrToken) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
compareTo(FileId) - Method in interface net.sourceforge.pmd.lang.document.FileId
compareTo(TextRange2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
compareTo(Language) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
compareTo(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersion
compareTo(T) - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: This must return true if this token comes before the other token.
compareToVersion(String) - Method in class net.sourceforge.pmd.lang.LanguageVersion: Compare this version to another version of the same language identified by the given version string.
complement() - Method in enum net.sourceforge.pmd.util.OptionalBool: Returns the logical complement.
compute(Metric<N, R>, Node, MetricOptions) - Static method in interface net.sourceforge.pmd.lang.metrics.Metric: Compute a metric on an arbitrary node, if possible.
compute(DataMap.DataKey<? extends K, T>, Function<? super T, ? extends T>) - Method in class net.sourceforge.pmd.util.DataMap: Create or replace a mapping with a value computed from the current value (or null if missing).
computeAllMetricsFor(Node) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider: Computes all metrics available on the given node.
computeFor(N, MetricOptions) - Method in interface net.sourceforge.pmd.lang.metrics.Metric: Computes the value of the metric for the given node.
computeIfAbsent(DataMap.DataKey<? extends K, T>, Supplier<? extends T>) - Method in class net.sourceforge.pmd.util.DataMap: Retrieve the value, or compute it if it is missing.
computeMetric(Metric<? super N, R>, N) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil: Computes a metric identified by its code on a node, with the default options.
computeMetric(Metric<? super N, R>, N, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil: Computes a metric identified by its code on a node, possibly selecting a variant with the options parameter.
computeMetric(Metric<? super N, R>, N, MetricOptions, boolean) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil: Computes a metric identified by its code on a node, possibly selecting a variant with the options parameter.
computeNext() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator: Compute the next element.
computeStatistics(Metric<? super O, ?>, Iterable<? extends O>) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil: Computes statistics for the results of a metric over a sequence of nodes.
computeStatistics(Metric<? super O, ?>, Iterable<? extends O>, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil: Computes statistics for the results of a metric over a sequence of nodes.
concat(Iterator<? extends T>, Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
concatView(List<? extends T>, List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns a list view that pretends it is the concatenation of both lists.
configErrors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer: Accumulated configuration errors.
ConfigurableFileNameRenderer - Class in net.sourceforge.pmd.reporting
ConfigurableFileNameRenderer() - Constructor for class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer
ConfigurationError(Rule, String) - Constructor for class net.sourceforge.pmd.Report.ConfigurationError: Creates a new configuration error for a specific rule.
connection - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: Connection management
ConstraintViolatedException - Exception in net.sourceforge.pmd.properties: Thrown when a property constraint is violated.
CONSTRUCTOR - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
contains(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns true if this region contains the character at the given offset.
contains(TextPos2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
contains(TextRange2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
contains(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns true if this region contains the entirety of the other region.
contains(MetricOption) - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions: Returns true if this bundle contains the given option.
contains(NameOccurrence) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
contains(NameOccurrence) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Tests whether or not a NameOccurrence is directly contained in the scope.
content - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
Content(String) - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue.Content: Strip out all newlines from the body
contentEquals(CharSequence) - Method in class net.sourceforge.pmd.lang.document.Chars: Like Chars.contentEquals(CharSequence, boolean), considering case distinctions.
contentEquals(CharSequence, boolean) - Method in class net.sourceforge.pmd.lang.document.Chars: Returns true if this char sequence is logically equal to the parameter.
contexted(AssertionError) - Static method in class net.sourceforge.pmd.util.AssertionUtil
contexted(RuntimeException) - Static method in class net.sourceforge.pmd.util.AssertionUtil
contexted(StackOverflowError) - Static method in class net.sourceforge.pmd.util.AssertionUtil
ContextedAssertionError - Error in net.sourceforge.pmd.util: An AssertionError with nice messages.
ContextedStackOverflowError - Error in net.sourceforge.pmd.util: A StackOverflowError with nice messages.
convertTo(StringUtil.CaseConvention, String) - Method in enum net.sourceforge.pmd.util.StringUtil.CaseConvention
COORDS_COMPARATOR - Static variable in interface net.sourceforge.pmd.lang.ast.Node: Compares nodes according to their location in the file.
COORDS_COMPARATOR - Static variable in class net.sourceforge.pmd.lang.document.FileLocation
copy(InputStream, OutputStream) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
copy(Reader, Writer) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
copy(RuleSet) - Static method in class net.sourceforge.pmd.RuleSet: Creates a copy of the given ruleset.
copyFrom(BaseAntlrInnerNode<N>) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
copyPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource: Deprecated.
Just use AbstractPropertySource.getPropertyDescriptors()
copyPropertyValues() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource: Deprecated.
Just use AbstractPropertySource.getPropertiesByPropertyDescriptor() or AbstractPropertySource.getOverriddenPropertiesByPropertyDescriptor()
count() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the number of nodes in this stream.
count(Iterator<?>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Counts the items in this iterator, exhausting it.
CPD - Static variable in class net.sourceforge.pmd.lang.LanguageRegistry: Contains the languages that support CPD and are found on the classpath of the classloader of this class.
CPD_ANONYMIZE_IDENTIFIERS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CPD_ANONYMIZE_LITERALS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CPD_IGNORE_IMPORTS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CPD_IGNORE_LITERAL_AND_IDENTIFIER_SEQUENCES - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CPD_IGNORE_LITERAL_SEQUENCES - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CPD_IGNORE_METADATA - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
CpdAnalysis - Class in net.sourceforge.pmd.cpd: Main programmatic API of CPD.
CpdCapableLanguage - Interface in net.sourceforge.pmd.cpd: A language that supports CPD.
CPDConfiguration - Class in net.sourceforge.pmd.cpd
CPDConfiguration() - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
CPDConfiguration(LanguageRegistry) - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
CpdLanguageProperties - Class in net.sourceforge.pmd.cpd: These are language properties common to multiple CpdCapableLanguages.
CPDListener - Interface in net.sourceforge.pmd.cpd
CPDNullListener - Class in net.sourceforge.pmd.cpd
CPDNullListener() - Constructor for class net.sourceforge.pmd.cpd.CPDNullListener
CpdOnlyLanguageModuleBase - Class in net.sourceforge.pmd.lang.impl: Base class for language modules that only support CPD and not PMD.
CpdOnlyLanguageModuleBase(LanguageModuleBase.LanguageMetadata) - Constructor for class net.sourceforge.pmd.lang.impl.CpdOnlyLanguageModuleBase: Construct a module instance using the given metadata.
CPDReport - Class in net.sourceforge.pmd.cpd: The result of a CPD analysis.
CPDReportRenderer - Interface in net.sourceforge.pmd.cpd: Render a CPDReport to a file.
create(String, String, String, Collection<Pattern>, Collection<Pattern>, Iterable<? extends Rule>) - Static method in class net.sourceforge.pmd.RuleSet: Creates a new ruleset with the given metadata such as name, description, fileName, exclude/include patterns are used.
create(CPDConfiguration) - Static method in class net.sourceforge.pmd.cpd.CpdAnalysis: Create a new instance from the given configuration.
create(TextDocument) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Create a new char stream for the given document with the default token document behavior.
create(TextDocument, JavaccTokenDocument.TokenDocumentBehavior) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Create a new char stream for the given document.
create(TextFile) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument: Create a new text document for the given text file.
create(LanguageRegistry, Map<Language, LanguagePropertyBundle>, MessageReporter) - Static method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry: Create a new instance by creating a processor for each language in the given language registry.
create(PMDConfiguration) - Static method in class net.sourceforge.pmd.PmdAnalysis: Constructs a new instance from a configuration.
create(FileAnalysisListener, Rule) - Static method in class net.sourceforge.pmd.RuleContext: Create a new RuleContext.
createCpdTokenizer(LanguagePropertyBundle) - Method in interface net.sourceforge.pmd.cpd.CpdCapableLanguage: Create a new Tokenizer for this language, given a property bundle with configuration.
createCpdTokenizer(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.impl.CpdOnlyLanguageModuleBase
createCpdTokenizer(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.PlainTextLanguage
createErrorNode(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
createLineRange(int, int) - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a region that spans the text of all the given lines.
createPmdError(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
createPmdTerminal(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
createProcessor(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.impl.SimpleLanguageModuleBase
createProcessor(LanguagePropertyBundle) - Method in interface net.sourceforge.pmd.lang.PmdCapableLanguage: Create a new LanguageProcessor for this language, given a property bundle with configuration.
createRenderer() - Method in class net.sourceforge.pmd.PMDConfiguration: Create a Renderer instance based upon the configured reporting options.
createRenderer(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration: Create a Renderer instance based upon the configured reporting options.
createRenderer(String, Properties) - Static method in class net.sourceforge.pmd.renderers.RendererFactory: Construct an instance of a Renderer based on report format name.
createTerminalNode(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
createToken(int, CharStream, String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
createToken(JavaccTokenDocument, int, CharStream, String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior: Creates a new token with the given kind.
createWriter() - Static method in class net.sourceforge.pmd.internal.util.IOUtil: Creates a writer that writes to stdout using the system default charset.
createWriter(String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil: Creates a writer that writes to the given file or to stdout.
createWriter(Charset, String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil: Creates a writer that writes to the given file or to stdout.
crossFindBoundaries() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream.DescendantNodeStream: An alias for crossFindBoundaries(true).
crossFindBoundaries(boolean) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream.DescendantNodeStream: Returns a node stream that will not stop the tree traversal when encountering a find boundary.
CSVRenderer - Class in net.sourceforge.pmd.cpd: Renders a report to CSV.
CSVRenderer - Class in net.sourceforge.pmd.renderers: Renderer the results to a comma-delimited text format.
CSVRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
CSVRenderer() - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
CSVRenderer(boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
CSVRenderer(char) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
CSVRenderer(char, boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
CSVRenderer(ColumnDescriptor<RuleViolation>[], String, String) - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
CSVWithLinecountPerFileRenderer - Class in net.sourceforge.pmd.cpd
CSVWithLinecountPerFileRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVWithLinecountPerFileRenderer

D

DataMap<K> - Class in net.sourceforge.pmd.util: An opaque, strongly typed heterogeneous data container.
DataMap.DataKey<K extends DataMap.DataKey<K,T>,T> - Interface in net.sourceforge.pmd.util: A key for type-safe access into a DataMap.
DataMap.SimpleDataKey<T> - Class in net.sourceforge.pmd.util
DataSource - Interface in net.sourceforge.pmd.util.datasource: Deprecated.
Use TextFile
dataSourceCompat(DataSource, PMDConfiguration) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Deprecated.
This is deprecated until PMD 7 is out, after which DataSource will be removed.
DBMSMetadata - Class in net.sourceforge.pmd.util.database: Wrap JDBC connection for use by PMD: DBURI parameters specify the source code to be passed to PMD.
DBMSMetadata(String, String, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata: Define database connection and source code to retrieve with explicit database username and password.
DBMSMetadata(Connection) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata: Minimal constructor
DBMSMetadata(Properties, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata: Define database connection and source code to retrieve with database properties.
DBMSMetadata(DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata: Define database connection and source code to retrieve.
DBType - Class in net.sourceforge.pmd.util.database: Encapsulate the settings needed to access database source code.
DBType(String) - Constructor for class net.sourceforge.pmd.util.database.DBType
DBType(String, String) - Constructor for class net.sourceforge.pmd.util.database.DBType: Load the most specific dbType for the protocol
DBType.Property - Enum in net.sourceforge.pmd.util.database: The names of the properties
dburi - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: DBURI
DBURI - Class in net.sourceforge.pmd.util.database: Provide a single parameter to specify database objects to process.
DBURI(String) - Constructor for class net.sourceforge.pmd.util.database.DBURI: Create DBURI from a string, combining a JDBC URL and query parameters.
DBURI(URI) - Constructor for class net.sourceforge.pmd.util.database.DBURI: Create DBURI from a URI, combining a JDBC URL and query parameters.
decorate(Node, Map<String, String>) - Method in interface net.sourceforge.pmd.reporting.ViolationDecorator: Compute additional key/value pairs about the violation that should be reflected in RuleViolation.getAdditionalInfo().
decorateRule(Rule, RuleSetReference, Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.rules.RuleFactory: Deprecated.

Decorates a referenced rule with the metadata that are overridden in the given rule element.
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
deepCopy() - Method in interface net.sourceforge.pmd.Rule: Creates a new copy of this rule.
deepCopyValuesTo(AbstractRule) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Deprecated.
Use AbstractRule.deepCopy() to create verbatim copies of rules.
DEFAULT - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
DEFAULT - Static variable in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion: The default XPath version for XPath queries.
DEFAULT_COMPARATOR - Static variable in interface net.sourceforge.pmd.RuleViolation: A comparator for rule violations.
DEFAULT_DELIMITER - Static variable in class net.sourceforge.pmd.properties.PropertyFactory: Default delimiter for all properties.
DEFAULT_LANGUAGE - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
DEFAULT_LINECOUNTPERFILE - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
DEFAULT_RENDERER - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.SimpleRenderer
DEFAULT_SKIP_BLOCKS_PATTERN - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties: Deprecated.
DEFAULT_SUPPRESS_MARKER - Static variable in class net.sourceforge.pmd.PMDConfiguration: The default suppress marker string.
DefaultDesignerBindings() - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.CodeClimateRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.CSVRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.EmacsRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.IDEAJRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.JsonRenderer
defaultFileExtension() - Method in interface net.sourceforge.pmd.renderers.Renderer: Return the default filename extension to use.
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.SarifRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextPadRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.XMLRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.XSLTRenderer
defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.YAHTMLRenderer
defaultValue() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
defaultValue(T) - Method in class net.sourceforge.pmd.properties.PropertyBuilder: Specify a default value.
defaultValue(Iterable<? extends V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder: Specify a default value.
defaultValue(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder: Specify a default value using a string pattern.
defaultValue(String, int) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder: Specify a default value using a string pattern.
defaultValues(V, V...) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder: Specify default values.
defensiveUnmodifiableCopy(List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns an unmodifiable copy of the list.
defensiveUnmodifiableCopyToSet(Collection<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
definePropertyDescriptor(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource: Defines a new property.
definitely(boolean) - Static method in enum net.sourceforge.pmd.util.OptionalBool: Returns either YES or NO depending on the given boolean.
DELIMITER - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
dependsOnLanguage(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Record that this language depends on another language, identified by its id.
DEPRECATED - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
DeprecatedAttribute - Annotation Type in net.sourceforge.pmd.lang.rule.xpath: Node attribute getter methods might be annotated with DeprecatedAttribute to mark the attribute as deprecated for XPath.
DeprecatedUntil700 - Annotation Type in net.sourceforge.pmd.annotation: Tags a deprecated member that should not be removed before PMD 7.0.0.
derivePropertiesFromStrings(Map<Language, Properties>, MessageReporter) - Static method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
desc(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder: Specify the description of the property.
descendants() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
descendants() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing all the descendants of this node.
descendants() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the strict descendants of the nodes contained in this stream.
descendants(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream of the descendants of this node that are of the given type.
descendants(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the descendant stream of each node in this stream, filtered by the given node type.
descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a node stream containing this node, then all its descendants.
descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing the nodes contained in this stream and their descendants.
describeKind(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
describeKind(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior: Returns a string that describes the token kind.
describeKindImpl(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior: Describe the given kind.
description - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
description - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
description - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
description() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: Describes the property and the role it plays within the rule it is specified for.
description() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor: Returns a short description of the format of this renderer's output.
DESCRIPTION - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
DesignerBindings - Interface in net.sourceforge.pmd.util.designerbindings: Gathers some services to customise how language implementations bind to the designer.
DesignerBindings.AdditionalInfo - Class in net.sourceforge.pmd.util.designerbindings: An entry for the "additional info" panel.
DesignerBindings.DefaultDesignerBindings - Class in net.sourceforge.pmd.util.designerbindings: A base implementation for DesignerBindings.
DesignerBindings.TreeIconId - Enum in net.sourceforge.pmd.util.designerbindings: See DesignerBindings.getIcon(Node).
determineFileName(List<String>, String) - Static method in class net.sourceforge.pmd.internal.util.ShortFilenameUtil: Determines the filename that should be used in the report depending on the option "shortnames".
determineFileName(FileId) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer: Determines the filename that should be used in the report for the given ID.
diff(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns the set difference of the first collection with the other collections.
displayName() - Method in enum net.sourceforge.pmd.benchmark.TimedOperationCategory
displayName() - Method in interface net.sourceforge.pmd.lang.metrics.Metric: The full name of the metric.
distinct() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a stream consisting of the distinct elements (w.r.t Object.equals(Object)) of this stream.
distinct(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
doClose() - Method in class net.sourceforge.pmd.internal.util.BaseCloseable: Called at most once.
done() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
DONE - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
DOUBLE - net.sourceforge.pmd.properties.PropertyTypeId
DOUBLE_LIST - net.sourceforge.pmd.properties.PropertyTypeId
doubleListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of decimal numbers.
doubleProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a double property.
driver(SarifLog.Component) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool.ToolBuilder: The analysis tool that was run.
DRIVER - net.sourceforge.pmd.util.database.DBType.Property
drop(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a stream consisting of the remaining elements of this stream after discarding the first n elements of the stream.
drop(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Produce an iterator whose first element is the nth element of the given source.
drop(List<T>, int) - Static method in class net.sourceforge.pmd.util.CollectionUtil
dropLast(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a stream consisting of the elements of this stream except the n tail elements.
dropLast(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Remove the last n elements of the iterator.
dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
dysfunctionReason() - Method in interface net.sourceforge.pmd.properties.PropertySource: Deprecated.
PMD 7 will introduce another mechanism to report dysfunctional rules better.
dysfunctionReason() - Method in class net.sourceforge.pmd.renderers.CSVRenderer: We can't show any violations if we don't have any visible columns.

E

elide(String, int, String) - Static method in class net.sourceforge.pmd.util.StringUtil: Truncate the given string to some maximum length.
EmacsRenderer - Class in net.sourceforge.pmd.renderers: Renderer to GNU Emacs parsable format.
EmacsRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmacsRenderer
empty() - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns an empty node stream.
empty() - Static method in class net.sourceforge.pmd.reporting.ReportStats
EMPTY - Static variable in class net.sourceforge.pmd.lang.document.Chars: An empty Chars instance.
emptyDefaultValue() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder: Specify that the default value is an empty collection.
emptyList() - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns the empty list.
emptyOptions() - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions: Returns an empty options bundle.
EmptyRenderer - Class in net.sourceforge.pmd.renderers: An empty renderer, for when you really don't want a report.
EmptyRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmptyRenderer
enableCompatibility(boolean) - Method in class net.sourceforge.pmd.RuleSetLoader: Enable translating old rule references to newer ones, if they have been moved or renamed.
ENCODING - Static variable in class net.sourceforge.pmd.renderers.XMLRenderer
end() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
end() - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
end() - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
end() - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
end() - Method in class net.sourceforge.pmd.renderers.JsonRenderer
end() - Method in interface net.sourceforge.pmd.renderers.Renderer: This method is at the very end of the Rendering process, after Renderer.renderFileReport(Report).
end() - Method in class net.sourceforge.pmd.renderers.SarifRenderer
end() - Method in class net.sourceforge.pmd.renderers.TextRenderer
end() - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
end() - Method in class net.sourceforge.pmd.renderers.XMLRenderer
end() - Method in class net.sourceforge.pmd.renderers.XSLTRenderer
end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
end(RuleContext) - Method in interface net.sourceforge.pmd.Rule: End processing.
endColumn(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder: The column number of the character following the end of the region.
endLine(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder: The line number of the last character in the region.
endsWith(String) - Method in class net.sourceforge.pmd.lang.document.Chars: See String.endsWith(String).
ensureClosed(List<? extends AutoCloseable>, Exception) - Static method in class net.sourceforge.pmd.internal.util.IOUtil: Ensure that the closeables are closed.
ensureOpen() - Method in class net.sourceforge.pmd.internal.util.BaseCloseable
ensureOpen() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator: Check to make sure that the stream has not been closed
ensureOpen() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
ensureOpenIllegalState() - Method in class net.sourceforge.pmd.internal.util.BaseCloseable
ensureReadable() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
enterOuterAlt(BaseAntlrInnerNode<N>, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
enterRecursionRule(BaseAntlrInnerNode<N>, int, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
enterRule(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
enterRule(ParseTreeListener) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
enumListProperty(String, Class<T>, Function<? super T, String>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of <T>.
enumListProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of <T>.
enumProperty(String, Class<T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for an enumerated property for the given enum class, using the toString of its enum constants as labels.
enumProperty(String, Class<T>, Function<? super T, String>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for an enumerated property for the given enum class, using the given function to label its constants.
enumProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for an enumerated property.
EOF - Static variable in class net.sourceforge.pmd.internal.util.IOUtil: Conventional return value for readers.
EOF - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Kind for EOF tokens.
EOL - Static variable in class net.sourceforge.pmd.renderers.EmacsRenderer
equals(Object) - Method in class net.sourceforge.pmd.cpd.Mark
equals(Object) - Method in class net.sourceforge.pmd.cpd.TokenEntry
equals(Object) - Method in class net.sourceforge.pmd.lang.document.Chars
equals(Object) - Method in interface net.sourceforge.pmd.lang.document.FileId: Two file IDs are equal if they have the same FileId.getUriString().
equals(Object) - Method in interface net.sourceforge.pmd.lang.document.TextFile: Text file equality is implementation-defined.
equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextPos2d
equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextRegion
equals(Object) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
equals(Object) - Method in class net.sourceforge.pmd.lang.LanguageVersion
equals(Object) - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
equals(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule: Rules are equal if: They have the same implementation class. They have the same name. They have the same priority. They share the same properties.
equals(Object) - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
equals(Object) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
equals(Object) - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
equals(Object) - Method in class net.sourceforge.pmd.RuleSet: Two rulesets are equals, if they have the same name and contain the same rules.
equals(Object) - Method in class net.sourceforge.pmd.util.database.DBType
equals(Object) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource: Deprecated.
equals(Object) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
equalsNormalizedPaths(String, String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
ERR__BLANK_REQUIRED_ATTRIBUTE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__CONSTRAINT_NOT_SATISFIED - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__INVALID_LANG_VERSION - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__INVALID_LANG_VERSION_NO_NAMED_VERSION - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__INVALID_PRIORITY_VALUE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__INVALID_VALUE_RANGE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__INVALID_VERSION_RANGE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__LIST_CONSTRAINT_NOT_SATISFIED - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__MISSING_REQUIRED_ATTRIBUTE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__MISSING_REQUIRED_ELEMENT - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__PROPERTY_DOES_NOT_EXIST - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__UNEXPECTED_ATTRIBUTE_IN - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages: {0}: unexpected attr name; {1}: parent node name
ERR__UNEXPECTED_ELEMENT - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages: {0}: unexpected element name; {1}: parent node name; {2}: list of allowed elements in this context
ERR__UNEXPECTED_ELEMENT_IN - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages: {0}: unexpected element name; {1}: parent node name
ERR__UNSUPPORTED_PROPERTY_TYPE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
ERR__UNSUPPORTED_VALUE_ATTRIBUTE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
error(Throwable, String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter: Only one of the cause or the message can be null.
error(String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
error(Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
error(Node, String, Object...) - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter: Report an error at the given location.
errorEx(String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
errorEx(String, Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
errorKind() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
errorKind() - Method in exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
errorKind() - Method in exception net.sourceforge.pmd.lang.ast.ParseException
errorKind() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
errors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer: Accumulated processing errors.
escapeJava(String) - Static method in class net.sourceforge.pmd.util.StringUtil: Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
EscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc: An object that can translate an input document into an output document, typically by replacing escape sequences with the character they represent.
EscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator: Create a translator that will read from the given document.
escapeWhitespace(Object) - Static method in class net.sourceforge.pmd.util.StringUtil: Replace some whitespace characters so they are visually apparent.
EVALUATION - net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
EXAMPLE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
exception - Variable in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
exception(SarifLog.Exception) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder: A exception component to detail the tool exception
ExceptionContextDefaultImpl<T extends Throwable & org.apache.commons.lang3.exception.ExceptionContext> - Interface in net.sourceforge.pmd.internal.util
exceptionThrower() - Static method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener: A listener that throws processing errors when they occur.
exclude(FileCollector) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Remove all files collected by the given collector from this one.
EXCLUDE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
EXCLUDE_PATTERN - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
executionClassPathChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
executionSuccessful(Boolean) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation.InvocationBuilder
exitRule(ParseTreeListener) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
Experimental - Annotation Type in net.sourceforge.pmd.annotation: Indicates the feature is in experimental state: its existence, signature or behavior might change without warning from one release to the next.
export() - Method in class net.sourceforge.pmd.util.treeexport.TreeExporter
extensions(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Record the extensions assigned to the language.
extensions(Collection<String>) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Record the extensions assigned to the language.
EXTERNAL_INFO_URL - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants

F

FIELD - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
FILE_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
FILE_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory
FileAnalysisCache - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
FileAnalysisCache(File) - Constructor for class net.sourceforge.pmd.cache.FileAnalysisCache: Deprecated.

Creates a new cache backed by the given file.
FileAnalysisException - Exception in net.sourceforge.pmd.lang.ast: An exception that occurs while processing a file.
FileAnalysisException() - Constructor for exception net.sourceforge.pmd.lang.ast.FileAnalysisException
FileAnalysisException(String) - Constructor for exception net.sourceforge.pmd.lang.ast.FileAnalysisException
FileAnalysisException(String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.FileAnalysisException
FileAnalysisException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.FileAnalysisException
FileAnalysisListener - Interface in net.sourceforge.pmd.reporting: A handler for events occuring during analysis of a single file.
FileCollectionUtil - Class in net.sourceforge.pmd.internal.util
FileCollector - Class in net.sourceforge.pmd.lang.document: Collects files to analyse before a PMD run.
FileDataSource - Class in net.sourceforge.pmd.util.datasource: Deprecated.
FileDataSource(File) - Constructor for class net.sourceforge.pmd.util.datasource.FileDataSource: Deprecated.
FileFinder - Class in net.sourceforge.pmd.internal.util: A utility class for finding files within a directory.
FileFinder() - Constructor for class net.sourceforge.pmd.internal.util.FileFinder
FileId - Interface in net.sourceforge.pmd.lang.document: An identifier for a TextFile.
FileLocation - Class in net.sourceforge.pmd.lang.document: Represents the coordinates of a text region, used for reporting.
fileNameRenderer() - Method in class net.sourceforge.pmd.PmdAnalysis
FileNameRenderer - Interface in net.sourceforge.pmd.reporting: Strategy to render a FileId into a display name.
fileResultsCache - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
files() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
files() - Method in class net.sourceforge.pmd.PmdAnalysis: Returns the file collector for the analysed sources.
FileUtil - Class in net.sourceforge.pmd.internal.util: This is a utility class for working with Files.
filter(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream consisting of the nodes of this stream that match the given predicate.
filter(Predicate<Language>) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Create a new registry with the languages that satisfy the predicate.
filter(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
filterAbovePriority(RulePriority) - Method in class net.sourceforge.pmd.RuleSetLoader: Filter loaded rules to only those that match or are above the given priority.
filterIs(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Filters the nodes of this stream that are a subtype of the given class.
filterLanguages(Set<Language>) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Exclude all collected files whose language is not part of the given collection.
filterMatches(Predicate<Match>) - Method in class net.sourceforge.pmd.cpd.CPDReport: Creates a new CPD report taking all the information from this report, but filtering the matches.
filterMatching(Function<? super T, ? extends U>, U) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Filters the nodes of this stream by comparing a value extracted from the nodes with the given constant.
filterNot(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Filters the node of this stream using the negation of the given predicate.
filterNotMatching(Function<? super T, ? extends U>, U) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Inverse of NodeStream.filterMatching(Function, Object).
filterNotNull(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
filterTokenStream(TokenManager<T>) - Method in class net.sourceforge.pmd.cpd.impl.TokenizerBase
filterViolations(Predicate<RuleViolation>) - Method in class net.sourceforge.pmd.Report: Creates a new report taking all the information from this report, but filtering the violations.
findByExtension(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry: Deprecated.
Not replaced, extension will be extended to match full name in PMD 7.
findById(String) - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers: Returns the renderer descriptor registered by the given ID.
findChildNodesWithXPath(String) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
This is very inefficient and should not be used in new code. PMD 7.0.0 will remove support for this method.
findChildrenOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.children(childType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
findDescendantsOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.descendants(targetType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
findDescendantsOfType(Class<? extends T>, boolean) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.descendants(targetType).crossFindBoundaries(b).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
findFilesFrom(File, FilenameFilter, boolean) - Method in class net.sourceforge.pmd.internal.util.FileFinder: Searches for files in a given directory.
findLanguageByTerseName(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry: Deprecated.
Use LanguageRegistry.PMD.getLanguageById.
findPatternInFile(File, String) - Static method in class net.sourceforge.pmd.internal.util.FileUtil: Handy method to find a certain pattern into a file.
FINGERPRINTER - Static variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
finish(Collector<? super V, A, ? extends C>, A) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Finish the accumulated value of the collector.
finishThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker: Finishes tracking a thread.
first() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the first element of this stream, or null if the stream is empty.
first(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the first element of this stream of the given type, or null if there is none.
first(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the first element of this stream that matches the given predicate, or null if there is none.
firstChild(Class<? extends R>) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
firstChild(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the first child of this node that has the given type.
firstChild(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a stream containing the first child of each of the nodes in this stream that has the given type.
firstNonNull(Function<? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the first element of this stream for which the mapping function returns a non-null result.
firstOpt() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns an optional containing the first element of this stream, or an empty optional if the stream is empty.
firstOrThrow() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the first element of this stream, or throws a NoSuchElementException if the stream is empty.
fitTokensToChildren(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode: Ensures that the first (resp.
flatMap(Function<? super T, ? extends NodeStream<? extends R>>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream consisting of the results of replacing each node of this stream with the contents of a stream produced by the given mapping function.
flatMap(Iterator<? extends T>, Function<? super T, ? extends Iterator<? extends R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
flatMapWithSelf(Iterator<? extends R>, Function<? super R, ? extends Iterator<? extends R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Like flatMap, but yields each element of the input iterator before yielding the results of the mapper function.
flush() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
flush() - Method in interface net.sourceforge.pmd.renderers.Renderer
followingSiblings() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the following siblings of the nodes contained in this stream.
forCharSeq(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns a read-only TextFile reading from a string.
forEach(Consumer<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
forkJoin(NodeStream<? extends T>, Function<? super T, ? extends NodeStream<? extends R>>, Function<? super T, ? extends NodeStream<? extends R>>, Function<? super T, ? extends NodeStream<? extends R>>...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Applies the given mapping functions to the given upstream in order and merges the results into a new node stream.
formatPossibleNames(Set<SchemaConstant>) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
forPath(Path, Charset, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns an instance of this interface reading and writing to a file.
forReader(Reader, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile: Returns a read-only instance of this interface reading from a reader.
forRootOnly() - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector: Target only the root of the tree.
forSingleRule(Rule) - Static method in class net.sourceforge.pmd.RuleSet: Creates a new ruleset containing a single rule.
forString(String, String) - Static method in interface net.sourceforge.pmd.util.datasource.DataSource: Deprecated.
forTypes(Class<? extends Node>, Class<? extends Node>...) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector: Target nodes that are subtypes of any of the given classes.
forTypes(Collection<Class<? extends Node>>) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector: Target nodes that are subtypes of any of the given classes.
forXPathNames(Collection<String>) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector: Target nodes having one of the given XPath local name.
FragmentedDocBuilder - Class in net.sourceforge.pmd.lang.document
FragmentedDocBuilder(TextDocument) - Constructor for class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
fromAbsolutePath(String, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a file ID which interprets the first parameter as an absolute path.
fromBothOffsets(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion: Builds a new region from start and end offset.
fromCharSeq(CharSequence) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent: Normalize the line endings of the text to "\n", returns a TextFileContent containing the original line ending.
fromInputStream(InputStream, Charset) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent: Reads the contents of the input stream into a TextFileContent.
fromIterable(Iterable<? extends T>) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a new node stream that contains the same elements as the given iterable.
fromOffsetLength(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion: Builds a new region from offset and length.
fromPath(Path) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a file ID for the given path.
fromPath(Path, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a new path id for the given path.
fromPathLikeString(String) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a path ID for the given string.
fromPmdConfig(PMDConfiguration) - Static method in class net.sourceforge.pmd.RuleSetLoader: Configure a new ruleset factory builder according to the parameters of the given PMD configuration.
fromPredicate(Predicate<? super U>, String) - Static method in interface net.sourceforge.pmd.properties.PropertyConstraint: Builds a new validator from a predicate, and description.
fromPredicate(Predicate<? super U>, String, Map<String, String>) - Static method in interface net.sourceforge.pmd.properties.PropertyConstraint: Builds a new constraint from a predicate, a description and xml attributes to serialize the constraint.
fromReader(Reader) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
fromReader(Reader) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent: Read the reader fully and produce a TextFileContent.
fromString(String) - Method in class net.sourceforge.pmd.properties.PropertySerializer: Read the value from a string, if it is supported.
fromURI(String) - Static method in interface net.sourceforge.pmd.lang.document.FileId: Return a file ID for a URI.
fromWriter(Writer, String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
fullDescription(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: A description of the report.
fullLine(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d

G

generate(T, Function<? super T, ? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Returns an iterator that applies a stepping function to the previous value yielded.
GenericNode<N extends GenericNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl: Interface that binds the return type of some node methods to a type parameter.
GenericToken<T extends GenericToken<T>> - Interface in net.sourceforge.pmd.lang.ast: Represents a token, part of a token chain in a source file.
get(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the element at index n in this stream.
get(DataMap.DataKey<? extends K, ? extends T>) - Method in class net.sourceforge.pmd.util.DataMap: Retrieves the data currently mapped to the key.
GET_SOURCE_CODE_STATEMENT - net.sourceforge.pmd.util.database.DBType.Property
getAbsolutePath() - Method in interface net.sourceforge.pmd.lang.document.FileId: Return an absolute path to this file in its containing file system.
getAdditionalInfo() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation: Deprecated.
getAdditionalInfo() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
getAdditionalInfo() - Method in interface net.sourceforge.pmd.RuleViolation: A map of additional key-value pairs known about this violation.
getAdditionalInfo(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
getAdditionalInfo(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings: Returns a collection of "additional information" entries pertaining to the given node.
getAllRules() - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Return all rules from all rulesets.
getAllRuleSets() - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Get all the RuleSets.
getAnalysisCache() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getAnalysisCache() - Method in class net.sourceforge.pmd.PMDConfiguration: Retrieves the currently used analysis cache.
getAnalysisClassLoader() - Method in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle: Returns the classloader to use to resolve classes for this language.
getArtifactLocation() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation: The location of the artifact.
getAsBooleanAttr(Element, boolean) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getAssociatedRule() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification: An associated rule
getAstInfo() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the AstInfo for this root node.
getAstInfo() - Method in interface net.sourceforge.pmd.lang.ast.RootNode
getAstInfo() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
getAttributeNode(Element) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getAttributeOpt(Element) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getAttributeOrNull(Element) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getAttributeOrThrow(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getBeginColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry: The column number where this token starts, inclusive.
getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
getBeginColumn() - Method in interface net.sourceforge.pmd.reporting.Reportable: Deprecated.
Use Reportable.getReportLocation()
getBeginColumn() - Method in interface net.sourceforge.pmd.RuleViolation: Get the column number of the begin line in the source file in which this violation was identified.
getBeginLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry: The line number where this token starts.
getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
getBeginLine() - Method in interface net.sourceforge.pmd.reporting.Reportable: Deprecated.
Use Reportable.getReportLocation()
getBeginLine() - Method in interface net.sourceforge.pmd.RuleViolation: Get the begin line number in the source file in which this violation was identified.
getBeginTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
getBomCharsetName() - Method in class net.sourceforge.pmd.internal.util.IOUtil.BomAwareInputStream
getBuilderUtils() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId: Returns the object used to create new properties with the type of this constant.
getBytes(Charset) - Method in class net.sourceforge.pmd.lang.document.Chars: Returns the characters of this charsequence encoded with the given charset.
getCachedViolations(TextDocument) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
getCachedViolations(TextDocument) - Method in interface net.sourceforge.pmd.cache.AnalysisCache: Deprecated.

Retrieves cached violations for the given file.
getCachedViolations(TextDocument) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBType
getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBURI
getChars(int, char[], int, int) - Method in class net.sourceforge.pmd.lang.document.Chars: Copies 'count' characters from index 'srcBegin' into the given array, starting at 'dstBegin'.
getChecksum() - Method in interface net.sourceforge.pmd.cache.ChecksumAware: Deprecated.

Retrieves the current instance checksum
getChecksum() - Method in class net.sourceforge.pmd.RuleSet
getChecksum() - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Retrieves a checksum of the rulesets being used.
getCheckSum() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a checksum for the contents of the file.
getCheckSum() - Method in class net.sourceforge.pmd.lang.document.TextFileContent: Returns a checksum for the contents of the file.
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
getChild(int) - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getChild(int) - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the child of this node at the given index.
getChildrenExpectSingleName(Element, String, PmdXmlReporter) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getChildrenIn(Element) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getClassLoader() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the ClassLoader being used by PMD when processing Rules.
getClassName() - Method in interface net.sourceforge.pmd.RuleViolation: Deprecated.
Use RuleViolation.CLASS_NAME
getCollectedFiles() - Method in class net.sourceforge.pmd.lang.document.FileCollector: Returns an unmodifiable list of all files that have been collected.
getColumn() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
getColumn() - Method in class net.sourceforge.pmd.lang.document.TextPos2d: Returns the (1-based) column number.
getConfigurationErrors() - Method in class net.sourceforge.pmd.Report: Returns an unmodifiable list of configuration errors that have been recorded until now.
getConnection() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata: Return JDBC Connection for direct JDBC access to the specified database.
getConstantImageOfToken(Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary: Returns the constant image of the given token (a shared string), or null if the token has none.
getConstraint() - Method in exception net.sourceforge.pmd.properties.ConstraintViolatedException
getConstraintDescription() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint: Returns a description of the constraint imposed by this validator on the values.
getConstraints() - Method in class net.sourceforge.pmd.properties.PropertySerializer: Returns the constraints that this mapper applies to values after parsing them.
getContextEntries() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getContextLabels() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getContextValues(String) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getCPDReportRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
getCurrentValue() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
getDataSourceName() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource: Deprecated.
getDbType() - Method in class net.sourceforge.pmd.util.database.DBURI
getDecl() - Method in class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
getDeclarations() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
getDeclarations() - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Gets all the declaration with the occurrences in this scope.
getDeclarations(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
getDeclarations(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Helper method to get only a specific type of name declarations.
getDefaultLanguageVersion(Language) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Get the current default LanguageVersion for the given Language.
getDefaultLanguageVersionForFile(File) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Get the default LanguageVersion for the first Language of a given source file.
getDefaultLanguageVersionForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Get the LanguageVersion for the first Language of a source file with the given name.
getDefaultVersion() - Method in interface net.sourceforge.pmd.lang.Language: Returns the default language version for this language.
getDefaultVersion() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getDependencies() - Method in interface net.sourceforge.pmd.lang.Language: Returns a set of the IDs of languages that this language instance depends on.
getDependencies() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getDependenciesOf(Language) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Creates a language registry containing the given language and its dependencies, fetched from this language registry or the parameter.
getDescription() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation: Deprecated.
getDescription() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getDescription() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getDescription() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
getDescription() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
getDescription() - Method in interface net.sourceforge.pmd.renderers.Renderer: Get the description of the Renderer.
getDescription() - Method in interface net.sourceforge.pmd.Rule: Get the description of this Rule.
getDescription() - Method in class net.sourceforge.pmd.RuleSet
getDescription() - Method in interface net.sourceforge.pmd.RuleViolation: Get the description of this violation.
getDescription() - Method in enum net.sourceforge.pmd.util.database.DBType.Property
getDesignerBindings() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Returns the designer bindings for this language version.
getDetail() - Method in class net.sourceforge.pmd.Report.ProcessingError
getDisplayName(FileId) - Method in class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer
getDisplayName(FileId) - Method in interface net.sourceforge.pmd.reporting.FileNameRenderer: Return a display name for the given file id.
getDisplayName(TextFile) - Method in interface net.sourceforge.pmd.reporting.FileNameRenderer
getDisplayName(FileId) - Method in class net.sourceforge.pmd.cpd.CPDReport: Return the display name of the given file.
getDisplayString() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo: Returns the string displayed to the user.
getDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Returns the document owning this token.
getDriver() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool: The analysis tool that was run.
getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBType
getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBURI
getElementChildren(Element) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getElementChildrenList(Element) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getElementChildrenNamed(Element, String) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getElementChildrenNamed(Element, Set<SchemaConstant>) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getElementChildrenNamedReportOthers(Element, Set<SchemaConstant>, PmdXmlReporter) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getElementChildrenNamedReportOthers(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getEnclosingScope(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
getEnclosingScope(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Helper method that goes up the parent scopes to find a scope of the specified type
getEncoding() - Method in class net.sourceforge.pmd.cpd.XMLRenderer
getEndColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry: The column number where this token ends, exclusive.
getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the column number of the last character for the current token.
getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
getEndColumn() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Exclusive, 1-based column number.
getEndColumn() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getEndColumn() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The column number of the character following the end of the region.
getEndColumn() - Method in interface net.sourceforge.pmd.reporting.Reportable: Deprecated.
Use Reportable.getReportLocation()
getEndColumn() - Method in interface net.sourceforge.pmd.RuleViolation: Get the column number of the end line in the source file in which this violation was identified.
getEndIndex() - Method in class net.sourceforge.pmd.cpd.Match
getEndLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry: The line number where this token ends.
getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the line number of the last character for current token.
getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
getEndLine() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Inclusive, 1-based line number.
getEndLine() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getEndLine() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The line number of the last character in the region.
getEndLine() - Method in interface net.sourceforge.pmd.reporting.Reportable: Deprecated.
Use Reportable.getReportLocation()
getEndLine() - Method in interface net.sourceforge.pmd.RuleViolation: Get the end line number in the source file in which this violation was identified.
getEndOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the end offset of the current token (in the translated source), exclusive.
getEndOffset() - Method in class net.sourceforge.pmd.lang.document.TextRegion: 0-based, exclusive index.
getEndPos() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Returns the end position.
getEndPos() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getEndTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
getEntireRegion() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a text region that corresponds to the entire document, in the coordinate system of this document.
getError() - Method in class net.sourceforge.pmd.Report.ProcessingError
getExamples() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getExamples() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getExamples() - Method in interface net.sourceforge.pmd.Rule: Get the list of examples for this Rule.
getException() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification: A exception component to detail the tool exception
getExceptionContext() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getExceptionContext() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
getExceptionContext() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
getExcludes() - Method in class net.sourceforge.pmd.AbstractConfiguration
getExcludes() - Method in class net.sourceforge.pmd.RuleSetReference: Deprecated.
getExecutionSuccessful() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
getExtensions() - Method in interface net.sourceforge.pmd.lang.Language: Returns the list of file extensions associated with this language.
getExtensions() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getExternalInfoUrl() - Method in interface net.sourceforge.pmd.Rule: Get a URL for external information about this Rule.
getExtraViolationSuppressors() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Returns additional language-specific violation suppressors.
getFile() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getFileChecksum() - Method in class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
getFileExclusions() - Method in class net.sourceforge.pmd.RuleSet: Returns the file exclusion patterns as an unmodifiable list.
getFileExtensionFilter(String...) - Static method in class net.sourceforge.pmd.internal.util.PredicateUtil: Returns a case-insensitive predicate for files with the given extensions.
getFileId() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException: The name of the file in which the error occurred.
getFileId() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
getFileId() - Method in class net.sourceforge.pmd.lang.document.FileLocation: File name of this position.
getFileId() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns TextFile.getFileId() for the text file backing this document.
getFileId() - Method in interface net.sourceforge.pmd.lang.document.TextFile: Returns an identifier for this file.
getFileId() - Method in class net.sourceforge.pmd.Report.ProcessingError
getFileId() - Method in interface net.sourceforge.pmd.RuleViolation: Return the ID of the file where the violation was found.
getFileInclusions() - Method in class net.sourceforge.pmd.RuleSet: Returns the file inclusion patterns as an unmodifiable list.
getFileName() - Method in interface net.sourceforge.pmd.lang.document.FileId: Return the simple file name, like Path.getFileName().
getFileName() - Method in class net.sourceforge.pmd.RuleSet
getFilenameBase(String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
getFilenameExtension(String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
getFileNameWithoutExtension(String) - Static method in class net.sourceforge.pmd.internal.util.FileUtil: Helper method to get a filename without its extension
getFiles() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
getFirstChild() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getFirstChild() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the first child of this node, or null if it doesn't exist.
getFirstChildOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use Node.firstChild(Class)
getFirstContextValue(String) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getFirstDescendantOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.descendants(targetType).first().
getFirstError() - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter: If SemanticErrorReporter.error(Node, String, Object...) has been called, return a semantic exception instance with the correct message.
getFirstMark() - Method in class net.sourceforge.pmd.cpd.Match
getFirstParentOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.ancestors(parentType).first()
getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
getFirstToken() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument: Returns the first token of the token chain.
getForcedVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
getForceLanguageVersion() - Method in class net.sourceforge.pmd.AbstractConfiguration: Get the LanguageVersion specified by the force-language parameter.
getFormat() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getFormattedExceptionMessage(String) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getFullDescription() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A description of the report.
getFullText() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument: Returns the original text of the file (without escaping).
getFunctionQName() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AbstractXPathFunctionDef
getHandlerForFunctionDefs(ExtensionFunctionDefinition, ExtensionFunctionDefinition...) - Static method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler: Returns a default XPath handler.
getHelp() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: Provides the primary documentation for the report, useful when there is no online documentation.
getHelpUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A URI where the primary documentation for the report can be found.
getHighlightedNodesWhenSelecting(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.RelatedNodesSelector: Returns a list of nodes that should be highlighted when selecting the given node.
getIcon(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
getIcon(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings: Returns a constant describing an icon that the node should bear in the treeview and other relevant places.
getId() - Method in interface net.sourceforge.pmd.lang.Language: Returns the ID of this language.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule: The stable, unique identifier of the rule, if any, to which this result is relevant.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location: Value that distinguishes this location from all other locations within a single result object.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message: The identifier for this message.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A stable, opaque identifier for the report.
getId() - Method in interface net.sourceforge.pmd.ViolationSuppressor: A name, for reporting and documentation purposes.
getIgnoreFile() - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns the path to the file list exclude file.
getImage() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns the token's text as a string.
getImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
getImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getImage() - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Should be replaced with methods that have more specific names in node classes.
getImage() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
getImage() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
getImage() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration: Gets the image of the node.
getImage() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence: Gets the image of the used declaration, such as the variable name.
getImage(Tokens) - Method in class net.sourceforge.pmd.cpd.TokenEntry
getImage(T) - Method in class net.sourceforge.pmd.cpd.impl.TokenizerBase
getImageCs() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns the text of the token as a char sequence.
getImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
getImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getIndex() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation: The index within the run artifacts array of the artifact object associated with the artifact location.
getIndexInParent() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
getIndexInParent() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getIndexInParent() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the index of this node in its parent's children.
getInformationUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component: The absolute URI at which information about this version of the tool component can be found.
getInputFile() - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns the path to the file list include file.
getInputPathList() - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns the list of input paths to explore.
getInputStream() - Method in interface net.sourceforge.pmd.util.datasource.DataSource: Deprecated.

Get an InputStream on the source file.
getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource: Deprecated.

Convert the Reader into an InputStream.
getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource: Deprecated.
getInputStream(ResourceLoader) - Method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Try to load the RuleSet resource with the specified ResourceLoader.
getInstance() - Static method in class net.sourceforge.pmd.lang.PlainTextLanguage: Returns the singleton instance of this language.
getInstance() - Static method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings: Returns the default instance.
getInvocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run: The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
getIterationCount() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
getKeyOfValue(Map<K, V>, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns the key that corresponds to the given value in the map, or null if it is not contained in the map.
getKind() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Gets a unique integer representing the kind of token this is.
getKind() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
getKind() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getLabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
getLanguage() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
getLanguage() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor: The language of this processor.
getLanguage() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
getLanguage() - Method in class net.sourceforge.pmd.lang.LanguageVersion: Returns the language that owns this version.
getLanguage() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getLanguage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getLanguage() - Method in interface net.sourceforge.pmd.Rule: Get the Language of this Rule.
getLanguage() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getLanguage(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry: Deprecated.
Use LanguageRegistry.PMD.getLanguageByFullName
getLanguageByFullName(String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Returns a language from its full name (eg "Java").
getLanguageById(String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Returns a language from its ID (eg "java").
getLanguageMetricsProvider() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Returns the metrics provider for this language version, or null if it has none.
getLanguageProcessor() - Method in class net.sourceforge.pmd.lang.ast.AstInfo: Returns the language processor that parsed the tree.
getLanguageProcessor() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
getLanguageProperties() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getLanguageProperties(Language) - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns a mutable bundle of language properties that are associated to the given language (always the same for a given language).
getLanguageProperties(Language) - Method in class net.sourceforge.pmd.PmdAnalysis: Returns a mutable bundle of language properties that are associated to the given language (always the same for a given language).
getLanguageRegistry() - Method in class net.sourceforge.pmd.AbstractConfiguration
getLanguages() - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry: Return the languages that are registered in this instance.
getLanguages() - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Returns a set of all the known languages.
getLanguages() - Method in class net.sourceforge.pmd.util.database.DBType
getLanguagesForFile(File) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Deprecated.
PMD 7 avoids using File.
getLanguagesForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Get the Languages of a given source file.
getLanguagesList() - Method in class net.sourceforge.pmd.util.database.DBURI
getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the language version of this node.
getLanguageVersion() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns the language version that should be used to parse this file.
getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.document.TextFile: Returns the language version which should be used to process this file.
getLanguageVersion() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor: The language version that was configured when creating this processor.
getLanguageVersion() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
getLanguageVersionById(String, String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry: Returns a language version from its language ID (eg "java").
getLanguageVersionDiscoverer() - Method in class net.sourceforge.pmd.AbstractConfiguration: Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.
getLanguageVersionOfFile(String) - Method in class net.sourceforge.pmd.AbstractConfiguration: Get the LanguageVersion of the source file with given name.
getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
getLastChild() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getLastChild() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the first last of this node, or null if it doesn't exist.
getLastToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
getLastToken() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
getLatestVersion() - Method in interface net.sourceforge.pmd.lang.Language: Returns the latest language version.
getLength() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns the length in characters of the text.
getLength() - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns the length of the region in characters.
getLexer(CharStream) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
getLexerForSource(CharStream) - Method in class net.sourceforge.pmd.cpd.impl.AntlrTokenizer
getLine() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
getLine() - Method in class net.sourceforge.pmd.lang.document.TextPos2d: Returns the (1-based) line number.
getLineCount() - Method in class net.sourceforge.pmd.cpd.Match
getLineCount() - Method in class net.sourceforge.pmd.lang.document.FileLocation
getLineTerminator() - Method in class net.sourceforge.pmd.lang.document.TextFileContent: Returns the original line terminator found in the file.
getListener() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getLocation() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation: Deprecated.
getLocation() - Method in class net.sourceforge.pmd.cpd.Mark: Return the location of this source range in the source file.
getLocation() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
getLocation() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence: Gets the location where the usage occurred.
getLocation() - Method in interface net.sourceforge.pmd.RuleViolation: Returns the location where the violation should be reported.
getLocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result: The set of locations where the result was detected.
getLocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification: A list of related locations to the error
getLpRegistry() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
getLpRegistry() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getMainAttribute(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
getMainAttribute(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings: Returns the "main" attribute of the given node.
getMarkCount() - Method in class net.sourceforge.pmd.cpd.Match
getMarkdown() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message: A Markdown message string.
getMarkdown() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage: A Markdown message string or format string.
getMarkSet() - Method in class net.sourceforge.pmd.cpd.Match
getMatches() - Method in class net.sourceforge.pmd.cpd.CPDReport: Return the list of duplication matches found by the CPD analysis.
getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getMaximumLanguageVersion() - Method in interface net.sourceforge.pmd.Rule: Get the maximum LanguageVersion to which this Rule applies.
getMaxRuleIndex() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
getMaxTokenType() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
getMessage() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
getMessage() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getMessage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception: A plain text message string or format string.
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result: A message that describes the result.
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification: A message component to detail the configuration error
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification: A message component to detail the runtime error
getMessage() - Method in interface net.sourceforge.pmd.Rule: Get the message to show when this Rule identifies a violation.
getMessage() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
getMessage() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
getMessageReporter() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getMessageReporter() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getMessageStrings() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A set of name/value pairs with arbitrary names.
getMessageWithoutValue() - Method in exception net.sourceforge.pmd.properties.ConstraintViolatedException
getMethodName() - Method in interface net.sourceforge.pmd.RuleViolation: Deprecated.
Use RuleViolation.METHOD_NAME
getMetrics() - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider: Returns the set of all metrics supported by the language.
getMetricWithName(String) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider: Fetch a metric using its name.
getMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getMinimumLanguageVersion() - Method in interface net.sourceforge.pmd.Rule: Get the minimum LanguageVersion to which this Rule applies.
getMinimumPriority() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the minimum priority threshold when loading Rules from RuleSets.
getMinimumTileSize() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
getMsg() - Method in class net.sourceforge.pmd.Report.ProcessingError
getName() - Method in interface net.sourceforge.pmd.lang.Language: Returns the full name of this Language.
getName() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getName() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
getName() - Method in class net.sourceforge.pmd.lang.LanguageVersion: Returns the name of this language version.
getName() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getName() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
getName() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
getName() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration: Gets the name of the declaration, such as the variable name.
getName() - Method in class net.sourceforge.pmd.properties.PropertyBuilder: Returns the name of the property to be built.
getName() - Method in interface net.sourceforge.pmd.properties.PropertySource: Gets the name of this property source.
getName() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
getName() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component: The name of the tool component.
getName() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A report identifier that is understandable to an end user.
getName() - Method in interface net.sourceforge.pmd.renderers.Renderer: Get the name of the Renderer.
getName() - Method in interface net.sourceforge.pmd.Rule: Get the name of this Rule.
getName() - Method in enum net.sourceforge.pmd.RulePriority: Get the descriptive name of this priority.
getName() - Method in class net.sourceforge.pmd.RuleSet
getName() - Method in class net.sourceforge.pmd.util.database.SourceObject
getNext() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Obtain the next generic token according to the input stream which generated the instance of this token.
getNext() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
getNext() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getNextMajorRelease() - Static method in class net.sourceforge.pmd.PMDVersion: Retrieves the next major release to be expected.
getNextSibling() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getNextSibling() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the next sibling of this node, or null if it does not exist.
getNextToken() - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
getNextToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
getNextToken() - Method in interface net.sourceforge.pmd.lang.TokenManager
getNiceFileName(boolean, String) - Method in interface net.sourceforge.pmd.util.datasource.DataSource: Deprecated.

Return a nice version of the filename.
getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource: Deprecated.

Return the dataSourceName via the DataSource Interface method.
getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource: Deprecated.
getNode() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
getNode() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration: Gets the node which manifests the declaration.
getNonBlankAttribute(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getNonBlankAttributeOrThrow(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getNormalizedText() - Method in class net.sourceforge.pmd.lang.document.TextFileContent: The text of the file, with the following normalizations: Line endings are normalized to "\n".
getNth(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Returns the nth element of this iterator, or null if the iterator is shorter.
getNthParent(int) - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getNthParent(int) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.ancestors().get(n-1)
getNumberOfTokensPerFile() - Method in class net.sourceforge.pmd.cpd.CPDReport: Return a map containing the number of tokens by processed file.
getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
getNumChildren() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the number of children of this node.
getNumErrors() - Method in class net.sourceforge.pmd.reporting.ReportStats
getNumViolations() - Method in class net.sourceforge.pmd.reporting.ReportStats
getOptChildIn(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getOptions() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions: Returns an immutable set of options.
getOrDefault(DataMap.DataKey<? extends K, ? extends T>, T) - Method in class net.sourceforge.pmd.util.DataMap
getOriginalName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOriginalPath() - Method in interface net.sourceforge.pmd.lang.document.FileId: Return the path as it was input by the user.
getOriginalText() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode: Returns the original source code underlying this node, before any escapes have been translated.
getOverriddenDescription() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenExamples() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenMessage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenPriority() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getOverriddenPropertiesByPropertyDescriptor() - Method in interface net.sourceforge.pmd.properties.PropertySource: Returns a modifiable map of the property descriptors that don't use default values, to their overridden value.
getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getOverriddenPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource: Returns a modifiable list of the property descriptors that don't use default values.
getPackageName() - Method in interface net.sourceforge.pmd.RuleViolation: Deprecated.
Use RuleViolation.PACKAGE_NAME
getParameters() - Method in class net.sourceforge.pmd.util.database.DBURI
getParent() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
getParent() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
getParent() - Method in interface net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode.AntlrToPmdParseTreeAdapter
getParent() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getParent() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrTerminalPmdAdapter
getParent() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getParent() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the parent of this node, or null if this is the root of the tree.
getParent() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
getParent() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
getParent() - Method in interface net.sourceforge.pmd.lang.symboltable.Scope: Retrieves this scope's parent
getParentFsPath() - Method in interface net.sourceforge.pmd.lang.document.FileId: If this file is in a nested filesystem (eg a zip file), return the file ID of the container in the outer file system.
getParentsOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.ancestors(parentType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
getParser() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Returns the parser instance.
getPhase() - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
getPhaseText(int) - Method in class net.sourceforge.pmd.cpd.GUI
getPhysicalLocation() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location: Identifies the artifact and region.
getPmdNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
getPmdNode() - Method in interface net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode.AntlrToPmdParseTreeAdapter
getPmdNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrTerminalPmdAdapter
getPreviousComment() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Obtain a comment-type token which, according to the input stream which generated the instance of this token, precedes this instance token and succeeds the previous generic token (if there is any).
getPreviousComment() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
getPreviousComment() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getPreviousSibling() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
getPreviousSibling() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the previous sibling of this node, or null if it does not exist.
getPriority() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getPriority() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getPriority() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag: The pmd priority of the rule.
getPriority() - Method in interface net.sourceforge.pmd.Rule: Get the priority of this Rule.
getPriority() - Method in enum net.sourceforge.pmd.RulePriority: Get the priority value as a number.
getProcessingErrors() - Method in class net.sourceforge.pmd.Report: Returns an unmodifiable list of processing errors that have been recorded until now.
getProcessor(Language) - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry: Return the processor for a given language.
getProperties() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
getProperties() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: Key/value pairs that provide additional information about the report.
getProperties() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result: Key/value pairs that provide additional information about the address.
getProperties() - Method in class net.sourceforge.pmd.util.database.DBType
getProperties() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
getPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getPropertiesByPropertyDescriptor() - Method in interface net.sourceforge.pmd.properties.PropertySource: Returns an unmodifiable map of descriptors to property values for the current receiver.
getPropertiesSource() - Method in class net.sourceforge.pmd.util.database.DBType
getProperty(PropertyDescriptor<T>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getProperty(PropertyDescriptor<T>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getProperty(PropertyDescriptor<T>) - Method in interface net.sourceforge.pmd.properties.PropertySource: Get the typed value for the given property.
getPropertyDescriptor(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getPropertyDescriptor(String) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getPropertyDescriptor(String) - Method in interface net.sourceforge.pmd.properties.PropertySource: Get the PropertyDescriptor for the given property name.
getPropertyDescriptors() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource: Get the descriptors of all defined properties.
getPropertyName() - Method in enum net.sourceforge.pmd.util.database.DBType.Property
getPropertySourceType() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
getPropertySourceType() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getPropertySourceType() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
getPropertySourceType() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
getPseudoFileName() - Method in class net.sourceforge.pmd.util.database.SourceObject: Gets the data source as a pseudo file name (faux-file).
getReader(String) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
getRegion() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns a text region with the coordinates of this token.
getRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken: Returns a text region with the coordinates of this token.
getRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getRegion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation: Specifies a portion of the artifact.
getRegionInFile() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Returns the region in the file, or null if this was not available.
getRegisteredExtensionFunctions() - Method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler: Returns the set of extension functions for this language module.
getRelatedNodesSelector() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
getRelatedNodesSelector() - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings: Returns an instance of RelatedNodesSelector, or null if it should be defaulted to using the old symbol table (ScopedNode).
getRelativizeRoots() - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns the paths used to shorten paths output in the report.
getRendererName() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
getRenderers() - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
getReporter() - Method in class net.sourceforge.pmd.AbstractConfiguration: Returns the message reporter that is to be used while running the analysis.
getReporter() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask: The error reporter for semantic checks.
getReporter() - Method in class net.sourceforge.pmd.lang.document.FileCollector: Returns the reporter for the file collection phase.
getReporter() - Method in class net.sourceforge.pmd.PmdAnalysis
getReportFile() - Method in class net.sourceforge.pmd.PMDConfiguration: Deprecated.
Use PMDConfiguration.getReportFilePath()
getReportFile() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration: Deprecated.
Use TreeExportConfiguration.getReportFilePath()
getReportFilePath() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the file to which the report should render.
getReportFilePath() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration: Get the file to which the report should render.
getReportFormat() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the report format.
getReportLocation() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
getReportLocation() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
getReportLocation() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the location at which this element should be reported.
getReportLocation() - Method in interface net.sourceforge.pmd.reporting.Reportable: Returns the location at which this element should be reported.
getReportProperties() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the Report properties.
getResource(String) - Method in class net.sourceforge.pmd.internal.util.ClasspathClassLoader
getResourceBundleAsProperties(ResourceBundle) - Static method in class net.sourceforge.pmd.util.database.DBType: Convert resourceBundle to usable Properties.
getResourceStream(String) - Method in class net.sourceforge.pmd.util.database.ResourceLoader
getResult() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable: Returns the result.
getResultImpl() - Method in class net.sourceforge.pmd.Report.GlobalReportBuilderListener
getResultImpl() - Method in class net.sourceforge.pmd.Report.ReportBuilderListener
getResultImpl() - Method in class net.sourceforge.pmd.reporting.GlobalAnalysisListener.ViolationCounterListener
getResultImpl() - Method in class net.sourceforge.pmd.reporting.ReportStatsListener
getResultImpl() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable: Produce the final result.
getResults() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run: The set of results contained in an SARIF log.
getRevision() - Method in class net.sourceforge.pmd.util.database.SourceObject
getRoot() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the root of the tree this node is declared in.
getRootNode() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
getRule() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation: Deprecated.
getRule() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getRule() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
getRule() - Method in class net.sourceforge.pmd.RuleContext: Deprecated.
Used in AbstractRule.asCtx(Object), when that is gone, will be removed.
getRule() - Method in interface net.sourceforge.pmd.RuleViolation: Get the Rule which identified this violation.
getRuleByName(String) - Method in class net.sourceforge.pmd.RuleSet: Returns the first Rule found with the given name (case-sensitive).
getRuleByName(String) - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Returns the first Rule found with the given name.
getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getRuleClass() - Method in interface net.sourceforge.pmd.Rule: Get the implementation class of this Rule.
getRuleContext(Class<T>, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getRuleContexts(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getRuleForClass(String, String, String) - Method in class net.sourceforge.pmd.cache.CachedRuleMapper: Deprecated.

Finds a rule instance for the given rule class name, name and target language
getRuleId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result: The stable, unique identifier of the rule, if any, to which this result is relevant.
getRuleIndex() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getRuleIndex() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result: The index link the rule, if any, to which this result is relevant.
getRuleName() - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
getRuleName() - Method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Get the Rule name.
getRules() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
getRules() - Method in class net.sourceforge.pmd.RuleSet: Returns the actual Collection of rules in this ruleset
getRuleset() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag: The name of the rule set.
getRuleSetFileName() - Method in class net.sourceforge.pmd.RuleSetReference: Deprecated.
getRuleSetFileName() - Method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Get the RuleSet file name.
getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getRuleSetName() - Method in interface net.sourceforge.pmd.Rule: Get the name of the RuleSet containing this Rule.
getRuleSetPaths() - Method in class net.sourceforge.pmd.PMDConfiguration: Returns the list of ruleset URIs.
getRuleSetReference() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
getRulesets() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getRulesets() - Method in class net.sourceforge.pmd.PmdAnalysis: Returns an unmodifiable view of the ruleset list.
getRuleSets() - Method in class net.sourceforge.pmd.PMDConfiguration: Deprecated.
Use PMDConfiguration.getRuleSetPaths()
getRuleSetsIterator() - Method in class net.sourceforge.pmd.RuleSets: Deprecated.
getRuleViolation() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
getRuns() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog: The set of runs contained in this log file.
getSchema() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog: The URI of the JSON schema corresponding to the version.
getSchema() - Method in class net.sourceforge.pmd.util.database.SourceObject
getSchemasList() - Method in class net.sourceforge.pmd.util.database.DBURI
getScope() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
getScope() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration: Gets the scope in which this name has been declared.
getScope() - Method in interface net.sourceforge.pmd.lang.symboltable.ScopedNode
getSecondMark() - Method in class net.sourceforge.pmd.cpd.Match
getShortDescription() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A concise description of the report.
getShortName() - Method in interface net.sourceforge.pmd.lang.Language: Returns the short name of this language.
getShortName() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getShortName() - Method in class net.sourceforge.pmd.lang.LanguageVersion: Get the short name of this LanguageVersion.
getSince() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getSince() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getSince() - Method in interface net.sourceforge.pmd.Rule: Get the version of PMD in which this Rule was added.
getSingleChildIn(Element, boolean, PmdXmlReporter, Set<SchemaConstant>) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
getSingleChildIn(Element, PmdXmlReporter) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
getSkipBlocksPattern() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
getSortKey() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo: Returns the string used to sort the additional info.
getSourceCode(String, String, String) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata: return source code text
getSourceCode(SourceObject) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata: Return source code text from the database.
getSourceCodeNamesList() - Method in class net.sourceforge.pmd.util.database.DBURI
getSourceCodeReturnType() - Method in class net.sourceforge.pmd.util.database.DBType
getSourceCodeSlice(Mark) - Method in class net.sourceforge.pmd.cpd.CPDReport: Return the slice of source code where the mark was found.
getSourceCodeType() - Method in class net.sourceforge.pmd.util.database.DBURI
getSourceCodeTypes() - Method in class net.sourceforge.pmd.util.database.DBType
getSourceCodeTypesList() - Method in class net.sourceforge.pmd.util.database.DBURI
getSourceEncoding() - Method in class net.sourceforge.pmd.AbstractConfiguration: Get the character encoding of source files.
getSourceObjectList() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata: Return all source code objects associated with any associated DBURI.
getSourceObjectList(List<String>, List<String>, List<String>, List<String>) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata: Return all source code objects associated with the specified languages, schemas, source code types and source code names.
getSourceText() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask: The full text of the file to parse.
getStandardRuleSets() - Method in class net.sourceforge.pmd.RuleSetLoader: Returns an Iterator of RuleSet objects loaded from descriptions from the "categories.properties" resource for each language.
getStartColumn() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Inclusive, 1-based column number.
getStartColumn() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getStartColumn() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The column number of the first character in the region.
getStartLine() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Inclusive, 1-based line number.
getStartLine() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getStartLine() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The line number of the first character in the region.
getStartOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the start offset of the current token (in the translated source), inclusive.
getStartOffset() - Method in class net.sourceforge.pmd.lang.document.TextRegion: 0-based, inclusive index.
getStartPos() - Method in class net.sourceforge.pmd.lang.document.FileLocation: Returns the start position.
getStartPos() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
getStringId() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId: Gets the value of the type attribute represented by this constant.
getStringValue() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
getSubnamePrefix() - Method in class net.sourceforge.pmd.util.database.DBURI
getSubprotocol() - Method in class net.sourceforge.pmd.util.database.DBURI
getSuffixFromType() - Method in class net.sourceforge.pmd.util.database.SourceObject: Map the type to a file suffix associated with a Language
getSuppressedViolations() - Method in class net.sourceforge.pmd.Report: Returns an unmodifiable list of violations that were suppressed.
getSuppressionComments() - Method in class net.sourceforge.pmd.lang.ast.AstInfo: Returns the map of line numbers to suppression / review comments.
getSuppressMap() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
getSuppressMarker() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
getSuppressMarker() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the suppress marker.
getSuppressor() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
getTags() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag: A set of distinct strings that provide additional information.
getTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
getTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
getTargetSelector() - Method in interface net.sourceforge.pmd.Rule: Returns the object that selects the nodes to which this rule applies.
getTerseName() - Method in interface net.sourceforge.pmd.lang.Language: Deprecated.
Use Language.getId()
getTerseName() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getTerseName() - Method in class net.sourceforge.pmd.lang.LanguageVersion: Get the terse name of this LanguageVersion.
getText() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
getText() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode: Returns the text of the token.
getText() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode: Returns the source code underlying this node, after any escapes have been translated.
getText() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns the current text of this document.
getText() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message: A plain text message string.
getText() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage: A plain text message string or format string.
getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.AstInfo: Returns the text document that was parsed.
getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
getTextDocument() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns the text document from which this tree was parsed.
getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask: The text document to parse.
getTextRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getTextRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
getTextRegion() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a region of text delimiting the node in the underlying text document.
getTextRegion() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode: Returns the exact region of text delimiting the node in the underlying text document.
getTextRegion() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
getThreadCount() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
getThreads() - Method in class net.sourceforge.pmd.PMDConfiguration: Get the number of threads to use when processing Rules.
getThrowable() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
getThrowable() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
getThrowable() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
getToken(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getTokenCount() - Method in class net.sourceforge.pmd.cpd.Match
getTokenDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the token document for the tokens being built.
getTokenImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns a string made up of characters from the token mark up to to the current buffer position.
getTokenImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns a string made up of characters from the token mark up to to the current buffer position.
getTokenKind() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
getTokens() - Method in class net.sourceforge.pmd.cpd.Tokens
getTokens(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
getTool() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run: Information about the tool or tool pipeline that generated the results in this run.
getToolConfigurationNotifications() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
getToolExecutionNotifications() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
getType() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute: Gets the generic type of the value of this attribute.
getType() - Method in class net.sourceforge.pmd.util.database.SourceObject
getTypeId() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: Returns the type ID which was used to define this property.
getUnlabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
getUri() - Method in class net.sourceforge.pmd.AbstractConfiguration: Get the input URI to process for source code objects.
getUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation: A string containing a valid relative or absolute URI.
getUri() - Method in class net.sourceforge.pmd.util.database.DBURI
getUriBaseId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.
getUriString() - Method in interface net.sourceforge.pmd.lang.document.FileId: Return a string that looks like a URI pointing to this file.
getURL() - Method in class net.sourceforge.pmd.util.database.DBURI
getUserMap() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
getUserMap() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
getUserMap() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns a data map used to store additional information on this node.
getUserMessage() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
getValue() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
getVariableName() - Method in interface net.sourceforge.pmd.RuleViolation: Deprecated.
Use RuleViolation.VARIABLE_NAME
getVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersion: Returns the version string.
getVersion() - Method in class net.sourceforge.pmd.lang.rule.XPathRule: Returns the version for this rule.
getVersion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component: The tool component version, in whatever format the component natively provides.
getVersion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog: The SARIF format version of this log file.
getVersion(String) - Method in interface net.sourceforge.pmd.lang.Language: Returns the language version with the given version string.
getVersion(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getVersionNamesAndAliases() - Method in interface net.sourceforge.pmd.lang.Language: Returns a complete set of supported version names for this language including all aliases.
getVersionNamesAndAliases() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getVersions() - Method in interface net.sourceforge.pmd.lang.Language: Returns an ordered list of supported versions for this language.
getVersions() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
getViolationDecorator() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Returns the language-specific violation decorator.
getViolations() - Method in class net.sourceforge.pmd.cache.AnalysisResult: Deprecated.
getViolations() - Method in class net.sourceforge.pmd.Report: Returns an unmodifiable list of violations that have been recorded until now.
getVocabulary() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
getWallClockMillis() - Method in class net.sourceforge.pmd.benchmark.TimingReport
getWriter() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
getWriter() - Method in interface net.sourceforge.pmd.renderers.Renderer: Get the Writer for the Renderer.
getXmlConstraint() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint: Serializes this constraint as XML attributes, that are part of the property element of a rule definition.
getXmlMapper() - Method in interface net.sourceforge.pmd.properties.PropertyTypeId.BuilderAndMapper
getXmlName() - Method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion: Returns the string used to represent the version in the XML.
getXPathAttributesIterator() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns an iterator enumerating all the attributes that are available from XPath for this node.
getXPathExpression() - Method in class net.sourceforge.pmd.lang.rule.XPathRule: Returns the XPath expression that implements this rule.
getXPathHandler() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler: Get the XPathHandler.
getXPathNameOfRule(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary: Gets the xpath name of an inner node with a given RuleContext.getRuleIndex().
getXPathNameOfToken(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary: Gets the xpath name of a terminal node with a given Token.getType().
getXPathNodeName() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
getXPathNodeName() - Method in interface net.sourceforge.pmd.lang.ast.Node: Gets the name of the node that is used to match it with XPath queries.
getXPathNodeName() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
GlobalAnalysisListener - Interface in net.sourceforge.pmd.reporting: Listens to an analysis.
GlobalAnalysisListener.ViolationCounterListener - Class in net.sourceforge.pmd.reporting: A listener that just counts recorded violations.
GlobalReportBuilderListener() - Constructor for class net.sourceforge.pmd.Report.GlobalReportBuilderListener
gobbleMaxWithoutEscape(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
gobbleMaxWithoutEscape(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator: Returns the max offset, EXclusive, up to which we can cut the input array from the bufpos to dump it into the output array.
GraphUtil - Class in net.sourceforge.pmd.util
GraphUtil.DotColor - Enum in net.sourceforge.pmd.util
GREEN - net.sourceforge.pmd.util.GraphUtil.DotColor
GROUPING - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
growLeft(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns a region that ends at the same point, but starts 'delta' characters before this region.
growRight(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns a region that starts at the same point, but ends 'delta' characters after this region.
GUI - Class in net.sourceforge.pmd.cpd
GUI() - Constructor for class net.sourceforge.pmd.cpd.GUI

H

handleAttributeFetchException(Attribute, Exception) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig: Handle an exception that occurred while fetching the value of an attribute.
handleBackslash(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
handleBackslash(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaEscapeTranslator
hasAttribute(Element) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
hasBom() - Method in class net.sourceforge.pmd.internal.util.IOUtil.BomAwareInputStream
hasDescendantOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
Use node stream methods: node.descendants(targetType).nonEmpty().
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
hasDescriptor(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource: Returns whether the specified property is defined on this property source, in which case it can be set or retrieved with PropertySource.getProperty(PropertyDescriptor) and PropertySource.setProperty(PropertyDescriptor, Object).
hasExtension(String) - Method in interface net.sourceforge.pmd.lang.Language: Returns whether this language handles the given file extension.
hasFileName() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
HASH - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
hashCode() - Method in class net.sourceforge.pmd.cpd.Mark
hashCode() - Method in class net.sourceforge.pmd.cpd.TokenEntry
hashCode() - Method in class net.sourceforge.pmd.lang.document.Chars
hashCode() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
hashCode() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
hashCode() - Method in class net.sourceforge.pmd.lang.document.TextRegion
hashCode() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
hashCode() - Method in class net.sourceforge.pmd.lang.LanguageVersion
hashCode() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
hashCode() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
hashCode() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
hashCode() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
hashCode() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
hashCode() - Method in class net.sourceforge.pmd.RuleSet
hashCode() - Method in class net.sourceforge.pmd.util.database.DBType
hashCode() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource: Deprecated.
hashCode() - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
hasImageEqualTo(String) - Method in interface net.sourceforge.pmd.lang.ast.Node: Deprecated.
See Node.getImage()
hasNext() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
hasNext() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
hasOverriddenAttributes() - Method in class net.sourceforge.pmd.lang.rule.RuleReference: Checks whether this rule reference explicitly overrides any of the possible attributes of the referenced rule.
hasOverriddenProperty(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference: Deprecated.
Use RuleReference.isPropertyOverridden(PropertyDescriptor) instead
hasVersion(String) - Method in interface net.sourceforge.pmd.lang.Language: Returns true if a language version with the given version string is registered.
help(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: Provides the primary documentation for the report, useful when there is no online documentation.
helpUri(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: A URI where the primary documentation for the report can be found.
HIGH - net.sourceforge.pmd.RulePriority: High: Change absolutely required.
HTML_EXTENSION - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
HTMLRenderer - Class in net.sourceforge.pmd.renderers: Renderer to basic HTML format.
HTMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.HTMLRenderer

I

id - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
id() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor: Returns the ID of this renderer, used to select it.
id(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location.LocationBuilder: Value that distinguishes this location from all other locations within a single result object.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule.AssociatedRuleBuilder: The stable, unique identifier of the rule, if any, to which this result is relevant.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message.MessageBuilder: The identifier for this message.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: A stable, opaque identifier for the report.
IDEAJRenderer - Class in net.sourceforge.pmd.renderers: Renderer for IntelliJ IDEA integration.
IDEAJRenderer() - Constructor for class net.sourceforge.pmd.renderers.IDEAJRenderer
IGNORED__DUPLICATE_CHILD_ELEMENT - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
IGNORED__DUPLICATE_PROPERTY_SETTER - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
IGNORED__PROPERTY_CHILD_HAS_PRECEDENCE - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
IGNORED__UNEXPECTED_ATTRIBUTE_IN - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages
IGNORED__UNEXPECTED_ELEMENT - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages: {0}: unexpected element name; {1}: parent node name; {2}: allowed elements in this context
IGNORED__UNEXPECTED_ELEMENT_IN - Static variable in class net.sourceforge.pmd.util.internal.xml.XmlErrorMessages: {0}: unexpected element name; {1}: parent node name
imageEquals(CharSequence) - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns true if the image of this token equals the given charsequence.
ImageFinderFunction - Class in net.sourceforge.pmd.lang.symboltable
ImageFinderFunction(String) - Constructor for class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
ImageFinderFunction(List<String>) - Constructor for class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
immutableEnumSet(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns an unmodifiable set containing the given elements.
immutableSetOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns an unmodifiable set containing the given elements.
IMPLICIT_TOKEN - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Kind for implicit tokens.
implicitBefore(JavaccToken) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Creates an implicit token, with zero length, that is linked to the given token as its special predecessor.
INCLUDE_PATTERN - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
includeDeprecatedRuleReferences(boolean) - Method in class net.sourceforge.pmd.RuleSetLoader: Follow deprecated rule references.
indentWith(String) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig: Sets the string that should be used to indent children elements.
index(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation.ArtifactLocationBuilder: The index within the run artifacts array of the artifact object associated with the artifact location.
indexOf(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars: See String.indexOf(int, int).
indexOf(String, int) - Method in class net.sourceforge.pmd.lang.document.Chars: See String.indexOf(String, int).
inDoubleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil
info(String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
informationUri(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder: The absolute URI at which information about this version of the tool component can be found.
INHERITED - net.sourceforge.pmd.lang.rule.xpath.NoAttribute.NoAttrScope: Only attributes inherited from superclasses or superinterfaces are filtered out (except those from Node and AbstractNode).
INIT - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
INITIALIZATION - net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
initialize(LanguageProcessor) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
initialize(LanguageProcessor) - Method in class net.sourceforge.pmd.lang.rule.XPathRule
initialize(LanguageProcessor) - Method in interface net.sourceforge.pmd.Rule: Initialize the rule using the language processor if needed.
initialize(RuleSets) - Method in class net.sourceforge.pmd.cache.CachedRuleMapper: Deprecated.

Initialize the mapper with the given rulesets.
initializer() - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener: Provides an initializer to gather analysis context before events start occurring.
initializeRules(LanguageProcessorRegistry, MessageReporter) - Method in class net.sourceforge.pmd.RuleSets: Deprecated.
initThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker: Initialize a thread, starting to track it's own time.
injectRight(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
input - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator: Source characters.
inRange(N, N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints: Requires the number to be inside a range.
insertChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode: Insert a child at the given index, shifting all the following children to the right.
insertChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
inSingleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil
INTEGER - net.sourceforge.pmd.properties.PropertyTypeId
INTEGER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
INTERNAL_DEV_PROPERTIES - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
InternalApi - Annotation Type in net.sourceforge.pmd.annotation: Tags API members that are not publicly supported API.
intersect(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns the set intersection of the given collections.
intersect(TextRegion, TextRegion) - Static method in class net.sourceforge.pmd.lang.document.TextRegion: Computes the intersection of this region with the other.
intListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of integers.
intProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for an integer property.
invertedMapFrom(Map<K, V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Deprecated.
Used by deprecated property types
invocations(List<SarifLog.Invocation>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder: The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
IOUtil - Class in net.sourceforge.pmd.internal.util
IOUtil.BomAwareInputStream - Class in net.sourceforge.pmd.internal.util: Input stream that skips an optional byte order mark at the beginning of the stream.
isAllRules() - Method in class net.sourceforge.pmd.RuleSetReference: Deprecated.
isAllRules() - Method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Is this a reference to all Rules in a RuleSet, or a single Rule?
isAttributeAccessor(Class<?>, Method) - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator: Returns whether the given method is an attribute accessor, in which case a corresponding Attribute will be added to the iterator.
isDefault() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
isDeprecated() - Method in interface net.sourceforge.pmd.Rule: Gets whether this Rule is deprecated.
isEmpty() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns 'true' if the stream has no elements.
isEmpty() - Method in class net.sourceforge.pmd.lang.document.Chars: Whether this slice is the empty string.
isEmpty() - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns true if the region contains no characters.
isEof() - Method in class net.sourceforge.pmd.cpd.TokenEntry
isEof() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns true if this token is an end-of-file token.
isEof() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
isEof() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
isExpandedByDefaultInTree(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
isExpandedByDefaultInTree(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings: Returns true if the children of this node should be displayed in the treeview by default.
isExternal() - Method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Is this an external RuleSet reference?
isFailOnViolation() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isFailOnViolation() - Method in class net.sourceforge.pmd.PMDConfiguration: Whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
isFindBoundary() - Method in interface net.sourceforge.pmd.lang.ast.Node: Returns true if this node is considered a boundary by traversal methods.
isForceLanguageVersion() - Method in class net.sourceforge.pmd.AbstractConfiguration: Is the force-language parameter set to anything?
isHelp() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isHidden() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
isIgnoreAnnotations() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isIgnoreIdentifierAndLiteralSequences() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isIgnoreIdentifiers() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isIgnoreIncrementalAnalysis() - Method in class net.sourceforge.pmd.PMDConfiguration: Returns whether incremental analysis was explicitly disabled by the user or not.
isIgnoreLiterals() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isIgnoreLiteralSequences() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isIgnoreUsings() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isImplicit() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns true if this token is implicit, ie was inserted artificially and has a zero-length image.
isImplicit() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
isInjectionPending() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
isJavaIdentifier(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil: Returns true if the charsequence is a valid java identifier.
isKnown() - Method in enum net.sourceforge.pmd.util.OptionalBool: Returns true this is not OptionalBool.UNKNOWN.
isLanguageSpecificDiscarding() - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter: Extension point for subclasses to indicate tokens are to be filtered.
isLoggable(Level) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
isNoSkipBlocks() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isOverriddenDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
isPropertyOverridden(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource: Returns true if the given property has been set to a value somewhere in the XML.
isReadOnly() - Method in interface net.sourceforge.pmd.lang.document.TextFile: Returns true if this file cannot be written to.
isReadStdin() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
isRuleChain() - Method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector
isRuleSetFactoryCompatibilityEnabled() - Method in class net.sourceforge.pmd.PMDConfiguration: Checks if the rule set factory compatibility feature is enabled.
isSame(String, String, boolean, boolean, boolean) - Static method in class net.sourceforge.pmd.util.StringUtil: Are the two String values the same.
isSet(DataMap.DataKey<? extends K, ?>) - Method in class net.sourceforge.pmd.util.DataMap: Returns true if the given key has a non-null value in the map.
isShowSuppressedViolations() - Method in class net.sourceforge.pmd.PMDConfiguration: Get whether the report should show suppressed violations.
isShowSuppressedViolations() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
isShowSuppressedViolations() - Method in interface net.sourceforge.pmd.renderers.Renderer: Get the indicator for whether to show suppressed violations.
isSkipDuplicates() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isSkipLexicalErrors() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
isSnapshot() - Static method in class net.sourceforge.pmd.PMDVersion: Checks if the current version is a snapshot.
issue() - Method in class net.sourceforge.pmd.Report.ConfigurationError: Gets the reason for the configuration error.
isTrue() - Method in enum net.sourceforge.pmd.util.OptionalBool: Returns true if this is OptionalBool.YES.
isUnknown() - Static method in class net.sourceforge.pmd.PMDVersion: Checks if the current version is unknown.
isUpToDate(TextDocument) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
isUpToDate(TextDocument) - Method in interface net.sourceforge.pmd.cache.AnalysisCache: Deprecated.

Checks if a given file is up to date in the cache and can be skipped from analysis.
isUpToDate(TextDocument) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
isValidJavaPackageName(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
isValidRegion(int, int, TextDocument) - Static method in class net.sourceforge.pmd.lang.document.TextRegion: Checks that the parameters are a valid region, this is provided to debug, will be a noop unless assertions are enabled.
isXPathAvailable - Variable in class net.sourceforge.pmd.properties.PropertyBuilder
isXPathAvailable() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: Returns whether the property is available to XPath queries.
iterate(T...) - Static method in class net.sourceforge.pmd.util.IteratorUtil
iterator() - Method in class net.sourceforge.pmd.cpd.Match
iterator() - Method in class net.sourceforge.pmd.lang.LanguageRegistry
IteratorUtil - Class in net.sourceforge.pmd.util
IteratorUtil.AbstractIterator<T> - Class in net.sourceforge.pmd.util
IteratorUtil.AbstractPausingIterator<T> - Class in net.sourceforge.pmd.util

J

JavaccToken - Class in net.sourceforge.pmd.lang.ast.impl.javacc: A generic token implementation for JavaCC parsers.
JavaccToken(int, String, int, int, JavaccTokenDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Constructor with a String image (see the other ctor).
JavaccToken(int, Chars, int, int, JavaccTokenDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Builds a new token of the specified kind.
JavaccTokenDocument - Class in net.sourceforge.pmd.lang.ast.impl.javacc: Token document for Javacc implementations.
JavaccTokenDocument(TextDocument, JavaccTokenDocument.TokenDocumentBehavior) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
JavaccTokenDocument.TokenDocumentBehavior - Class in net.sourceforge.pmd.lang.ast.impl.javacc: Overridable configuration of a token document.
JavaCCTokenFilter - Class in net.sourceforge.pmd.cpd.impl: A generic filter for JavaCC-based token managers that allows to use comments to enable / disable analysis of parts of the stream
JavaCCTokenFilter(TokenManager<JavaccToken>) - Constructor for class net.sourceforge.pmd.cpd.impl.JavaCCTokenFilter: Creates a new JavaCCTokenFilter
JavaCCTokenizer - Class in net.sourceforge.pmd.cpd.impl: Base class for a Tokenizer for a language implemented by a JavaCC tokenizer.
JavaCCTokenizer() - Constructor for class net.sourceforge.pmd.cpd.impl.JavaCCTokenizer
JavaEscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc: An implementation of EscapeTranslator that translates Java unicode escapes.
JavaEscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaEscapeTranslator
jjtClose() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode: This method is called after all the child nodes have been added.
jjtOpen() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode: This method is called after the node has been made the current node.
JjtreeBuilder<N extends AbstractJjtreeNode<N,?>> - Class in net.sourceforge.pmd.lang.ast.impl.javacc: Shared implementation of the tree builder generated by JJTree.
JjtreeBuilder() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
JjtreeNode<N extends JjtreeNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.javacc: Base interface for nodes that are produced by a JJTree parser.
JjtreeParserAdapter<R extends RootNode> - Class in net.sourceforge.pmd.lang.ast.impl.javacc: Base implementation of the Parser interface for JavaCC language implementations.
JjtreeParserAdapter() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
join(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool: If both values are the same, return it.
joinCharsIntoStringBuilder(List<Chars>, String) - Static method in class net.sourceforge.pmd.util.CollectionUtil
joinOn(StringBuilder, Iterable<? extends T>, BiConsumer<? super StringBuilder, ? super T>, String) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Like String.join(CharSequence, Iterable), except it appends on a preexisting StringBuilder.
joinTokenText() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode: Deprecated.
Some rules depend on it and have not been rewritten
JsonRenderer - Class in net.sourceforge.pmd.renderers
JsonRenderer() - Constructor for class net.sourceforge.pmd.renderers.JsonRenderer
JvmLanguagePropertyBundle - Class in net.sourceforge.pmd.lang: Base properties class for JVM languages that use a classpath to resolve references.
JvmLanguagePropertyBundle(Language) - Constructor for class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle

K

kind - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: An integer that describes the kind of this token.

L

LABEL_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.GUI
Language - Interface in net.sourceforge.pmd.lang: Represents a language module, and provides access to language-specific functionality.
LANGUAGE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
LANGUAGE_SPECIFIC_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory: Subdivided into one label for each stage.
LANGUAGE_VERSION - Static variable in class net.sourceforge.pmd.lang.LanguagePropertyBundle
LanguageFilenameFilter - Class in net.sourceforge.pmd.lang: This is an implementation of the FilenameFilter interface which compares a file against a collection of Languages to see if the any are applicable.
LanguageFilenameFilter(Set<Language>) - Constructor for class net.sourceforge.pmd.lang.LanguageFilenameFilter: Create a LanguageFilenameFilter for a List of Languages.
LanguageFilenameFilter(Language) - Constructor for class net.sourceforge.pmd.lang.LanguageFilenameFilter: Create a LanguageFilenameFilter for a single Language.
LanguageMetricsProvider - Interface in net.sourceforge.pmd.lang.metrics: Language-specific provider for metrics.
LanguageModuleBase - Class in net.sourceforge.pmd.lang: Base class for language modules.
LanguageModuleBase(LanguageModuleBase.LanguageMetadata) - Constructor for class net.sourceforge.pmd.lang.LanguageModuleBase: Construct a module instance using the given metadata.
LanguageModuleBase.LanguageMetadata - Class in net.sourceforge.pmd.lang: Metadata about a language, basically a builder pattern for the language instance.
LanguageProcessor - Interface in net.sourceforge.pmd.lang: Stateful object managing the analysis for a given language.
LanguageProcessor.AnalysisTask - Class in net.sourceforge.pmd.lang: Configuration of an analysis, as given to LanguageProcessor.launchAnalysis(AnalysisTask).
LanguageProcessorRegistry - Class in net.sourceforge.pmd.lang: Stores all currently initialized LanguageProcessors during analysis.
LanguageProcessorRegistry.LanguageTerminationException - Exception in net.sourceforge.pmd.lang: An exception that occurs during the closing of a LanguageProcessor,
LanguagePropertyBundle - Class in net.sourceforge.pmd.lang: A bundle of properties used by languages (see Language.newPropertyBundle()).
LanguagePropertyBundle(Language) - Constructor for class net.sourceforge.pmd.lang.LanguagePropertyBundle: Create a new bundle for the given language.
LanguageRegistry - Class in net.sourceforge.pmd.lang: A set of languages with convenient methods.
LanguageRegistry(Set<? extends Language>) - Constructor for class net.sourceforge.pmd.lang.LanguageRegistry: Create a new registry that contains the given set of languages.
LANGUAGES - net.sourceforge.pmd.util.database.DBType.Property
LanguageTerminationException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.LanguageProcessorRegistry.LanguageTerminationException
languageVersion - Variable in class net.sourceforge.pmd.lang.document.TextFileBuilder
LanguageVersion - Class in net.sourceforge.pmd.lang: Represents a version of a Language.
LanguageVersionDiscoverer - Class in net.sourceforge.pmd.lang: This class can discover the LanguageVersion of a source file.
LanguageVersionDiscoverer(LanguageRegistry) - Constructor for class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Build a new instance with no forced version.
LanguageVersionDiscoverer(LanguageRegistry, LanguageVersion) - Constructor for class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Build a new instance.
LanguageVersionHandler - Interface in net.sourceforge.pmd.lang: Interface for obtaining the classes necessary for checking source files of a specific language.
last() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the last element of this stream, or null if the stream is empty.
last(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns the last element of this stream of the given type, or null if there is none.
last(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
lastIndexOf(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars: See String.lastIndexOf(int, int).
launchAnalysis(LanguageProcessor.AnalysisTask) - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
launchAnalysis(LanguageProcessor.AnalysisTask) - Method in interface net.sourceforge.pmd.lang.LanguageProcessor: Launch the analysis based on the given analysis task.
length() - Method in class net.sourceforge.pmd.lang.document.Chars
LINE_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
lineColumnAtOffset(int) - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns the line and column at the given offset (inclusive).
lineColumnAtOffset(int, boolean) - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns the line and column at the given offset.
lineNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil: Returns the (1-based) line number of the character at the given index.
lines - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
lines() - Method in class net.sourceforge.pmd.lang.document.Chars: Returns an iterable over the lines of this char sequence.
LINES_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
lineSeparator(String) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig: Sets the string that should be used to separate lines.
lineStream() - Method in class net.sourceforge.pmd.lang.document.Chars: Returns a stream of lines yielded by Chars.lines().
linesWithTrimIndent(Chars) - Static method in class net.sourceforge.pmd.util.StringUtil: Returns a list of
LINK_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
ListenerInitializer - Interface in net.sourceforge.pmd.reporting: An initializer for GlobalAnalysisListener that gets notified of general analysis parameters.
listOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
listOfNotNull(T) - Static method in class net.sourceforge.pmd.util.CollectionUtil
LOAD_RULES - net.sourceforge.pmd.benchmark.TimedOperationCategory
loadClass(String, boolean) - Method in class net.sourceforge.pmd.internal.util.ClasspathClassLoader
loadClassPathResourceAsStream(String) - Method in class net.sourceforge.pmd.util.ResourceLoader: Deprecated.
loadClassPathResourceAsStreamOrThrow(String) - Method in class net.sourceforge.pmd.util.ResourceLoader: Deprecated.
loadFromResource(String) - Method in class net.sourceforge.pmd.RuleSetLoader: Parses and returns a ruleset from its location.
loadFromResources(String, String...) - Method in class net.sourceforge.pmd.RuleSetLoader: Parses several resources into a list of rulesets.
loadFromResources(Collection<String>) - Method in class net.sourceforge.pmd.RuleSetLoader: Parses several resources into a list of rulesets.
loadFromString(String, String) - Method in class net.sourceforge.pmd.RuleSetLoader: Parses and returns a ruleset from string content.
loadLanguages(ClassLoader) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry: Create a new registry by loading the languages registered via ServiceLoader on the classpath of the given classloader.
loadResourceAsStream(String) - Method in class net.sourceforge.pmd.util.ResourceLoader: Deprecated.

Attempts to load the resource from file, a URL or the claspath
loadResourcesWith(ClassLoader) - Method in class net.sourceforge.pmd.RuleSetLoader: Specify that the given classloader should be used to resolve paths to external ruleset references.
loadRuleFromClassPath(String) - Method in class net.sourceforge.pmd.util.ResourceLoader: Deprecated.

Load the rule from the classloader from resource loader, consistent with the ruleset
loadRuleSetsWithoutException(List<String>) - Method in class net.sourceforge.pmd.RuleSetLoader: Loads a list of rulesets, if any has an error, report it on the contextual error reporter instead of aborting, and continue loading the rest.
location - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
location() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
location() - Method in exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
location() - Method in exception net.sourceforge.pmd.lang.ast.ParseException
location() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
Location(String, int, int) - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
locationAt(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
locations(List<SarifLog.Location>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder: The set of locations where the result was detected.
locations(List<SarifLog.Location>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder: A list of related locations to the error
log(Level, String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
LOG - Static variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
logEx(Level, String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
LONG - net.sourceforge.pmd.properties.PropertyTypeId
LONG_LIST - net.sourceforge.pmd.properties.PropertyTypeId
longIntListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a property having as value a list of long integers.
longIntProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a long integer property.
lookupMnemonic(String) - Static method in enum net.sourceforge.pmd.properties.PropertyTypeId: Gets the enum constant corresponding to the given mnemonic.
LOW - net.sourceforge.pmd.RulePriority: Low: Change highly optional.

M

main(String[]) - Static method in class net.sourceforge.pmd.cpd.GUI
makeLexerImpl(TextDocument) - Method in class net.sourceforge.pmd.cpd.impl.AntlrTokenizer
makeLexerImpl(TextDocument) - Method in class net.sourceforge.pmd.cpd.impl.TokenizerBase
makeLexException(int, int, String, Throwable) - Method in interface net.sourceforge.pmd.cpd.TokenFactory
makeUnmodifiableAndNonNull(List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
MalformedSourceException - Exception in net.sourceforge.pmd.lang.ast.impl.javacc: A FileAnalysisException thrown when the source format is invalid, for example if some unicode escapes cannot be translated.
MalformedSourceException(String, Throwable, FileLocation) - Constructor for exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
map(Iterable<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given iterable with the given function, and accumulates it into an unmodifiable list.
map(Collection<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given collection with the given function, and accumulates it into an unmodifiable list.
map(Function<? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream consisting of the results of applying the given mapping function to the node of this stream.
map(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given iterator with the given function, and accumulates it into an unmodifiable list.
map(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
map(Collector<? super U, A, ? extends C>, Iterable<? extends T>, Function<? super T, ? extends U>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given iterable with the given function, and accumulates it into the collector.
map(Collector<? super U, A, ? extends C>, Iterator<? extends T>, Function<? super T, ? extends U>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given iterator with the given function, and accumulates it into the collector.
map(T[], Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Map each element of the given array with the given function, and accumulates it into an unmodifiable list.
mapFrom(K[], V[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Deprecated.
Used by deprecated property types
mapIterator(Iterable<? extends T>, Function<? super Iterator<? extends T>, ? extends Iterator<R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Apply a transform on the iterator of an iterable.
mapNotNull(Iterable<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
mapNotNull(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
mapOf(K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
mapOf(K, V, K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Mark - Class in net.sourceforge.pmd.cpd: A range of tokens in a source file, identified by a start and end token (both included in the range).
markdown(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message.MessageBuilder: A Markdown message string.
markdown(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage.MultiformatMessageBuilder: A Markdown message string or format string.
markTokenStart() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Calls CharStream.readChar() and returns its value, marking its position as the beginning of the next token.
Match - Class in net.sourceforge.pmd.cpd
MATCH - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
MATCHES_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
matchesElt(Node) - Method in class net.sourceforge.pmd.util.internal.xml.SchemaConstant
matchesName(Element, Set<SchemaConstant>) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
max(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
MAXIMUM_LANGUAGE_VERSION - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
MEDIUM - net.sourceforge.pmd.RulePriority: Medium: Change recommended.
MEDIUM_HIGH - net.sourceforge.pmd.RulePriority: Medium to high: Change highly recommended.
MEDIUM_LOW - net.sourceforge.pmd.RulePriority: Medium to low: Change optional.
merge(Report) - Method in class net.sourceforge.pmd.Report: Deprecated.
Convert Renderer to use the reports.
mergeMaps(Map<K, V>, Map<K, V>, BinaryOperator<V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Merge the second map into the first.
message(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception.ExceptionBuilder: A plain text message string or format string.
message(SarifLog.Message) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder: A message that describes the result.
message(SarifLog.Message) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder: A message component to detail the configuration error
message(SarifLog.Message) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder: A message component to detail the runtime error
MESSAGE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
MessageReporter - Interface in net.sourceforge.pmd.util.log: Façade to report user-facing messages (info, warning and error).
messageStrings(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: A set of name/value pairs with arbitrary names.
METHOD - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
METHOD_NAME - Static variable in interface net.sourceforge.pmd.RuleViolation: Key in RuleViolation.getAdditionalInfo() for the name of the method in which the violation was identified.
Metric<N extends Node,R extends Number> - Interface in net.sourceforge.pmd.lang.metrics: A named computation that can be carried out on some nodes.
MetricOption - Interface in net.sourceforge.pmd.lang.metrics: Option to pass to a metric.
MetricOptions - Class in net.sourceforge.pmd.lang.metrics: Bundles a set of options to pass to a metric.
MetricsUtil - Class in net.sourceforge.pmd.lang.metrics: Utilities to use Metric instances.
min(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
MINIMUM_LANGUAGE_VERSION - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
MultiformatMessage() - Constructor for class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
MultiformatMessage(String) - Constructor for class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
MultiformatMessage(String, String) - Constructor for class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
mustBe(String, Object, String) - Static method in class net.sourceforge.pmd.util.AssertionUtil
mustBe(String, Object, String, Function<String, E>) - Static method in class net.sourceforge.pmd.util.AssertionUtil

N

name - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
name() - Method in interface net.sourceforge.pmd.lang.metrics.MetricOption: Returns the name of the option constant.
name() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: The name of the property without spaces as it serves as the key into the property map.
name(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata: Record the display name of the language.
name(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder: The name of the tool component.
name(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: A report identifier that is understandable to an end user.
NAME - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.CSVRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.EmacsRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.EmptyRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.JsonRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.SarifRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.TextColorRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.TextPadRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.TextRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.VBHTMLRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.XMLRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.XSLTRenderer
NAME - Static variable in class net.sourceforge.pmd.renderers.YAHTMLRenderer
NAME - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
nameAliases() - Method in interface net.sourceforge.pmd.lang.metrics.Metric: List of name aliases by which the metric is recognisable.
NameDeclaration - Interface in net.sourceforge.pmd.lang.symboltable: This is a declaration of a name, e.g.
NameOccurrence - Interface in net.sourceforge.pmd.lang.symboltable: A NameOccurrence represents one usage of a name declaration.
net.sourceforge.pmd - package net.sourceforge.pmd: This is the PMD programming mistake detector.
net.sourceforge.pmd.annotation - package net.sourceforge.pmd.annotation
net.sourceforge.pmd.benchmark - package net.sourceforge.pmd.benchmark
net.sourceforge.pmd.cache - package net.sourceforge.pmd.cache: The violation caching system.
net.sourceforge.pmd.cpd - package net.sourceforge.pmd.cpd: Token-based copy-paste detection.
net.sourceforge.pmd.cpd.impl - package net.sourceforge.pmd.cpd.impl: Utilities to implement a CPD Tokenizer.
net.sourceforge.pmd.internal.util - package net.sourceforge.pmd.internal.util
net.sourceforge.pmd.lang - package net.sourceforge.pmd.lang
net.sourceforge.pmd.lang.ast - package net.sourceforge.pmd.lang.ast
net.sourceforge.pmd.lang.ast.impl - package net.sourceforge.pmd.lang.ast.impl
net.sourceforge.pmd.lang.ast.impl.antlr4 - package net.sourceforge.pmd.lang.ast.impl.antlr4
net.sourceforge.pmd.lang.ast.impl.javacc - package net.sourceforge.pmd.lang.ast.impl.javacc: Support classes for language implementations based on JavaCC.
net.sourceforge.pmd.lang.document - package net.sourceforge.pmd.lang.document: Contains types to model text files and handle operations on text.
net.sourceforge.pmd.lang.impl - package net.sourceforge.pmd.lang.impl
net.sourceforge.pmd.lang.metrics - package net.sourceforge.pmd.lang.metrics: Language-independent framework to represent code metrics.
net.sourceforge.pmd.lang.rule - package net.sourceforge.pmd.lang.rule
net.sourceforge.pmd.lang.rule.xpath - package net.sourceforge.pmd.lang.rule.xpath
net.sourceforge.pmd.lang.rule.xpath.impl - package net.sourceforge.pmd.lang.rule.xpath.impl
net.sourceforge.pmd.lang.symboltable - package net.sourceforge.pmd.lang.symboltable
net.sourceforge.pmd.properties - package net.sourceforge.pmd.properties
net.sourceforge.pmd.renderers - package net.sourceforge.pmd.renderers
net.sourceforge.pmd.renderers.internal.sarif - package net.sourceforge.pmd.renderers.internal.sarif
net.sourceforge.pmd.reporting - package net.sourceforge.pmd.reporting: Logic about reporting: violations, suppression etc.
net.sourceforge.pmd.rules - package net.sourceforge.pmd.rules
net.sourceforge.pmd.util - package net.sourceforge.pmd.util
net.sourceforge.pmd.util.database - package net.sourceforge.pmd.util.database
net.sourceforge.pmd.util.datasource - package net.sourceforge.pmd.util.datasource
net.sourceforge.pmd.util.designerbindings - package net.sourceforge.pmd.util.designerbindings
net.sourceforge.pmd.util.internal.xml - package net.sourceforge.pmd.util.internal.xml
net.sourceforge.pmd.util.log - package net.sourceforge.pmd.util.log
net.sourceforge.pmd.util.treeexport - package net.sourceforge.pmd.util.treeexport
never() - Static method in class net.sourceforge.pmd.internal.util.PredicateUtil: A predicate that always returns false.
newBuilder(String) - Method in interface net.sourceforge.pmd.properties.PropertyTypeId.BuilderAndMapper
newCollector(LanguageVersionDiscoverer, MessageReporter) - Static method in class net.sourceforge.pmd.lang.document.FileCollector: Internal API: please use PmdAnalysis.files() instead of creating a collector yourself.
newCollector(MessageReporter) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Returns a new collector using the configuration except for the logger.
newDataMap() - Static method in class net.sourceforge.pmd.util.DataMap
newException(Level, Throwable, String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter: Logs and returns a new exception.
newImplicit(int, JavaccTokenDocument) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Returns a new implicit token, positioned at the given offset.
newListener() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
newListener() - Method in interface net.sourceforge.pmd.renderers.Renderer: Returns a new analysis listener, that handles violations by rendering them in an implementation-defined way.
newPropertyBundle() - Method in interface net.sourceforge.pmd.lang.Language: Creates a new bundle of properties that will serve to configure the LanguageProcessor for this language.
newPropertyBundle() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor: Returns a new property bundle, that can be used to configure the output of TreeRendererDescriptor.produceRenderer(PropertySource).
newReader() - Method in class net.sourceforge.pmd.lang.document.Chars: Returns a new reader for the whole contents of this char sequence.
newReader() - Method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a reader over the text of this document.
newRuleSetLoader() - Method in class net.sourceforge.pmd.PmdAnalysis: Returns a new ruleset loader, which can be used to create new rulesets (add them then with PmdAnalysis.addRuleSet(RuleSet)).
next - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: A reference to the next regular (non-special) token from the input stream.
next() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
next() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
next() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
NO - net.sourceforge.pmd.util.OptionalBool
NO_REPLACEMENT - Static variable in annotation type net.sourceforge.pmd.lang.rule.xpath.DeprecatedAttribute
NoAttribute - Annotation Type in net.sourceforge.pmd.lang.rule.xpath: Filters out some methods from the XPath attributes of a node.
NoAttribute.NoAttrScope - Enum in net.sourceforge.pmd.lang.rule.xpath
node - Variable in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
Node - Interface in net.sourceforge.pmd.lang.ast: Root interface for all AST nodes.
nodeArity() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Returns the number of children on the stack in the current node scope.
nodeCreated() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Determines whether the current node was actually closed and pushed.
NodeStream<T extends Node> - Interface in net.sourceforge.pmd.lang.ast: A sequence of AST nodes.
NodeStream.DescendantNodeStream<T extends Node> - Interface in net.sourceforge.pmd.lang.ast: A specialization of NodeStream that allows configuring tree traversal behaviour when traversing the descendants of a node.
noFunctionDefinitions() - Static method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler
nonAlphaNumName(String) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary: Override this to customize the XPath name of tokes with no symbolic name and with an image that is non-alphanumeric.
none(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Returns true if no element of the iterable matches the predicate.
none(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns whether no elements of this stream match the provided predicate.
noneMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil: Returns whether no elements match the predicate.
nonEmpty() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns 'true' if the stream has at least one element.
noop() - Static method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
noop() - Static method in interface net.sourceforge.pmd.reporting.FileAnalysisListener: A listener that does nothing.
noop() - Static method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener: A listener that does nothing.
noop() - Static method in interface net.sourceforge.pmd.reporting.ListenerInitializer: A listener that does nothing.
noop() - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator
NoopAnalysisCache - Class in net.sourceforge.pmd.cache: Deprecated.
This is internal API, will be hidden with 7.0.0
NoopAnalysisCache() - Constructor for class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
NOPMD_COMMENT_SUPPRESSOR - Static variable in interface net.sourceforge.pmd.ViolationSuppressor: Suppressor for regular NOPMD comments.
NORMALIZED_LINE_TERM - Static variable in class net.sourceforge.pmd.lang.document.TextFileContent: The normalized line ending used to replace platform-specific line endings in the normalized text.
NORMALIZED_LINE_TERM_CHAR - Static variable in class net.sourceforge.pmd.lang.document.TextFileContent: The normalized line ending as a char.
normalizeFilename(String) - Static method in class net.sourceforge.pmd.internal.util.FileUtil: Normalizes the filename by taking the casing into account, e.g.
normalizePath(String) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
NULL_CHARACTER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
nullToEmpty(String) - Static method in class net.sourceforge.pmd.util.StringUtil: Return the empty string if the parameter is null.
NumericConstraints - Class in net.sourceforge.pmd.properties: Common constraints for properties dealing with numbers.
numErrors() - Method in interface net.sourceforge.pmd.util.log.MessageReporter: Returns the number of errors reported on this instance.

O

of(T) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing zero or one node, depending on whether the argument is null or not.
of(BiFunction<? super T, MetricOptions, ? extends R>, Function<Node, ? extends T>, String, String...) - Static method in interface net.sourceforge.pmd.lang.metrics.Metric: Factory method for a metric.
of(T...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream whose elements are the given nodes in order.
ofId(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion: Gets an XPath version from the string used to represent it in the XML.
ofOptional(Optional<? extends T>) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing zero or one node, depending on whether the optional is empty or not.
ofOptions(Collection<? extends MetricOption>) - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions: Gets an options bundle from a collection of options.
ofOptions(MetricOption, MetricOption...) - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions: Gets an options bundle from options.
onConfigError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.Report.GlobalReportBuilderListener
onConfigError(Report.ConfigurationError) - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener: Record a configuration error.
onError(Report.ProcessingError) - Method in class net.sourceforge.pmd.Report.ReportBuilderListener
onError(Report.ProcessingError) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener: Handle an error that occurred while processing a file.
onlyRecognizeLanguages(LanguageRegistry) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Make it so that the only extensions that are considered are those of the given language.
onRuleViolation(RuleViolation) - Method in class net.sourceforge.pmd.Report.ReportBuilderListener
onRuleViolation(RuleViolation) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener: Handle a new violation (not suppressed).
onSuppressedRuleViolation(Report.SuppressedViolation) - Method in class net.sourceforge.pmd.Report.ReportBuilderListener
onSuppressedRuleViolation(Report.SuppressedViolation) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener: Handle a new suppressed violation.
open - Variable in class net.sourceforge.pmd.internal.util.BaseCloseable
open() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument: Open the document.
openNodeScope(N, JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
OptionalBool - Enum in net.sourceforge.pmd.util: Represents a boolean that may not be present.
OUTPUT_DIR - Static variable in class net.sourceforge.pmd.renderers.YAHTMLRenderer
outputReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer: Output the report, called once at the end of the analysis.
outputReport(Report) - Method in class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
outputReport(Report) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
outputReport(Report) - Method in class net.sourceforge.pmd.renderers.YAHTMLRenderer
overlaps(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion: Returns true if this region overlaps the other region by at least one character.

P

PACKAGE_NAME - Static variable in interface net.sourceforge.pmd.RuleViolation: Key in RuleViolation.getAdditionalInfo() for the name of the package in which the violation was identified.
ParametricRuleViolation - Class in net.sourceforge.pmd.lang.rule: Deprecated.
This is internal. Clients should exclusively use RuleViolation.
ParametricRuleViolation(Rule, FileLocation, String) - Constructor for class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
ParametricRuleViolation(Rule, FileLocation, String, Map<String, String>) - Constructor for class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
ParametricRuleViolation(Rule, Reportable, String) - Constructor for class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
Update tests that use this not to call the ctor directly.
ParametricRuleViolation(Rule, Reportable, String, Map<String, String>) - Constructor for class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
parentFsId - Variable in class net.sourceforge.pmd.lang.document.TextFileBuilder
parents() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the (first-degree) parents of the nodes contained in this stream.
parse(String) - Static method in class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Parse a String comma separated list of RuleSet reference IDs into a List of RuleReferenceId instances.
parse(Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
parse(Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
parse(Parser.ParserTask) - Method in interface net.sourceforge.pmd.lang.ast.Parser: Parses an entire tree for this language.
parse(Lexer, Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
ParseException - Exception in net.sourceforge.pmd.lang.ast
ParseException(JavaccToken, int[][]) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException: This constructor is called by Javacc.
ParseException(String) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
ParseException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
parseImpl(CharStream, Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
parsePriority(PmdXmlReporter, Element) - Static method in class net.sourceforge.pmd.rules.RuleFactory: Deprecated.

Parse a priority.
Parser - Interface in net.sourceforge.pmd.lang.ast: Produces an AST from a source file.
PARSER - net.sourceforge.pmd.benchmark.TimedOperationCategory
Parser.ParserTask - Class in net.sourceforge.pmd.lang.ast: Parameters passed to a parsing task.
ParserTask(TextDocument, SemanticErrorReporter, LanguageProcessorRegistry) - Constructor for class net.sourceforge.pmd.lang.ast.Parser.ParserTask
parseTextNode(Node) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil: Parse a String from a textually type node.
PASCAL_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention: PascalCase.
PASSWORD - net.sourceforge.pmd.util.database.DBType.Property
path - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
peek(Consumer<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
peek(Iterator<? extends T>, Consumer<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
peekLastToken() - Method in interface net.sourceforge.pmd.cpd.TokenFactory: Returns the last token that has been recorded in this file.
peekNode() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Returns the node currently on the top of the stack.
peekNode(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Peek the nth node from the top of the stack.
percentageString(double, int) - Static method in class net.sourceforge.pmd.util.StringUtil: Formats a double to a percentage, keeping numDecimal decimal places.
performAnalysis() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
performAnalysis() - Method in class net.sourceforge.pmd.PmdAnalysis: Run PMD with the current state of this instance.
performAnalysis(Consumer<CPDReport>) - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
performAnalysisAndCollectReport() - Method in class net.sourceforge.pmd.PmdAnalysis: Run PMD with the current state of this instance.
persist() - Method in interface net.sourceforge.pmd.cache.AnalysisCache: Deprecated.

Persists the updated analysis results on whatever medium is used by the cache.
persist() - Method in class net.sourceforge.pmd.cache.FileAnalysisCache: Deprecated.
persist() - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache: Deprecated.
phaseUpdate(int) - Method in interface net.sourceforge.pmd.cpd.CPDListener
phaseUpdate(int) - Method in class net.sourceforge.pmd.cpd.CPDNullListener
phaseUpdate(int) - Method in class net.sourceforge.pmd.cpd.GUI
physicalLocation(SarifLog.PhysicalLocation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location.LocationBuilder: Identifies the artifact and region.
PlainTextLanguage - Class in net.sourceforge.pmd.lang: A dummy language implementation whose parser produces a single node.
PlainTextLanguage.PlainTextFile - Class in net.sourceforge.pmd.lang: The only node produced by the parser of PlainTextLanguage.
plus(List<V>, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Produce a new list with the elements of the first, and one additional item.
plus(Map<K, V>, K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil: Produce a new map with the mappings of the first, and one additional mapping.
PMD - Static variable in class net.sourceforge.pmd.lang.LanguageRegistry: Contains the languages that support PMD and are found on the classpath of the classloader of this class.
PmdAnalysis - Class in net.sourceforge.pmd: Main programmatic API of PMD.
PmdCapableLanguage - Interface in net.sourceforge.pmd.lang: A language that supports PMD.
PMDConfiguration - Class in net.sourceforge.pmd: This class contains the details for the runtime configuration of a PMD run.
PMDConfiguration() - Constructor for class net.sourceforge.pmd.PMDConfiguration
PMDConfiguration(LanguageRegistry) - Constructor for class net.sourceforge.pmd.PMDConfiguration
pmdVersion - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
PMDVersion - Class in net.sourceforge.pmd: Stores the current PMD version and provides utility methods around it.
PmdXmlReporter - Interface in net.sourceforge.pmd.util.internal.xml
PmdXPathException - Exception in net.sourceforge.pmd.lang.rule.xpath: Unchecked exception wrapper for XPathException.
PmdXPathException(XPathException, PmdXPathException.Phase, String, XPathVersion) - Constructor for exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
PmdXPathException.Phase - Enum in net.sourceforge.pmd.lang.rule.xpath
popNode() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Returns the node on the top of the stack, and remove it from the stack.
pos2d(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextPos2d: Builds a new region from offset and length.
positive() - Static method in class net.sourceforge.pmd.properties.NumericConstraints: Requires the number to be strictly positive.
precedingSiblings() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a node stream containing all the preceding siblings of the nodes contained in this stream.
Predicate<T> - Interface in net.sourceforge.pmd.util: Simple predicate of one argument.
PredicateUtil - Class in net.sourceforge.pmd.internal.util: Utility class for working with Predicate.
prepareViewOn(T) - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
prepend(NodeStream<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Returns a new node stream that contains all the elements of the given stream, then all the elements of this stream.
prependAuxClasspath(String) - Method in class net.sourceforge.pmd.PMDConfiguration: Prepend the specified classpath like string to the current ClassLoader of the configuration.
prependClasspath(String) - Method in class net.sourceforge.pmd.PMDConfiguration: Deprecated.
Use PMDConfiguration.prependAuxClasspath(String), which doesn't throw a checked IOException
previousSpecials(T) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns an iterable that enumerates all special tokens belonging to the given token.
priority(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag.PropertyBagBuilder: The pmd priority of the rule.
PRIORITY - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
ProcessingError(Throwable, FileId) - Constructor for class net.sourceforge.pmd.Report.ProcessingError: Creates a new processing error
processToken(TokenFactory, T) - Method in class net.sourceforge.pmd.cpd.impl.TokenizerBase
produceRenderer(PropertySource) - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor: Builds a new renderer from the given properties.
properties(SarifLog.PropertyBag) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder: Key/value pairs that provide additional information about the report.
properties(SarifLog.PropertyBag) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder: Key/value pairs that provide additional information about the address.
PROPERTIES - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PROPERTY_ELT - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PROPERTY_MAX - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PROPERTY_MIN - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PROPERTY_TYPE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PROPERTY_VALUE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
PropertyBuilder<B extends PropertyBuilder<B,T>,T> - Class in net.sourceforge.pmd.properties: Base class for generic property builders.
PropertyBuilder.GenericCollectionPropertyBuilder<V,C extends Iterable<V>> - Class in net.sourceforge.pmd.properties: Generic builder for a collection-valued property.
PropertyBuilder.GenericPropertyBuilder<T> - Class in net.sourceforge.pmd.properties: Generic builder for a single-value property.
PropertyBuilder.RegexPropertyBuilder - Class in net.sourceforge.pmd.properties: Specialized builder for regex properties.
PropertyConstraint<T> - Interface in net.sourceforge.pmd.properties: Validates the value of a property.
PropertyDescriptor<T> - Class in net.sourceforge.pmd.properties: Describes a property of a rule or a renderer.
propertyDescriptors - Variable in class net.sourceforge.pmd.properties.AbstractPropertySource: Deprecated.
Will be made private final
PropertyFactory - Class in net.sourceforge.pmd.properties: Provides factory methods for common property types.
PropertySerializer<T> - Class in net.sourceforge.pmd.properties: Strategy to serialize a value to and from strings.
PropertySource - Interface in net.sourceforge.pmd.properties: Entity that manages a list of properties.
PropertyTypeId - Enum in net.sourceforge.pmd.properties: Enumerates the properties that can be built from the XML.
PropertyTypeId.BuilderAndMapper<T> - Interface in net.sourceforge.pmd.properties: An factory for new properties, whose default value must be deserialized using an PropertySerializer.
propertyValuesByDescriptor - Variable in class net.sourceforge.pmd.properties.AbstractPropertySource: Deprecated.
Will be made private final
pushNewRecursionContext(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
pushNode(N) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Pushes a node on to the stack.

Q

quiet() - Static method in interface net.sourceforge.pmd.util.log.MessageReporter: Returns a reporter instance that does not output anything, but still counts errors.
quoteMessageFormat(String) - Static method in class net.sourceforge.pmd.util.StringUtil: Escape the string so that it appears literally when interpreted by a MessageFormat.

R

range(FileId, TextRange2d) - Static method in class net.sourceforge.pmd.lang.document.FileLocation: Creates a new location for a range of text.
range(T, T) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken: Returns an iterator that enumerates all (non-special) tokens between the two tokens (bounds included).
range2d(int, int, int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d
range2d(TextPos2d, TextPos2d) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d
read() - Method in class net.sourceforge.pmd.internal.util.IOUtil.BomAwareInputStream
read(byte[], int, int) - Method in class net.sourceforge.pmd.internal.util.IOUtil.BomAwareInputStream
readChar() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream: Returns the next character from the input.
readContents() - Method in interface net.sourceforge.pmd.lang.document.TextFile: Reads the contents of the underlying character source.
ReaderDataSource - Class in net.sourceforge.pmd.util.datasource: Deprecated.
ReaderDataSource(Reader, String) - Constructor for class net.sourceforge.pmd.util.datasource.ReaderDataSource: Deprecated.

Create the DataSource from the Reader.
readFilelistEntries(Path) - Static method in class net.sourceforge.pmd.internal.util.FileUtil: Reads the file, which contains the filelist.
readFileToString(File) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
readFileToString(File, Charset) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
ReadOnlyFileException - Exception in net.sourceforge.pmd.lang.document: Thrown when an attempt to write through a TextFile fails because the file is read-only.
ReadOnlyFileException(TextFile) - Constructor for exception net.sourceforge.pmd.lang.document.ReadOnlyFileException
readOnlyString(CharSequence, String, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument: Deprecated.
readOnlyString(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a read-only document for the given text.
readOnlyString(CharSequence, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument: Returns a read-only document for the given text.
readToString(InputStream, Charset) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
readToString(Reader) - Static method in class net.sourceforge.pmd.internal.util.IOUtil
recordDelta(int, int, Chars) - Method in class net.sourceforge.pmd.lang.document.FragmentedDocBuilder: Add a new fragment.
recordEscape(int, int, Chars) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
recordEscape(int, int, Chars) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
recordToken(String, int, int, int, int) - Method in interface net.sourceforge.pmd.cpd.TokenFactory: Record a token given its coordinates.
recordToken(String, FileLocation) - Method in interface net.sourceforge.pmd.cpd.TokenFactory: Record a token given its coordinates.
reduce(R, BiFunction<? super R, ? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream: Reduce the elements of this stream sequentially.
REF - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
REGEX - net.sourceforge.pmd.properties.PropertyTypeId
REGEX_SUPPRESSOR - Static variable in interface net.sourceforge.pmd.ViolationSuppressor: Suppressor for the violationSuppressRegex property.
regexProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory: Returns a builder for a regex property.
region(SarifLog.Region) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation.PhysicalLocationBuilder: Specifies a portion of the artifact.
register(TreeRendererDescriptor) - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers: Registers the given renderer.
registeredRenderers() - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers: Returns the set of renderers currently registered.
RelatedNodesSelector - Interface in net.sourceforge.pmd.util.designerbindings: Provides a way for the designer to highlight related nodes upon selection, eg those nodes referring to the same variable or method.
relativizeWith(Path) - Method in class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer: Add a prefix that is used to relativize file paths as their display name.
remediation_points - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
REMEDIATION_POINTS_DEFAULT - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
remove() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
remove() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator: Deprecated.
removeChildAtIndex(int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
removedInvalidXml10Characters(String) - Static method in class net.sourceforge.pmd.util.StringUtil: Remove characters, that are not allowed in XML 1.0 documents.
removeDoubleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil: Like removeSurrounding with a double quote as a delimiter.
removeDysfunctionalRules(Collection<Rule>) - Method in class net.sourceforge.pmd.RuleSet: Deprecated.
This is internal API, removed in PMD 7. You should not use a ruleset directly.
removeDysfunctionalRules(Collection<Rule>) - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Remove and collect any rules that report problems.
removePrefix(String) - Method in class net.sourceforge.pmd.lang.document.Chars: Remove the prefix if it is present, otherwise returns this.
removeSuffix(String) - Method in class net.sourceforge.pmd.lang.document.Chars: Remove the suffix if it is present, otherwise returns this.
removeSurrounding(String, char) - Static method in class net.sourceforge.pmd.util.StringUtil: If the string starts and ends with the delimiter, returns the substring within the delimiters.
render(TimingReport, Writer) - Method in class net.sourceforge.pmd.benchmark.TextTimingReportRenderer
render(TimingReport, Writer) - Method in interface net.sourceforge.pmd.benchmark.TimingReportRenderer: Renders the given report into the given writer.
render(CPDReport, Writer) - Method in interface net.sourceforge.pmd.cpd.CPDReportRenderer: Write out the contents of the report to the given writer.
render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.CSVRenderer
render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.SimpleRenderer
render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.VSRenderer
render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.XMLRenderer
renderBody(PrintWriter, Report) - Method in class net.sourceforge.pmd.renderers.HTMLRenderer: Write the body of the main body of the HTML content.
Renderer - Interface in net.sourceforge.pmd.renderers: This is an interface for rendering a Report.
RendererFactory - Class in net.sourceforge.pmd.renderers: This class handles the creation of Renderers.
renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer: Deprecated.
This is internal API. Do not override when extending AbstractAccumulatingRenderer. In PMD7 this method will be made final.
renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
renderFileReport(Report) - Method in interface net.sourceforge.pmd.renderers.Renderer: Render the given file Report.
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer: Render a series of RuleViolations.
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.CodeClimateRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.CSVRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.EmacsRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.IDEAJRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.JsonRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.SarifRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.TextPadRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.TextRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.XMLRenderer
renderProlog(boolean) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig: Sets whether to render an XML prolog or not.
renderSubtree(Node, Appendable) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
renderSubtree(Node, Appendable) - Method in interface net.sourceforge.pmd.util.treeexport.TreeRenderer: Appends the subtree rooted at the given node on the provided output writer.
renderSubtree(Node, Appendable) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer: Appends the subtree rooted at the given node on the provided output writer.
renderToString(CPDReport) - Method in interface net.sourceforge.pmd.cpd.CPDReportRenderer: Call the other render method on a StringWriter.
replaceImage(CharStream) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken: Returns a new token with the same kind as this one, whose image is replaced by the one marked on the char stream.
replacementIfDeprecated() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute: Returns null for "not deprecated", empty string for "deprecated without replacement", otherwise name of replacement attribute.
replaceWith() - Method in annotation type net.sourceforge.pmd.lang.rule.xpath.DeprecatedAttribute: The simple name of the attribute to use for replacement (with '@' prefix).
Report - Class in net.sourceforge.pmd: A Report collects all informations during a PMD execution.
Report() - Constructor for class net.sourceforge.pmd.Report
Report.ConfigurationError - Class in net.sourceforge.pmd: Represents a configuration error.
Report.GlobalReportBuilderListener - Class in net.sourceforge.pmd: A GlobalAnalysisListener that accumulates the events of all files into a Report.
Report.ProcessingError - Class in net.sourceforge.pmd: Represents a processing error, such as a parse error.
Report.ReportBuilderListener - Class in net.sourceforge.pmd: A FileAnalysisListener that accumulates events into a Report.
Report.SuppressedViolation - Class in net.sourceforge.pmd: Represents a violation, that has been suppressed.
Reportable - Interface in net.sourceforge.pmd.reporting: Interface implemented by those objects that can be the target of a RuleViolation.
ReportBuilderListener() - Constructor for class net.sourceforge.pmd.Report.ReportBuilderListener
reportFile - Variable in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
reportIgnoredUnexpectedElt(Element, Element, Set<SchemaConstant>, PmdXmlReporter) - Static method in class net.sourceforge.pmd.util.internal.xml.XmlUtil
REPORTING - net.sourceforge.pmd.benchmark.TimedOperationCategory
ReportStats - Class in net.sourceforge.pmd.reporting: Summarized info about a report.
ReportStatsListener - Class in net.sourceforge.pmd.reporting: Collects summarized info about a PMD run.
ReportStatsListener() - Constructor for class net.sourceforge.pmd.reporting.ReportStatsListener
reportToLogger(MessageReporter) - Static method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter: Forwards to a MessageReporter, except trace and debug messages which are reported on a logger.
require(PropertyConstraint<? super C>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
require(PropertyConstraint<? super T>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder: Add a constraint on the values that this property may take.
requireContainsNoNullValue(String, Collection<?>) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireEach(PropertyConstraint<? super V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder: Require that the given constraint be fulfilled on each item of the value of this property.
requireIndexNonNegative(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireInExclusiveRange(String, int, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireInInclusiveRange(String, int, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireInNonNegativeRange(String, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireInPositiveRange(String, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireInRange(String, int, int, int, boolean) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireNonNegative(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireNotEmpty(String, Collection<?>) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireOver1(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
requireParamNotNull(String, T) - Static method in class net.sourceforge.pmd.util.AssertionUtil
ReservedSubclassing - Annotation Type in net.sourceforge.pmd.annotation: Indicates that subclassing this type is not publicly supported API.
reset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Call this to reinitialize the node stack.
resolve(String, String) - Method in class net.sourceforge.pmd.util.database.ResourceResolver
ResourceLoader - Class in net.sourceforge.pmd.util.database: Helper class for retrieving resources relative to the installation.
ResourceLoader - Class in net.sourceforge.pmd.util: Deprecated.
Is internal API
ResourceLoader() - Constructor for class net.sourceforge.pmd.util.database.ResourceLoader
ResourceLoader() - Constructor for class net.sourceforge.pmd.util.ResourceLoader: Deprecated.

Constructor for ResourceLoader.
ResourceLoader(ClassLoader) - Constructor for class net.sourceforge.pmd.util.ResourceLoader: Deprecated.

Constructor for ResourceLoader.
ResourceResolver - Class in net.sourceforge.pmd.util.database
ResourceResolver() - Constructor for class net.sourceforge.pmd.util.database.ResourceResolver
result(SarifLog.Result) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
results(Collection<? extends SarifLog.Result>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
RETURN_TYPE - net.sourceforge.pmd.util.database.DBType.Property
returnSourceCodeObjectsStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: Procedural statement to return list of source code objects.
returnSourceCodeStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: Procedural statement to return source code.
returnType - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata: Types value representing the type returned by DBMSMetadata.callableStatement Currently only java.sql.Types.String and java.sql.Types.Clob are supported
reverse(Iterator<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
rootNode() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder: Returns the root node of the AST.
RootNode - Interface in net.sourceforge.pmd.lang.ast: This interface identifies the root node of an AST.
rule - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation: Deprecated.
rule() - Method in class net.sourceforge.pmd.Report.ConfigurationError: Gets the wrongly configured rule
Rule - Interface in net.sourceforge.pmd: This is the basic Rule interface for PMD rules.
RULE - net.sourceforge.pmd.benchmark.TimedOperationCategory: Rule execution proper.
RULE - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
RULE_AST_INDEXATION - net.sourceforge.pmd.benchmark.TimedOperationCategory
RuleContext - Class in net.sourceforge.pmd: The API for rules to report violations or errors during analysis.
ruleCount() - Method in class net.sourceforge.pmd.RuleSets: Deprecated.

Determines the total count of rules that are used in all rule sets.
RuleFactory - Class in net.sourceforge.pmd.rules: Deprecated.
RuleFactory(ResourceLoader, LanguageRegistry) - Constructor for class net.sourceforge.pmd.rules.RuleFactory: Deprecated.
ruleId(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder: The stable, unique identifier of the rule, if any, to which this result is relevant.
ruleIndex(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder: The index link the rule, if any, to which this result is relevant.
ruleMapper - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
RulePriority - Enum in net.sourceforge.pmd: These are the possible Rule priority values.
RuleReference - Class in net.sourceforge.pmd.lang.rule: This class represents a Rule which is a reference to Rule defined in another RuleSet.
RuleReference(Rule, RuleSetReference) - Constructor for class net.sourceforge.pmd.lang.rule.RuleReference: Create a new reference to the given rule.
rules(List<SarifLog.ReportingDescriptor>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
ruleset(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag.PropertyBagBuilder: The name of the rule set.
RuleSet - Class in net.sourceforge.pmd: This class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files.
RuleSet(RuleSet) - Constructor for class net.sourceforge.pmd.RuleSet
RULESET - Static variable in class net.sourceforge.pmd.util.internal.xml.SchemaConstants
RULESET_2_0_0_NS_URI - Static variable in class net.sourceforge.pmd.RuleSetWriter
rulesetChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache: Deprecated.
RuleSetLoader - Class in net.sourceforge.pmd: Configurable object to load rulesets from XML resources.
RuleSetLoader() - Constructor for class net.sourceforge.pmd.RuleSetLoader: Create a new RuleSetLoader with a default configuration.
RuleSetLoadException - Exception in net.sourceforge.pmd: An exception that is thrown when something wrong occurs while loading rulesets.
RuleSetLoadException(RuleSetReferenceId, Throwable) - Constructor for exception net.sourceforge.pmd.RuleSetLoadException: Constructors are internal.
RuleSetLoadException(RuleSetReferenceId, String) - Constructor for exception net.sourceforge.pmd.RuleSetLoadException: Constructors are internal.
RuleSetReference - Class in net.sourceforge.pmd: Deprecated.
This is part of the internals of the RuleSetLoader.
RuleSetReference(String) - Constructor for class net.sourceforge.pmd.RuleSetReference: Deprecated.
RuleSetReference(String, boolean) - Constructor for class net.sourceforge.pmd.RuleSetReference: Deprecated.
RuleSetReference(String, boolean, Set<String>) - Constructor for class net.sourceforge.pmd.RuleSetReference: Deprecated.
RuleSetReferenceId - Class in net.sourceforge.pmd: Deprecated.
This is part of the internals of the RuleSetLoader.
RuleSetReferenceId(String) - Constructor for class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Construct a RuleSetReferenceId for the given single ID string.
RuleSetReferenceId(String, RuleSetReferenceId) - Constructor for class net.sourceforge.pmd.RuleSetReferenceId: Deprecated.

Construct a RuleSetReferenceId for the given single ID string.
RuleSets - Class in net.sourceforge.pmd: Deprecated.
Internal API
RuleSets(Collection<? extends RuleSet>) - Constructor for class net.sourceforge.pmd.RuleSets: Deprecated.
RuleSets(RuleSet) - Constructor for class net.sourceforge.pmd.RuleSets: Deprecated.

Public constructor.
RuleSets(RuleSets) - Constructor for class net.sourceforge.pmd.RuleSets: Deprecated.

Copy constructor.
RuleSetWriter - Class in net.sourceforge.pmd: This class represents a way to serialize a RuleSet to an XML configuration file.
RuleSetWriter(OutputStream) - Constructor for class net.sourceforge.pmd.RuleSetWriter
RuleTargetSelector - Class in net.sourceforge.pmd.lang.rule: A strategy for selecting nodes that will be targeted by a rule.
RuleViolation - Interface in net.sourceforge.pmd: A RuleViolation is created by a Rule when it identifies a violation of the Rule constraints.
runAndReturnStats() - Method in class net.sourceforge.pmd.PmdAnalysis
runs(List<SarifLog.Run>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.SarifLogBuilder: The set of runs contained in this log file.

S

SarifLog - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.ArtifactLocation - Class in net.sourceforge.pmd.renderers.internal.sarif: Specifies the location of an artifact.
SarifLog.ArtifactLocation.ArtifactLocationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.AssociatedRule - Class in net.sourceforge.pmd.renderers.internal.sarif: A associated rule to the toolConfigurationNotification.
SarifLog.AssociatedRule.AssociatedRuleBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Component - Class in net.sourceforge.pmd.renderers.internal.sarif: A component, such as a plug-in or the driver, of the analysis tool that was run.
SarifLog.Component.ComponentBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Exception - Class in net.sourceforge.pmd.renderers.internal.sarif: A exception information object, for the tool runtime errors.
SarifLog.Exception.ExceptionBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Invocation - Class in net.sourceforge.pmd.renderers.internal.sarif: An invocation component to specify tool invocation details/errors.
SarifLog.Invocation.InvocationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Location - Class in net.sourceforge.pmd.renderers.internal.sarif: A location within a programming artifact.
SarifLog.Location.LocationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Message - Class in net.sourceforge.pmd.renderers.internal.sarif: Encapsulates a message intended to be read by the end user.
SarifLog.Message.MessageBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.MultiformatMessage - Class in net.sourceforge.pmd.renderers.internal.sarif: A message string or message format string rendered in multiple formats.
SarifLog.MultiformatMessage.MultiformatMessageBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.PhysicalLocation - Class in net.sourceforge.pmd.renderers.internal.sarif: A physical location relevant to a result.
SarifLog.PhysicalLocation.PhysicalLocationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.PropertyBag - Class in net.sourceforge.pmd.renderers.internal.sarif: Key/value pairs that provide additional information about the object.
SarifLog.PropertyBag.PropertyBagBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Region - Class in net.sourceforge.pmd.renderers.internal.sarif: A region within an artifact where a result was detected.
SarifLog.Region.RegionBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.ReportingDescriptor - Class in net.sourceforge.pmd.renderers.internal.sarif: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Result - Class in net.sourceforge.pmd.renderers.internal.sarif: A result produced by an analysis tool.
SarifLog.Result.ResultBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Run - Class in net.sourceforge.pmd.renderers.internal.sarif: Describes a single run of an analysis tool, and contains the reported output of that run.
SarifLog.Run.RunBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.SarifLogBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.Tool - Class in net.sourceforge.pmd.renderers.internal.sarif: The analysis tool that was run.
SarifLog.Tool.ToolBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.ToolConfigurationNotification - Class in net.sourceforge.pmd.renderers.internal.sarif: An invocation property to specify tool configuration errors.
SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLog.ToolExecutionNotification - Class in net.sourceforge.pmd.renderers.internal.sarif: An invocation property to specify tool runtime errors.
SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
sarifLogBuilder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
SarifLogBuilder - Class in net.sourceforge.pmd.renderers.internal.sarif
SarifLogBuilder() - Constructor for class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
SarifRenderer - Class in net.sourceforge.pmd.renderers
SarifRenderer() - Constructor for class net.sourceforge.pmd.renderers.SarifRenderer
schema(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.SarifLogBuilder: The URI of the JSON schema corresponding to the version.
SchemaConstant - Class in net.sourceforge.pmd.util.internal.xml: Wraps the name of eg an attribute or element, and provides convenience methods to query the DOM.
SchemaConstant(String) - Constructor for class net.sourceforge.pmd.util.internal.xml.SchemaConstant
SchemaConstants - Class in net.sourceforge.pmd.util.internal.xml: Constants of the ruleset schema.
SCHEMAS - net.sourceforge.pmd.util.database.DBType.Property
scope() - Method in annotation type net.sourceforge.pmd.lang.rule.xpath.NoAttribute: When applied to a type declaration, this value determines which XPath attributes are filtered out.
Scope - Interface in net.sourceforge.pmd.lang.symboltable: A scope is a region within variables and other declarations are visible.
ScopedNode - Interface in net.sourceforge.pmd.lang.symboltable: A Node which knows about the scope within it has been declared.
SCREAMING_SNAKE_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention: SCREAMING_SNAKE_CASE.
SemanticErrorReporter - Interface in net.sourceforge.pmd.lang.ast: Reports errors that occur after parsing.
SemanticException - Exception in net.sourceforge.pmd.lang.ast: An error that occurs after validating a file.
SemanticException() - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
SemanticException(String) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
SemanticException(String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
SemanticException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
sempred(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
serializer() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor: Returns the strategy used to read and write this property to XML.
services() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor: A collection of extension points implemented by the language.
set(DataMap.DataKey<? extends K, ? super T>, T) - Method in class net.sourceforge.pmd.util.DataMap: Set the mapping to the given data.
setAnalysisCache(AnalysisCache) - Method in class net.sourceforge.pmd.PMDConfiguration: Sets the analysis cache to be used.
setAnalysisCacheLocation(String) - Method in class net.sourceforge.pmd.PMDConfiguration: Sets the location of the analysis cache to be used.
setArtifactLocation(SarifLog.ArtifactLocation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation: The location of the artifact.
setAssociatedRule(SarifLog.AssociatedRule) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification: An associated rule
setCharacterSet(String) - Method in class net.sourceforge.pmd.util.database.DBURI
setCharset(Charset) - Method in class net.sourceforge.pmd.lang.document.FileCollector: Sets the charset to use for subsequent calls to FileCollector.addFile(Path) and other overloads using a Path.
setChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode: Set the child at the given index.
setClassLoader(ClassLoader) - Method in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle: Set the classloader to use for analysis.
setClassLoader(ClassLoader) - Method in class net.sourceforge.pmd.PMDConfiguration: Set the ClassLoader being used by PMD when processing Rules.
setContextValue(String, Object) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
setCpdListener(CPDListener) - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
setDataSourceName(String) - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource: Deprecated.
setDbType(DBType) - Method in class net.sourceforge.pmd.util.database.DBURI
setDefaultLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.AbstractConfiguration: Set the given LanguageVersion as the current default for it's Language.
setDefaultLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer: Set the given LanguageVersion as the current default for it's Language.
setDefaultLanguageVersions(List<LanguageVersion>) - Method in class net.sourceforge.pmd.AbstractConfiguration: Set the given LanguageVersions as the current default for their Languages.
setDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
setDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
setDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
setDeprecated(boolean) - Method in interface net.sourceforge.pmd.Rule: Sets whether this Rule is deprecated.
setDescription(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
setDescription(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
setDescription(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
setDescription(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
setDescription(String) - Method in interface net.sourceforge.pmd.renderers.Renderer: Set the description of the Renderer.
setDescription(String) - Method in interface net.sourceforge.pmd.Rule: Set the description of this Rule.
setDriver(SarifLog.Component) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool: The analysis tool that was run.
setDriverClass(String) - Method in class net.sourceforge.pmd.util.database.DBURI
setEncoding(String) - Method in class net.sourceforge.pmd.cpd.XMLRenderer
setEndColumn(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The column number of the character following the end of the region.
setEndLine(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region: The line number of the last character in the region.
setException(SarifLog.Exception) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification: A exception component to detail the tool exception
setExcludes(List<Path>) - Method in class net.sourceforge.pmd.AbstractConfiguration
setExecutionSuccessful(Boolean) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
setExternalInfoUrl(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule: Deprecated.
setExternalInfoUrl(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
setExternalInfoUrl(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
setExternalInfoUrl(String) - Method in interface net.sourceforge.pmd.Rule: Set a URL for external information about this Rule.
setFailOnViolation(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
setFailOnViolation(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration: Sets whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
setFile(Path) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
setFileId(FileId) - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
setFileId(FileId) - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError: Replace the file name of this error.
setFileNameRenderer(FileNameRenderer) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
setFileNameRenderer(FileNameRenderer) - Method in interface net.sourceforge.pmd.renderers.Renderer: Set the FileNameRenderer used to render file paths to the report.
setFileNameRenderer(FileNameRenderer) - Method in interface net.sourceforge.pmd.reporting.ListenerInitializer: Notify this listener that the given FileNameRenderer will be used by default for this analysis.
setFirstToken(JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
setForcedVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
setForceLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.AbstractConfiguration: Set the LanguageVersion specified by the force-language parameter.
setFormat(String) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
setFullDescription(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A description of the report.
setHelp(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
setHelp(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: Provides the primary documentation for the report, useful when there is no online documentation.
setHelpUri(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A URI where the primary documentation for the report can be found.
setId(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location: Value that distinguishes this location from all other locations within a single result object.
setId(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule: The stable, unique identifier of the rule, if any, to which this result is relevant.
setId(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message: The identifier for this message.
setId(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor: A stable, opaque identifier for the report.
setIgnoreAnnotations(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration