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
All Classes All Packages
A
- 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() - Constructor for class net.sourceforge.pmd.AbstractConfiguration
-
Create a new abstract configuration.
- AbstractDelegateRule - Class in net.sourceforge.pmd.lang.rule
-
Deprecated.This is only relevant to
RuleReference
, but prevents sharing the implementation ofAbstractPropertySource
. 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 forRuleViolation
s as source files are processed. - AbstractIncrementingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
- AbstractIterator() - Constructor for class net.sourceforge.pmd.internal.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.
- AbstractLanguage - Class in net.sourceforge.pmd.cpd
- AbstractLanguage(String, String, Tokenizer, String...) - Constructor for class net.sourceforge.pmd.cpd.AbstractLanguage
- 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 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
- AbstractNodeWithTextCoordinates<B extends AbstractNodeWithTextCoordinates<B,T>,T extends GenericNode<T>> - Class in net.sourceforge.pmd.lang.ast.impl
-
Base class for implementations that need fields to store text coordinates.
- AbstractNodeWithTextCoordinates() - Constructor for class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- AbstractPausingIterator() - Constructor for class net.sourceforge.pmd.internal.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
- AbstractPMDProcessor - Class in net.sourceforge.pmd.processor
-
This is internal API!
- 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
- AbstractTokenizer - Class in net.sourceforge.pmd.cpd
-
Deprecated.Use an
AnyTokenizer
instead, it's basically as powerful. - AbstractTokenizer() - Constructor for class net.sourceforge.pmd.cpd.AbstractTokenizer
-
Deprecated.
- AbstractTokenManager - Class in net.sourceforge.pmd.lang.ast
-
A base class for the token managers generated by JavaCC.
- AbstractTokenManager() - Constructor for class net.sourceforge.pmd.lang.ast.AbstractTokenManager
- 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, String) - 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.
- accessor - Variable in class net.sourceforge.pmd.renderers.ColumnDescriptor
-
Deprecated.
- add(Component) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
-
Deprecated.
- add(Component, int) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
-
Deprecated.
- add(File) - Method in class net.sourceforge.pmd.cpd.CPD
- add(List<File>) - Method in class net.sourceforge.pmd.cpd.CPD
- add(SourceCode) - Method in class net.sourceforge.pmd.cpd.CPD
- add(TokenEntry) - Method in class net.sourceforge.pmd.cpd.Tokens
- add(RuleViolation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
- add(DBURI) - Method in class net.sourceforge.pmd.cpd.CPD
- addAllInDirectory(File) - Method in class net.sourceforge.pmd.cpd.CPD
- addAnyChild(T) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
- addAttributesTo(Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
-
Deprecated.
- 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
- addConfiguredParam(Parameter) - Method in class net.sourceforge.pmd.ant.Formatter
- addConfiguredSourceLanguage(SourceLanguage) - Method in class net.sourceforge.pmd.ant.PMDTask
- 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, LanguageVersionHandler, String...) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
-
Adds a version with the given identifier, and sets it as the default.
- addDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a directory recursively using
FileCollector.addFile(Path)
on all regular files. - addDocumentOperation(DocumentOperation) - Method in class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
- addedFile(int, File) - Method in interface net.sourceforge.pmd.cpd.CPDListener
- addedFile(int, File) - Method in class net.sourceforge.pmd.cpd.CPDNullListener
- addedFile(int, File) - 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.
- addExample(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- 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.
- addFileset(FileSet) - Method in class net.sourceforge.pmd.ant.PMDTask
- addFileset(FileSet) - Method in class net.sourceforge.pmd.cpd.CPDTask
- addFormatter(Formatter) - Method in class net.sourceforge.pmd.ant.PMDTask
- 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
- addLabel(String) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
-
Deprecated.
- 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 fromScope.contains(NameOccurrence)
. - addRecursively(File) - Method in class net.sourceforge.pmd.cpd.CPD
- 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(RuleSetWrapper) - Method in class net.sourceforge.pmd.ant.PMDTask
- 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(String, String) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a text file given its contents and a name.
- addSourceFilesToCPD(CPD, CPDConfiguration) - Static method in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
- addText(String) - Method in class net.sourceforge.pmd.ant.RuleSetWrapper
- addTokenEntry(TokenEntry) - Method in class net.sourceforge.pmd.cpd.Match
- addVersion(String, LanguageVersionHandler, boolean) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- addVersion(String, LanguageVersionHandler, String...) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
-
Adds a non-default version with the given identifier.
- 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
-
Opens a zip file and returns a FileSystem for its contents, so it can be explored with the
Path
API. - adjustBeginLineColumn(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Method to adjust line and column numbers for the start of a token.
- AdjustBuffSize() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- advance(Iterator<?>, int) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
-
Advance
n
times. - all(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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
andAbstractNode
. - allMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.internal.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) - Constructor for class net.sourceforge.pmd.cache.AnalysisCacheListener
-
Deprecated.
- analysisFailed(File) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
- analysisFailed(File) - 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(File) - 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, List<RuleViolation>) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult
-
Deprecated.
- AnalysisResult(File) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult
-
Deprecated.
- 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
- AntlrBaseRule - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Base implementation of an antlr rule.
- AntlrBaseRule() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseRule
- 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) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
-
Constructor
- AntlrTokenFilter - Class in net.sourceforge.pmd.cpd.token
-
A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream
- AntlrTokenFilter(AntlrTokenManager) - Constructor for class net.sourceforge.pmd.cpd.token.AntlrTokenFilter
-
Creates a new AntlrTokenFilter
- AntlrTokenManager - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Generic token manager implementation for all Antlr lexers.
- AntlrTokenManager(Lexer, String) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
-
Constructor
- any(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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.
- AnyLanguage - Class in net.sourceforge.pmd.cpd
- AnyLanguage(String...) - Constructor for class net.sourceforge.pmd.cpd.AnyLanguage
- anyMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.internal.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(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
- 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.
- appendXmlEscaped(StringBuilder, String, boolean) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.for removal. Use Java's XML implementations, that do the escaping, use
StringUtil.removedInvalidXml10Characters(String)
for fixing invalid characters in XML 1.0 documents or useStringEscapeUtils#escapeXml10(String)
from apache commons-text instead. - Applier - Class in net.sourceforge.pmd.lang.symboltable
- applies(File) - Method in class net.sourceforge.pmd.RuleSet
-
Check if a given source file should be checked by rules in this RuleSet.
- applies(File) - 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() - Method in class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
- apply(Predicate<E>, Iterator<? extends E>) - Static method in class net.sourceforge.pmd.lang.symboltable.Applier
- apply(Document) - Method in class net.sourceforge.pmd.document.DeleteDocumentOperation
- apply(Document) - Method in class net.sourceforge.pmd.document.DocumentOperation
-
Apply this operation to the specified document
- apply(Document) - Method in class net.sourceforge.pmd.document.InsertDocumentOperation
- apply(Document) - Method in class net.sourceforge.pmd.document.ReplaceDocumentOperation
- apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseRule
- apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
-
Deprecated.
- 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.
- 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
- asCtx(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
-
Cast the argument to a
RuleContext
. - asDelimitedString(T) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.PMD 7.0.0 will use a more powerful scheme to represent values than simple strings, this method won't be general enough
- 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
- asReversed(List<T>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
- AssertionUtil - Class in net.sourceforge.pmd.internal.util
- assertValidJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- assertValidJavaBinaryNameNoArray(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- assertValidStringRange(CharSequence, int, int) - Static method in class net.sourceforge.pmd.internal.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
-
Deprecated.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
-
Deprecated.
- associateByTo(Map<K, V>, Collection<? extends V>, Function<? super V, ? extends K>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- 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
-
Deprecated.
- associateWithTo(Map<K, V>, Collection<? extends K>, Function<? super K, ? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- 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(E) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- asString(E) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- asString(Object[], String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.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(String, LanguageVersion, String, T, Map<Integer, String>) - Constructor for class net.sourceforge.pmd.lang.ast.AstInfo
- AstInfo(Parser.ParserTask, T) - Constructor for class net.sourceforge.pmd.lang.ast.AstInfo
- AstInfo(Parser.ParserTask, T, Map<Integer, String>) - 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, 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.
- attributeName() - Method in enum net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.Returns the String name of this attribute.
- attributeValuesById() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.Will be removed with 7.0.0
- auxClassPathChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
B
- backup(int) - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Pushes a given number of already read chars into the buffer.
- backup(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Retreat.
- 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
- BaseLanguageModule - Class in net.sourceforge.pmd.lang
-
Created by christoferdutz on 21.09.14.
- BaseLanguageModule(String, String, String, String, String...) - Constructor for class net.sourceforge.pmd.lang.BaseLanguageModule
- 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
- beginColumn - Variable in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- beginColumn - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- beginLine - Variable in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- beginLine - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- BeginToken() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Calls
CharStream.readChar()
and returns its value, marking its position as the beginning of the next token. - BeginToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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
- body - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Content
- BODY_PLACEHOLDER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- BOOLEAN - net.sourceforge.pmd.properties.PropertyTypeId
- BOOLEAN_LIST - net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- BooleanMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Not useful, will be removed with 7.0.0
- BooleanMultiProperty(String, String, Boolean[], float) - Constructor for class net.sourceforge.pmd.properties.BooleanMultiProperty
-
Deprecated.Not useful, will be removed with 7.0.0
- BooleanMultiProperty(String, String, List<Boolean>, float) - Constructor for class net.sourceforge.pmd.properties.BooleanMultiProperty
-
Deprecated.Not useful, will be removed with 7.0.0
- BooleanMultiProperty.BooleanMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.Not useful, will be removed with 7.0.0
- booleanProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a boolean property.
- BooleanProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<Boolean>
instead. A builder is available fromPropertyFactory.booleanProperty(String)
and its overloads. This class will be removed in 7.0.0. - BooleanProperty(String, String, boolean, float) - Constructor for class net.sourceforge.pmd.properties.BooleanProperty
-
Deprecated.Use
PropertyFactory.booleanProperty(String)
or its overloads. - BooleanProperty(String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.BooleanProperty
-
Deprecated.Use
PropertyFactory.booleanProperty(String)
or its overloads. - BooleanProperty.BooleanPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.Use
PropertyFactory.booleanProperty(String)
or its overloads. - bufcolumn - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- buffer - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- bufline - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- bufpos - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Position in buffer.
- build() - Method in class net.sourceforge.pmd.properties.BooleanMultiProperty.BooleanMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.BooleanProperty.BooleanPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.Builds the descriptor and returns it.
- build() - Method in class net.sourceforge.pmd.properties.CharacterMultiProperty.CharacterMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.CharacterProperty.CharacterPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.DoubleMultiProperty.DoubleMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.DoubleProperty.DoublePBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty.EnumMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.EnumeratedProperty.EnumPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.FileProperty.FilePBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.FloatMultiProperty.FloatMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.FloatProperty.FloatPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.IntegerMultiProperty.IntegerMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.IntegerProperty.IntegerPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.LongMultiProperty.LongMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.LongProperty.LongPBuilder
-
Deprecated.
- 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.properties.RegexProperty.RegexPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.StringMultiProperty.StringMultiPBuilder
-
Deprecated.
- build() - Method in class net.sourceforge.pmd.properties.StringProperty.StringPBuilder
-
Deprecated.
- 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
- build() - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- build(Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.
- build(Map<PropertyDescriptorField, String>) - Method in interface net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder
-
Deprecated.Builds a descriptor.
- 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
- 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) - 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
- buildUsageText() - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- buildUsageText() - Static method in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
- buildUsageText(JCommander) - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- buildVisitor() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseRule
-
Returns a rule visitor that can visit nodes for the given rule context.
- BY_EXTENSION - Static variable in class net.sourceforge.pmd.cpd.LanguageFactory
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
-
Deprecated.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.
- 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
- CHARACTER - net.sourceforge.pmd.properties.PropertyTypeId
- CHARACTER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
- CharacterMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<Character>>
. A builder is available fromPropertyFactory.charListProperty(String)
. This class will be removed in 7.0.0. - CharacterMultiProperty(String, String, Character[], float, char) - Constructor for class net.sourceforge.pmd.properties.CharacterMultiProperty
-
Deprecated.
- CharacterMultiProperty(String, String, List<Character>, float, char) - Constructor for class net.sourceforge.pmd.properties.CharacterMultiProperty
-
Deprecated.
- CharacterMultiProperty.CharacterMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- CharacterProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<Character>
. A builder is available fromPropertyFactory.charProperty(String)
. This class will be removed in 7.0.0. - CharacterProperty(String, String, Character, float) - Constructor for class net.sourceforge.pmd.properties.CharacterProperty
-
Deprecated.
- CharacterProperty(String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.CharacterProperty
-
Deprecated.
- CharacterProperty.CharacterPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- CHARACTERSET - net.sourceforge.pmd.util.database.DBType.Property
- charFrom(String) - Static method in class net.sourceforge.pmd.properties.CharacterProperty
-
Deprecated.Parses a String into a Character.
- 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.
- CharStream - Interface in net.sourceforge.pmd.lang.ast
-
PMD flavour of character streams used by JavaCC parsers.
- CharStreamFactory - Class in net.sourceforge.pmd.lang.ast.impl.javacc
- check_name - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- checkNumber(T) - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
-
Deprecated.
- ChecksumAware - Interface in net.sourceforge.pmd.cache
-
Deprecated.This is internal API, will be hidden with 7.0.0
- checkValidity(RuleSets, ClassLoader) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
- checkValidity(RuleSets, ClassLoader) - 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) - Method in class net.sourceforge.pmd.cache.FileAnalysisCache
-
Deprecated.
- checkValidity(RuleSets, ClassLoader) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
-
Deprecated.
- checkValue(E) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- 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.
- choiceFrom(String) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- CHOICES - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.Choices for enumerated properties.
- CLASS - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- CLASS_AND_METHOD_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
- className - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- ClasspathClassLoader - Class in net.sourceforge.pmd.util
-
Deprecated.Is internal API
- ClasspathClassLoader(String, ClassLoader) - Constructor for class net.sourceforge.pmd.util.ClasspathClassLoader
-
Deprecated.
- ClasspathClassLoader(List<File>, ClassLoader) - Constructor for class net.sourceforge.pmd.util.ClasspathClassLoader
-
Deprecated.
- clearImages() - Static method in class net.sourceforge.pmd.cpd.TokenEntry
- 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.document.DocumentFile
- close() - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Close registered resources like zip files.
- close() - Method in class net.sourceforge.pmd.PmdAnalysis
- close() - Method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
-
Joins tasks and await completion of the analysis.
- 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 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
- 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.util.IOUtil
-
Deprecated.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.
- 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
- CodeLoader() - Constructor for class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
- coerceWildcard(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
-
Coerce an iterator with a wildcard.
- collect(List<TokenEntry>) - Method in class net.sourceforge.pmd.cpd.MatchCollector
- 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, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- collectFileList(FileCollector, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- collectFiles(String, FilenameFilter) - Static method in class net.sourceforge.pmd.util.FileUtil
-
Deprecated.Collects a list of DataSources using a comma separated list of input file locations to process.
- collectFiles(FileCollector, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- collectFiles(PMDConfiguration, Set<Language>, MessageReporter) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- collectFiles(PMDConfiguration, FileCollector) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- COLLECTION_CLASSES_BY_NAMES - Static variable in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- COLLECTION_INTERFACES_BY_NAMES - Static variable in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- CollectionUtil - Class in net.sourceforge.pmd.util
-
Deprecated.Is internal API
- collectorToDataSource(FileCollector) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
- COLOR - Static variable in class net.sourceforge.pmd.renderers.TextColorRenderer
- column - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- ColumnDescriptor<T> - Class in net.sourceforge.pmd.renderers
-
Deprecated.Is internal API
- ColumnDescriptor(String, String, ColumnDescriptor.Accessor<T>) - Constructor for class net.sourceforge.pmd.renderers.ColumnDescriptor
-
Deprecated.
- ColumnDescriptor.Accessor<T> - Interface in net.sourceforge.pmd.renderers
-
Deprecated.
- columnFromOffset(int) - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
- columnFromOffset(int, int) - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
- columnNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Returns the (1-based) column number of the character at the given index.
- COMMENT_MARKER - Static variable in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- 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(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(JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- compareTo(Language) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- compareTo(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersion
- compareTo(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.Comparing property descriptors is not useful within PMD
- 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.internal.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.internal.util.IteratorUtil
- concatView(List<? extends T>, List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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.
- configuration - Variable in class net.sourceforge.pmd.processor.AbstractPMDProcessor
- 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
- CONSTRUCTOR - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- 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
- contexted(AssertionError) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- contexted(RuntimeException) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- contexted(StackOverflowError) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- ContextedAssertionError - Error in net.sourceforge.pmd.internal.util
-
An
AssertionError
with nice messages. - ContextedStackOverflowError - Error in net.sourceforge.pmd.internal.util
-
A
StackOverflowError
with nice messages. - convert(String) - Method in class net.sourceforge.pmd.cli.PMDParameters.PropertyConverter
-
Deprecated.
- convert(String) - Method in class net.sourceforge.pmd.cli.PMDParameters.RulePriorityConverter
-
Deprecated.
- convert(String) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration.LanguageConverter
- convertTo(StringUtil.CaseConvention, String) - Method in enum net.sourceforge.pmd.util.StringUtil.CaseConvention
-
Deprecated.
- COORDS_COMPARATOR - Static variable in interface net.sourceforge.pmd.lang.ast.Node
- 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.
- copyPropertyValues() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- 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.internal.util.IteratorUtil
-
Counts the items in this iterator, exhausting it.
- CPD - Class in net.sourceforge.pmd.cpd
- CPD(CPDConfiguration) - Constructor for class net.sourceforge.pmd.cpd.CPD
- CPDCommandLineInterface - Class in net.sourceforge.pmd.cpd
- CPDConfiguration - Class in net.sourceforge.pmd.cpd
- CPDConfiguration() - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
- CPDConfiguration.LanguageConverter - Class in net.sourceforge.pmd.cpd
- CPDListener - Interface in net.sourceforge.pmd.cpd
- CPDNullListener - Class in net.sourceforge.pmd.cpd
- CPDNullListener() - Constructor for class net.sourceforge.pmd.cpd.CPDNullListener
- CPDRenderer - Interface in net.sourceforge.pmd.cpd.renderer
- CPDTask - Class in net.sourceforge.pmd.cpd
-
CPDTask
- CPDTask() - Constructor for class net.sourceforge.pmd.cpd.CPDTask
- CPDTask.FormatAttribute - Class in net.sourceforge.pmd.cpd
- 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(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.
- createAuxClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
- createClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
- createErrorNode(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- createFrom(String) - Method in class net.sourceforge.pmd.properties.BooleanMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.BooleanProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.CharacterMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.CharacterProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.DoubleMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.DoubleProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.FileProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.FloatMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.FloatProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.IntegerMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.IntegerProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.LongMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.LongProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.RegexProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.StringMultiProperty
-
Deprecated.
- createFrom(String) - Method in class net.sourceforge.pmd.properties.StringProperty
-
Deprecated.
- createLanguage(String) - Static method in class net.sourceforge.pmd.cpd.LanguageFactory
- createLanguage(String, Properties) - Static method in class net.sourceforge.pmd.cpd.LanguageFactory
- 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
- 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
-
Creates a new token with the given kind.
- createViolation(Rule, Node, String) - Method in class net.sourceforge.pmd.lang.rule.impl.DefaultRuleViolationFactory
- createViolation(Rule, Node, String) - Method in interface net.sourceforge.pmd.lang.rule.RuleViolationFactory
- createWriter() - Static method in class net.sourceforge.pmd.util.IOUtil
-
Deprecated.
- createWriter(String) - Static method in class net.sourceforge.pmd.util.IOUtil
-
Deprecated.Creates a writer that writes to the given file or to stdout.
- createWriter(Charset, String) - Static method in class net.sourceforge.pmd.util.IOUtil
-
Deprecated.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
- 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
- CSVWriter<T> - Class in net.sourceforge.pmd.renderers
-
A generic writer that formats input items into rows and columns per the provided column descriptors.
- CSVWriter(List<ColumnDescriptor<T>>, String, String) - Constructor for class net.sourceforge.pmd.renderers.CSVWriter
- currentToken - Variable in exception net.sourceforge.pmd.lang.ast.ParseException
-
This is the last token that has been consumed successfully.
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
-
Represents a source file to be analyzed.
- 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(String, String, String, int, String, String, String) - Constructor for class net.sourceforge.pmd.util.database.DBURI
-
Create a DBURI from standard individual
URI
components. - declareParserTaskProperties(PropertySource) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Deprecated.This is transitional
- decorateRule(Rule, RuleSetReference, Element) - 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 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 interface net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
-
Deprecated.
- DEFAULT_INDEX - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.Default index for enumerated properties.
- DEFAULT_LANGUAGE - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
- DEFAULT_LINECOUNTPERFILE - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
- DEFAULT_NAME - Static variable in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
- DEFAULT_NAME - Static variable in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
- DEFAULT_NUMERIC_DELIMITER - Static variable in interface net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
-
Deprecated.
- 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 interface net.sourceforge.pmd.cpd.Tokenizer
- DEFAULT_SUPPRESS_MARKER - Static variable in class net.sourceforge.pmd.PMDConfiguration
-
The default suppress marker string.
- DEFAULT_VALUE - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.The default value.
- 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
- defaultInstance() - Static method in class net.sourceforge.pmd.lang.rule.impl.DefaultRuleViolationFactory
-
Returns the default instance (no additional suppressors, creates a ParametricRuleViolation).
- DefaultRuleViolationFactory - Class in net.sourceforge.pmd.lang.rule.impl
-
This is a functional implementation of
RuleViolationFactory
. - DefaultRuleViolationFactory() - Constructor for class net.sourceforge.pmd.lang.rule.impl.DefaultRuleViolationFactory
- defaultValue - Variable in class net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder
-
Deprecated.
- defaultValue() - Method in interface 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(E) - Method in class net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder
-
Deprecated.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) - Method in class net.sourceforge.pmd.properties.RegexProperty.RegexPBuilder
-
Deprecated.Specify a default pattern for the property.
- defaultValue(String, int) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder
-
Specify a default value using a string pattern.
- defaultValue(Collection<? extends V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify a default value.
- defaultValue(T) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Specify a default value.
- defaultValues - Variable in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.
- defaultValues(Collection<? extends V>) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.Specify a default value.
- defaultValues(V...) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.Specify default values.
- defaultValues(V, V...) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify default values.
- defaultVersion - Variable in class net.sourceforge.pmd.lang.BaseLanguageModule
- defensiveUnmodifiableCopy(List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.Returns an unmodifiable copy of the list.
- defineProperty(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- 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.
- delete(RegionByLine) - Method in interface net.sourceforge.pmd.document.Document
-
Delete a region in the document, removing all text which contains it.
- delete(RegionByLine) - Method in class net.sourceforge.pmd.document.DocumentFile
- DeleteDocumentOperation - Class in net.sourceforge.pmd.document
- DeleteDocumentOperation(int, int, int, int) - Constructor for class net.sourceforge.pmd.document.DeleteDocumentOperation
- delim(char) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.Specify a delimiter character.
- delim(char) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Deprecated.PMD 7.0.0 will introduce a new XML syntax for multi-valued properties which will not rely on delimiters. This method is kept until this is implemented for compatibility reasons with the pre-7.0.0 framework, but it will be scrapped come 7.0.0.
- DELIMITER - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.For multi-valued properties, this defines the delimiter of the single values.
- 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.
- desc(String) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.Specify the description of the property.
- 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
-
Returns a string that describes the token kind.
- describeKindImpl(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
-
Describe the given kind.
- description - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- description - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.
- description - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
- description - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- description() - Method in interface 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(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- DESCRIPTION - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.The description of the property.
- 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
- determineFileName(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
-
Determines the filename that should be used in the report depending on the option "shortnames".
- 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".
- diff(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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.internal.util.IteratorUtil
- Document - Interface in net.sourceforge.pmd.document
-
Represents a file which contains programming code that will be fixed.
- DocumentFile - Class in net.sourceforge.pmd.document
-
Implementation that handles a Document as a file in the filesystem and receives operations in a sorted manner (i.e.
- DocumentFile(File, Charset) - Constructor for class net.sourceforge.pmd.document.DocumentFile
- DocumentOperation - Class in net.sourceforge.pmd.document
-
Represents an operation in a document which will be managed by
DocumentOperationsApplierForNonOverlappingRegions
. - DocumentOperation(int, int, int, int) - Constructor for class net.sourceforge.pmd.document.DocumentOperation
- DocumentOperationsApplierForNonOverlappingRegions - Class in net.sourceforge.pmd.document
- DocumentOperationsApplierForNonOverlappingRegions(Document) - Constructor for class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
- doEscape() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- doEscape() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.SimpleCharStream
- done() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
- Done() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Set buffers back to null when finished.
- 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.
- DoubleMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<Double>>
instead. A builder is available fromPropertyFactory.doubleListProperty(String)
. This class will be removed in 7.0.0. - DoubleMultiProperty(String, String, Double, Double, Double[], float) - Constructor for class net.sourceforge.pmd.properties.DoubleMultiProperty
-
Deprecated.
- DoubleMultiProperty(String, String, Double, Double, List<Double>, float) - Constructor for class net.sourceforge.pmd.properties.DoubleMultiProperty
-
Deprecated.
- DoubleMultiProperty.DoubleMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- doubleProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a double property.
- DoubleProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<Double>
instead. A builder is available fromPropertyFactory.doubleProperty(String)
. This class will be removed in 7.0.0. - DoubleProperty(String, String, Double, Double, Double, float) - Constructor for class net.sourceforge.pmd.properties.DoubleProperty
-
Deprecated.
- DoubleProperty(String, String, String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.DoubleProperty
-
Deprecated.
- DoubleProperty.DoublePBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- 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.internal.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
-
Deprecated.
- 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.internal.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 class net.sourceforge.pmd.properties.AbstractPropertySource
- dysfunctionReason() - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Returns a description of why the receiver may be dysfunctional.
- 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
-
Deprecated.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
- emptyDefaultValue() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify that the default value is an empty collection.
- 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(Report) - Method in class net.sourceforge.pmd.ant.Formatter
- 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 - Variable in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- endColumn - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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 - Variable in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- endLine - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- endLine(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder
-
The line number of the last character in the region.
- ensureClosed(List<? extends AutoCloseable>, Exception) - Static method in class net.sourceforge.pmd.util.IOUtil
-
Deprecated.Ensure that the closeables are closed.
- ensureOpen() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
- ensureReadable() - Method in class net.sourceforge.pmd.internal.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
- EnumeratedMultiProperty<E> - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<E>>
instead. A builder is available fromPropertyFactory.enumListProperty(String, Map)
. This class will be removed in 7.0.0. - EnumeratedMultiProperty(String, String, String[], E[], int[], float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- EnumeratedMultiProperty(String, String, String[], E[], int[], Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- EnumeratedMultiProperty(String, String, Map<String, E>, List<E>, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- EnumeratedMultiProperty.EnumMultiPBuilder<E> - Class in net.sourceforge.pmd.properties
-
Deprecated.
- EnumeratedProperty<E> - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<E>
instead. A builder is available fromPropertyFactory.enumProperty(String, Map)
. This class will be removed in 7.0.0. - EnumeratedProperty(String, String, String[], E[], int, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- EnumeratedProperty(String, String, String[], E[], int, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- EnumeratedProperty(String, String, Map<String, E>, E, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- EnumeratedProperty.EnumPBuilder<E> - Class in net.sourceforge.pmd.properties
-
Deprecated.
- EnumeratedPropertyDescriptor<E,T> - Interface in net.sourceforge.pmd.properties
-
Deprecated.Will be removed with 7.0.0. In the future this interface won't exist, but enumerated properties will still be around
- EnumeratedPropertyModule<E> - Class in net.sourceforge.pmd.properties.modules
-
Deprecated.
- EnumeratedPropertyModule(Map<String, E>, Class<E>) - Constructor for class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- 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, 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.cpd.TokenEntry
- 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.PMD
-
Deprecated.
- 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.BaseLanguageModule
- 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.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.FileDataSource
- equals(Object) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
- error(String, Object...) - 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.
- ERROR - net.sourceforge.pmd.PMD.StatusCode
-
Errors were detected, PMD may have not run to the end.
- ERROR_STATUS - Static variable in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- 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
- errorFor(E) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- errorFor(E) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- errorFor(List<E>) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- errorFor(T) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.PMD 7.0.0 will change the return type to
Optional<String>
- errors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
-
Accumulated processing errors.
- escapeJava(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
- escapeWhitespace(Object) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Replace some whitespace characters so they are visually apparent.
- EVALUATION - net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
- 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.
- execute() - Method in class net.sourceforge.pmd.ant.PMDTask
- execute() - Method in class net.sourceforge.pmd.cpd.CPDTask
- 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
- ExpandBuff(boolean) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- ExpandBuff(boolean) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- expandVariables(String) - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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.
- EXTENSION - Static variable in class net.sourceforge.pmd.cpd.LanguageFactory
- extensions - Variable in class net.sourceforge.pmd.lang.BaseLanguageModule
- externalInfoUrl(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- extractParameters(String...) - Static method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Parse an array of CLI parameters and returns a result (which may be failed).
- extractParameters(PMDParameters, String[], String) - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
F
- factoryFor(String) - Static method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- 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.
- FileCodeLoader(File, String) - Constructor for class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
- 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
-
DataSource implementation to read data from a file.
- FileDataSource(File) - Constructor for class net.sourceforge.pmd.util.datasource.FileDataSource
- FileFinder - Class in net.sourceforge.pmd.util
-
Deprecated.Is internal API
- FileFinder() - Constructor for class net.sourceforge.pmd.util.FileFinder
-
Deprecated.
- filename - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- filenameFilter() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- FileProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Will be removed with 7.0.0 with no scheduled replacement
- FileProperty(String, String, File, float) - Constructor for class net.sourceforge.pmd.properties.FileProperty
-
Deprecated.Constructor for file property.
- FileProperty.FilePBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- FileReporter - Class in net.sourceforge.pmd.cpd
-
Deprecated.
CPDRenderer
directly renders to a Writer - FileReporter(File) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
-
Deprecated.
- FileReporter(File, String) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
-
Deprecated.
- FileReporter(String) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
-
Deprecated.
- fileResultsCache - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
- files() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Returns the file collector for the analysed sources.
- FileUtil - Class in net.sourceforge.pmd.util
-
Deprecated.Is internal API
- FillBuff() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- FillBuff() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.internal.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.
- 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.internal.util.IteratorUtil
- 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
-
Returns all languages that support the given extension.
- 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.util.FileFinder
-
Deprecated.Searches for files in a given directory.
- findLanguageByTerseName(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a language from its terse name (eg
"java"
). - findMatches() - Method in class net.sourceforge.pmd.cpd.MatchAlgorithm
- findPatternInFile(File, String) - Static method in class net.sourceforge.pmd.util.FileUtil
-
Deprecated.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
-
Deprecated.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.internal.util.IteratorUtil
- flatMapWithSelf(Iterator<? extends R>, Function<? super R, ? extends Iterator<? extends R>>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
-
Like flatMap, but yields each element of the input iterator before yielding the results of the mapper function.
- FLOAT - net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- FLOAT_LIST - net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- FloatMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<Double>>
instead. A builder is available fromPropertyFactory.doubleListProperty(String)
. This class will be removed in 7.0.0. - FloatMultiProperty(String, String, Float, Float, Float[], float) - Constructor for class net.sourceforge.pmd.properties.FloatMultiProperty
-
Deprecated.
- FloatMultiProperty(String, String, Float, Float, List<Float>, float) - Constructor for class net.sourceforge.pmd.properties.FloatMultiProperty
-
Deprecated.
- FloatMultiProperty.FloatMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- FloatProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use
PropertyFactory.doubleProperty(String)
instead. This class will be removed with 7.0.0. - FloatProperty(String, String, Float, Float, Float, float) - Constructor for class net.sourceforge.pmd.properties.FloatProperty
-
Deprecated.Use
PropertyFactory.doubleProperty(String)
instead. - FloatProperty(String, String, String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.FloatProperty
-
Deprecated.Use
PropertyFactory.doubleProperty(String)
instead. - FloatProperty.FloatPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.Use
PropertyFactory.doubleProperty(String)
instead. - 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.
- 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.
- FormatAttribute() - Constructor for class net.sourceforge.pmd.cpd.CPDTask.FormatAttribute
- Formatter - Class in net.sourceforge.pmd.ant
- Formatter() - Constructor for class net.sourceforge.pmd.ant.Formatter
- 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
- 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.
- 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.
- 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.constraints.PropertyConstraint
-
Builds a new validator from a predicate, and description.
- fullDescription(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
-
A description of the report.
G
- generate(T, Function<? super T, ? extends T>) - Static method in class net.sourceforge.pmd.internal.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 language-independent token such as constants, values language reserved keywords, or comments.
- get(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the element at index n in this stream.
- get(int, T, String) - Method in interface net.sourceforge.pmd.renderers.ColumnDescriptor.Accessor
-
Deprecated.
- 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
- 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.PMDConfiguration
-
Retrieves the currently used analysis cache.
- getArtifactLocation() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
-
The location of the artifact.
- 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
- getAuxclasspath() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getAuxClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
- getAuxclasspathClassLoader() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
Deprecated.
- getBeginColumn() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getBeginColumn() - Method in class net.sourceforge.pmd.cpd.Mark
-
The column number where this duplication begins.
- getBeginColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The column number where this token begins.
- getBeginColumn() - Method in interface net.sourceforge.pmd.document.RegionByLine
- getBeginColumn() - Method in class net.sourceforge.pmd.document.RegionByLineImp
- getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Deprecated.
- getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Gets the column offset from the start of the begin line where the token's region begins
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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.cache.CachedRuleViolation
-
Deprecated.
- getBeginLine() - Method in class net.sourceforge.pmd.cpd.Mark
- getBeginLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- getBeginLine() - Method in interface net.sourceforge.pmd.document.RegionByLine
- getBeginLine() - Method in class net.sourceforge.pmd.document.RegionByLineImp
- getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Deprecated.
- getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Gets the line where the token's region begins
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getBeginLine() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getBeginLine() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the begin line number in the source file in which this violation was identified.
- getCachedViolations(File) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
- getCachedViolations(File) - Method in interface net.sourceforge.pmd.cache.AnalysisCache
-
Deprecated.Retrieves cached violations for the given file.
- getCachedViolations(File) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
-
Deprecated.
- getCacheLocation() - Method in class net.sourceforge.pmd.ant.PMDTask
- getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBType
- getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBURI
- 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.
- 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.
- getChoicesByLabel() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- getClassLoader() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the ClassLoader being used by PMD when processing Rules.
- getClassName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getClassName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getClassName() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the name of the Class in which this violation was identified.
- getClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
- getCode() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
- getCode() - Method in class net.sourceforge.pmd.cpd.SourceCode
- getCodeBuffer() - Method in class net.sourceforge.pmd.cpd.SourceCode
-
Newlines are normalized to \n.
- getCodeSlice(int, int) - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
-
Loads a range of lines.
- getCollectedFiles() - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Returns an unmodifiable list of all files that have been collected.
- getColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Deprecated.
- getColumn() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
- getCommentMarker() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
The suppression marker for comments.
- 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.
- getConstant(String) - Static method in enum net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.
- 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.
- getConstraintDescription() - Method in interface net.sourceforge.pmd.properties.constraints.PropertyConstraint
-
Returns a description of the constraint imposed by this validator on the values.
- 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
- getCPDRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getCPDRendererFromString(String, String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getCurrentValue() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractPausingIterator
- getDataSourceName() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
- 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.
- getDefaultLanguage() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a "default language" known to the service loader.
- 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 class net.sourceforge.pmd.lang.BaseLanguageModule
- getDefaultVersion() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the default language version for this language.
- getDeprecatedOptionsUsed() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Returns a map of deprecated CLI options used by the command that created this instance.
- 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() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a display name for the 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
- getEmptyStrings() - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Returns an empty array of string
- 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.ant.PMDTask
- getEncoding() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getEncoding() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getEncoding() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
- getEncoding() - Method in class net.sourceforge.pmd.cpd.XMLRenderer
- getEndColumn() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getEndColumn() - Method in class net.sourceforge.pmd.cpd.Mark
-
The column number where this duplication ends.
- getEndColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The column number where this token ends.
- getEndColumn() - Method in interface net.sourceforge.pmd.document.RegionByLine
- getEndColumn() - Method in class net.sourceforge.pmd.document.RegionByLineImp
- getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the column number of the last character for the current token.
- getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Gets the column offset from the start of the end line where the token's region ends
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Get end column.
- getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getEndColumn() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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.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
- getEndInDocument() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Exclusive end offset in the source file text.
- getEndInDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getEndLine() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getEndLine() - Method in class net.sourceforge.pmd.cpd.Mark
- getEndLine() - Method in interface net.sourceforge.pmd.document.RegionByLine
- getEndLine() - Method in class net.sourceforge.pmd.document.RegionByLineImp
- getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the line number of the last character for current token.
- getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Gets the line where the token's region ends
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNodeWithTextCoordinates
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Get end line.
- getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getEndLine() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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.RuleViolation
-
Get the end line number in the source file in which this violation was identified.
- getEndOffset() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the end offset of the current token (in the original source), exclusive.
- getEndOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- getEndToken(TokenEntry, Match) - Method in class net.sourceforge.pmd.cpd.Tokens
- getEOF() - Static method in class net.sourceforge.pmd.cpd.TokenEntry
- getErasedType() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
- getError() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Returns the error if parsing failed.
- 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 error net.sourceforge.pmd.internal.util.ContextedAssertionError
- getExceptionContext() - Method in error net.sourceforge.pmd.internal.util.ContextedStackOverflowError
- getExceptionContext() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
- getExcludes() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getExcludes() - Method in class net.sourceforge.pmd.RuleSetReference
-
Deprecated.
- getExecutionSuccessful() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
- getExtensions() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
- getExtensions() - Method in interface net.sourceforge.pmd.cpd.Language
- getExtensions() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- getExtensions() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the list of file extensions associated with this language.
- 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.
- getFactory() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- getFailuresPropertyName() - Method in class net.sourceforge.pmd.ant.PMDTask
- getFile() - Method in class net.sourceforge.pmd.ant.RuleSetWrapper
- getFile() - Method in class net.sourceforge.pmd.Report.ProcessingError
- getFileChecksum() - Method in class net.sourceforge.pmd.cache.AnalysisResult
-
Deprecated.
- getFileDisplayName() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
The display name for where the file comes from.
- 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.
- getFileFilter() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
- getFileFilter() - Method in interface net.sourceforge.pmd.cpd.Language
- getFileInclusions() - Method in class net.sourceforge.pmd.RuleSet
-
Returns the file inclusion patterns as an unmodifiable list.
- getFileListPath() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getFileListPath() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getFilename() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getFilename() - Method in class net.sourceforge.pmd.cpd.Mark
- getFilename() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getFilename() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the source file name in which this violation was identified.
- getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
- getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
- getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode
- getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
- getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
- getFileName() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
- getFileName() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
-
The name of the file in which the error occurred.
- getFileName() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
- getFileName() - Method in class net.sourceforge.pmd.RuleSet
- getFileNameWithoutExtension(String) - Static method in class net.sourceforge.pmd.util.FileUtil
-
Deprecated.Helper method to get a filename without its extension
- getFiles() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getFilesets() - Method in class net.sourceforge.pmd.ant.PMDTask
- 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.
- 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()
. - 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
- getForceLanguage() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getForceLanguageVersion() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the LanguageVersion specified by the force-language parameter.
- getFormat() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getFormattedExceptionMessage(String) - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
- getFormatters() - Method in class net.sourceforge.pmd.ant.PMDTask
- 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 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.
- getIdentifier() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- getIgnoreFilePath() - Method in class net.sourceforge.pmd.PMDConfiguration
- getIgnoreListPath() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getImage() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns the token's text.
- getImage() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- 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.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() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns a string made up of characters from the token mark up to to the current buffer position.
- GetImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- getIndex() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- 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.
- getInputFilePath() - Method in class net.sourceforge.pmd.PMDConfiguration
- getInputPaths() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the comma separated list of input paths to process for source files.
- getInputStream() - Method in interface net.sourceforge.pmd.util.datasource.DataSource
-
Get an InputStream on the source file.
- getInputStream() - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
- getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
-
Convert the Reader into an InputStream.
- getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
- getInputStream(ResourceLoader) - Method in class net.sourceforge.pmd.RuleSetReferenceId
-
Deprecated.Try to load the RuleSet resource with the specified ResourceLoader.
- getInputUri() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the input URI to process for source code objects.
- getInstance() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Deprecated.Use the static methods instead, will be made private
- 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.internal.util.IteratorUtil.AbstractPausingIterator
- 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
- getLabel() - Method in class net.sourceforge.pmd.cpd.Match
- getLabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
- getLabelsByChoice() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- getLanguage() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getLanguage() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- 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(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a language from its full name (eg
"Java"
). - getLanguageFromString(String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getLanguageMetricsProvider() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Returns the metrics provider for this language version, or null if it has none.
- getLanguages() - Static 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
-
Get the Languages of a given source 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 class net.sourceforge.pmd.lang.ast.AstInfo
- getLanguageVersion() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns the language version which should be used to process this file.
- getLanguageVersionDiscoverer() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.
- getLanguageVersionHandler() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Returns the
LanguageVersionHandler
, which provides access to version-specific services, like the parser. - getLanguageVersionOfFile(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
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.
- getLastLine() - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
- getLastLineColumn() - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
- getLastToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getLastToken() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
- getLength() - Method in interface net.sourceforge.pmd.document.RegionByOffset
- getLength() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
- getLexer(CharStream) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
- getLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Deprecated.
- getLine() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
- getLineCount() - Method in class net.sourceforge.pmd.cpd.Mark
- getLineCount() - Method in class net.sourceforge.pmd.cpd.Match
- getLineCount(TokenEntry, Match) - Method in class net.sourceforge.pmd.cpd.Tokens
- getLocation() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence
-
Gets the location where the usage occurred.
- 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
- getLowerLimit() - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
-
Deprecated.
- 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.CPD
- getMatches() - Method in class net.sourceforge.pmd.cpd.MatchCollector
- 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
- getMaxRuleViolations() - Method in class net.sourceforge.pmd.ant.PMDTask
- getMaxTokenType() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
- getMessage() - Method in error net.sourceforge.pmd.internal.util.ContextedAssertionError
- getMessage() - Method in error net.sourceforge.pmd.internal.util.ContextedStackOverflowError
- getMessage() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
- 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.
- getMessageStrings() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
-
A set of name/value pairs with arbitrary names.
- getMethodName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getMethodName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getMethodName() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the method name in which this violation was identified.
- 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.ant.PMDTask
- getMinimumPriority() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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
- getMinimumTileSize() - Method in class net.sourceforge.pmd.cpd.MatchAlgorithm
- getMsg() - Method in class net.sourceforge.pmd.Report.ProcessingError
- getName() - Method in class net.sourceforge.pmd.ant.SourceLanguage
-
This actually corresponds to a
Language.getTerseName()
. - getName() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
- getName() - Method in interface net.sourceforge.pmd.cpd.Language
- getName() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- getName() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the full name of this Language.
- 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.builders.PropertyDescriptorBuilder
-
Deprecated.Returns the name of the property to be built.
- 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
- getNestedRules() - Method in class net.sourceforge.pmd.ant.PMDTask
- 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 interface net.sourceforge.pmd.cpd.token.TokenFilter
-
Retrieves the next token to pass the filter
- 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
-
Return a nice version of the filename.
- getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
- getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
-
Return the dataSourceName via the
DataSource
Interface method. - getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
- 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.
- getNth(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.internal.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)
- 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
- getOffset() - Method in interface net.sourceforge.pmd.document.RegionByOffset
- getOffset() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
- getOffsetAfterEnding() - Method in interface net.sourceforge.pmd.document.RegionByOffset
- getOffsetAfterEnding() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
- 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
- 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 class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getPackageName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getPackageName() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the package name of the Class in which this violation was identified.
- 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
- 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
-
Get the Parser.
- getPathId() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns an identifier for the path of this file.
- 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.
- getProperties() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getProperties() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
Deprecated.
- 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
- 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.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() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
- getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
- getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
- getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
- getReader(String) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
- getRegion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
-
Specifies a portion of the artifact.
- getRegionByLine() - Method in class net.sourceforge.pmd.document.DocumentOperation
- 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
). - getRenderer() - Method in class net.sourceforge.pmd.ant.Formatter
- getRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
-
Deprecated.Use
CPDConfiguration.getCPDRenderer()
instead - getRendererFromString(String, String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
-
Deprecated.
- 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.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.cli.PMDParameters
-
Deprecated.
- getReportFile() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the file to which the report should render.
- getReportFormat() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the report format.
- getReportProperties() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the Report properties.
- getResourceBundleAsProperties(ResourceBundle) - Static method in class net.sourceforge.pmd.util.database.DBType
-
Convert
resourceBundle
to usableProperties
. - 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.
- getRulesetFiles() - Method in class net.sourceforge.pmd.ant.PMDTask
- 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.cli.PMDParameters
-
Deprecated.
- 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.
- getRuleSetsIterator() - Method in class net.sourceforge.pmd.RuleSets
-
Deprecated.
- getRuleViolation() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
- getRuleViolationFactory() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Get the RuleViolationFactory.
- 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 class net.sourceforge.pmd.lang.BaseLanguageModule
- getShortName() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the short name of this language.
- 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.
- getSkipBlocksPattern() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getSlice(int, int) - Method in class net.sourceforge.pmd.cpd.SourceCode
-
Loads a range of lines.
- 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() - Method in class net.sourceforge.pmd.cpd.Mark
-
Newlines are normalized to \n.
- getSourceCodeSlice() - Method in class net.sourceforge.pmd.cpd.Match
-
Newlines are normalized to \n.
- 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
- getSourceDir() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getSourceEncoding() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the character encoding of source files.
- getSourceLanguage() - Method in class net.sourceforge.pmd.ant.PMDTask
- 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.
- getSourcePaths() - Method in class net.sourceforge.pmd.cpd.CPD
-
List names/paths of each source to be processed.
- getSources() - Method in class net.sourceforge.pmd.cpd.CPD
-
Get each Source to be processed.
- getSourceText() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
- 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.renderers.internal.sarif.SarifLog.Region
-
The column number of the first character in the region.
- getStartInDocument() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Inclusive start offset in the source file text.
- getStartInDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- 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 interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the start offset of the current token (in the original source), inclusive.
- getStartOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- 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
- GetSuffix(int) - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns an array of characters that make up the suffix of length 'len' for the current token.
- GetSuffix(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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.AbstractTokenManager
- getSuppressmarker() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getSuppressMarker() - Method in class net.sourceforge.pmd.ant.PMDTask
- getSuppressMarker() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the suppress marker.
- getSuppressor() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
- getSuppressors() - Method in class net.sourceforge.pmd.lang.rule.impl.DefaultRuleViolationFactory
-
Returns a list of additional suppressors for this language.
- getTabSize(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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 class net.sourceforge.pmd.cpd.AbstractLanguage
- getTerseName() - Method in interface net.sourceforge.pmd.cpd.Language
- getTerseName() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- getTerseName() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the terse name of this language.
- 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 class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getText() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode
-
Returns the original source code underlying this node.
- 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.
- getThreads() - Method in class net.sourceforge.pmd.ant.PMDTask
- getThreads() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- getThreads() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the number of threads to use when processing Rules.
- getThrowable() - Method in error net.sourceforge.pmd.internal.util.ContextedAssertionError
- getThrowable() - Method in error net.sourceforge.pmd.internal.util.ContextedStackOverflowError
- getThrowable() - Method in interface net.sourceforge.pmd.internal.util.ExceptionContextDefaultImpl
- getToken() - Method in class net.sourceforge.pmd.cpd.Mark
- 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 interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the token document for the tokens being built.
- getTokenDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- getTokenizer() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
- getTokenizer() - Method in interface net.sourceforge.pmd.cpd.Language
- getTokenKind() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getTokens() - Method in class net.sourceforge.pmd.cpd.Tokens
- getTokenSrcID() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- 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
- getUnlabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
- getUpperLimit() - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
-
Deprecated.
- getUri() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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
- getURI() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- 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.
- 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
- getValueParser() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- getValues() - Method in class net.sourceforge.pmd.cpd.CPDTask.FormatAttribute
- getValueType() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
-
Deprecated.
- getVariableName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
-
Deprecated.
- getVariableName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getVariableName() - Method in interface net.sourceforge.pmd.RuleViolation
-
Get the variable name on which this violation was identified.
- getVariableValue(String) - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- getVersion() - Method in class net.sourceforge.pmd.ant.SourceLanguage
- getVersion() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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 class net.sourceforge.pmd.lang.BaseLanguageModule
- getVersion(String) - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the language version with the given version string.
- getVersions() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- getVersions() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns an ordered list of supported versions for this language.
- 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.
- 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.
- 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
- go() - Method in class net.sourceforge.pmd.cpd.CPD
- GridBagHelper - Class in net.sourceforge.pmd.cpd
-
Deprecated.Is internal API
- GridBagHelper(Container, double[]) - Constructor for class net.sourceforge.pmd.cpd.GridBagHelper
-
Deprecated.
- GROUPING - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- 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.
- 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)
andPropertySource.setProperty(PropertyDescriptor, Object)
. - hasError() - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
-
Returns true if at least one error has been reported.
- hasExtension(String) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- 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.BaseLanguageModule
- 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.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.FileDataSource
- hashCode() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
- hasImageEqualTo(String) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Deprecated.See
Node.getImage()
- hasNext() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
- hasNext() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
- 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.
- hasVersion(String) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
- 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 - Variable in class net.sourceforge.pmd.renderers.ColumnDescriptor
-
Deprecated.
- 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
- ignorableCharacter - Variable in class net.sourceforge.pmd.cpd.AbstractTokenizer
-
Deprecated.
- ignorableStmt - Variable in class net.sourceforge.pmd.cpd.AbstractTokenizer
-
Deprecated.
- IGNORE_ANNOTATIONS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
- IGNORE_IDENTIFIERS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
- IGNORE_LITERALS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
- IGNORE_USINGS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
-
Ignore using directives in C#.
- 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
-
Deprecated.Returns an unmodifiable set containing the given elements.
- immutableSetOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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.
- inBuf - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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.
- 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
andAbstractNode
). - INIT - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- INITIALIZATION - net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
- initialize(RuleSets) - Method in class net.sourceforge.pmd.cache.CachedRuleMapper
-
Deprecated.Initialize the mapper with the given rulesets.
- 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
- inputPathPrefixes - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
- inputStream - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- inRange(N, N) - Static method in class net.sourceforge.pmd.properties.constraints.NumericConstraints
-
Requires the number to be inside a range.
- insert(int, int, String) - Method in interface net.sourceforge.pmd.document.Document
-
Insert a text at a line at the position/column specified.
- insert(int, int, String) - Method in class net.sourceforge.pmd.document.DocumentFile
- 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
- InsertDocumentOperation - Class in net.sourceforge.pmd.document
-
Represents an insert operation in a
Document
. - InsertDocumentOperation(int, int, String) - Constructor for class net.sourceforge.pmd.document.InsertDocumentOperation
- INTEGER - net.sourceforge.pmd.properties.PropertyTypeId
- INTEGER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
- IntegerMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<Integer>>
instead. A builder is available fromPropertyFactory.intListProperty(String)
. This class will be removed in 7.0.0. - IntegerMultiProperty(String, String, Integer, Integer, Integer[], float) - Constructor for class net.sourceforge.pmd.properties.IntegerMultiProperty
-
Deprecated.
- IntegerMultiProperty(String, String, Integer, Integer, List<Integer>, float) - Constructor for class net.sourceforge.pmd.properties.IntegerMultiProperty
-
Deprecated.
- IntegerMultiProperty.IntegerMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- IntegerProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<Integer>
instead. A builder is available fromPropertyFactory.intProperty(String)
. This class will be removed in 7.0.0. - IntegerProperty(String, String, Integer, Integer, Integer, float) - Constructor for class net.sourceforge.pmd.properties.IntegerProperty
-
Deprecated.
- IntegerProperty.IntegerPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- 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
-
Deprecated.Returns the set intersection of the given collections.
- 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.util
-
Deprecated.Is internal API
- 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.
- isBenchmark() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isBenchmark() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Return the benchmark indicator.
- isCollectionType(String, boolean) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.Will be replaced with type resolution
- isDebug() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Return the debug indicator.
- isDebug() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isDefault() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- isDefinedExternally - Variable in class net.sourceforge.pmd.properties.PropertyBuilder
- isDefinedExternally() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.May be removed with 7.0.0
- isDefinedInXML - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.
- 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.
- 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
- isError() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Returns true if parsing failed.
- 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?
- isFailOnError() - Method in class net.sourceforge.pmd.ant.PMDTask
- isFailOnRuleViolation() - Method in class net.sourceforge.pmd.ant.PMDTask
- isFailOnViolation() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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.PMDConfiguration
-
Is the force-language parameter set to anything?
- isHelp() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isHelp() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Returns whether parsing just requested the
--help
text. - 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
- isIgnoreIdentifiers() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreIncrementalAnalysis() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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
- isJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- isJavaIdentifier(CharSequence) - Static method in class net.sourceforge.pmd.internal.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
. - isLoggable(Level) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
- isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.
- isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue
-
Deprecated.
- isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue
-
Deprecated.
- isMultiValue() - Method in interface net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder
-
Deprecated.Whether this descriptor is multi-valued.
- isMultiValue() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.The hard divide between multi- and single-value properties will be removed with 7.0.0
- isNoCache() - Method in class net.sourceforge.pmd.ant.PMDTask
- isNonRecursive() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isNoOutputSupplied() - Method in class net.sourceforge.pmd.ant.Formatter
- isNoRuleSetCompatibility() - Method in class net.sourceforge.pmd.ant.PMDTask
- isNoSkipBlocks() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isOverriddenDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- isProgressBar() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isProgressBar() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Returns whether progress bar indicator should be used.
- isPropertyMultivalue() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- isPropertyNumeric() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- 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.
- isReportShortNames() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get whether to use File short names in Reports.
- 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
-
Deprecated.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.
- isShortFilenames() - Method in class net.sourceforge.pmd.ant.PMDTask
- isShortnames() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isShowsuppressed() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- 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.
- isStress() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isStressTest() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Return the stress test indicator.
- 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(File) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
-
Deprecated.
- isUpToDate(File) - 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(File) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
-
Deprecated.
- isValidJavaPackageName(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
- isVersion() - Method in class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- isVersion() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
-
Returns whether parsing just requested the
--version
text. - iterate(T...) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
- iterator() - Method in class net.sourceforge.pmd.cpd.Match
- iterator() - Method in class net.sourceforge.pmd.cpd.Tokens
- IteratorUtil - Class in net.sourceforge.pmd.internal.util
- IteratorUtil.AbstractIterator<T> - Class in net.sourceforge.pmd.internal.util
- IteratorUtil.AbstractPausingIterator<T> - Class in net.sourceforge.pmd.internal.util
J
- jarName() - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- JavaccToken - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
A generic token implementation for JavaCC parsers.
- JavaccToken(int, CharSequence, 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(String) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
- JavaCCTokenFilter - Class in net.sourceforge.pmd.cpd.token
-
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.token.JavaCCTokenFilter
-
Creates a new JavaCCTokenFilter
- javaCharStream(Reader) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStreamFactory
-
A char stream that translates java unicode sequences.
- javaCharStream(Reader, Function<? super String, ? extends JavaccTokenDocument>) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStreamFactory
-
A char stream that translates java unicode sequences.
- JavaCharStream - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
This stream buffers the whole file in memory before parsing, and track start/end offsets of tokens.
- JavaCharStream(JavaccTokenDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- JavaCharStreamBase - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (with java-like unicode escape processing).
- JavaCharStreamBase(InputStream) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(InputStream, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(InputStream, int, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(InputStream, String) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(InputStream, String, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(InputStream, String, int, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(Reader) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(Reader, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- JavaCharStreamBase(Reader, int, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
-
Constructor.
- 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.
- joinOn(StringBuilder, Iterable<? extends T>, BiConsumer<? super StringBuilder, ? super T>, String) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.Like
String.join(CharSequence, Iterable)
, except it appends on a preexistingStringBuilder
. - 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
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.Match
- LABELS - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.Labels for enumerated properties.
- Language - Interface in net.sourceforge.pmd.cpd
- Language - Interface in net.sourceforge.pmd.lang
-
Represents a language module, and provides access to language-specific functionality.
- LANGUAGE_MODULES_CLASS_NAMES_PROPERTY - Static variable in interface net.sourceforge.pmd.lang.Language
- LANGUAGE_SPECIFIC_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory
-
Subdivided into one label for each stage.
- LanguageConverter() - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration.LanguageConverter
- LanguageFactory - Class in net.sourceforge.pmd.cpd
- 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.
- LanguageRegistry - Class in net.sourceforge.pmd.lang
-
Provides access to the registered PMD languages.
- LANGUAGES - net.sourceforge.pmd.util.database.DBType.Property
- LanguageVersion - Class in net.sourceforge.pmd.lang
-
Represents a version of a
Language
. - LanguageVersion(Language, String, LanguageVersionHandler) - Constructor for class net.sourceforge.pmd.lang.LanguageVersion
-
Deprecated.Use
Language.getVersion(String)
. This is only supposed to be used when initializing aLanguage
instance. - LanguageVersionDiscoverer - Class in net.sourceforge.pmd.lang
-
This class can discover the LanguageVersion of a source file.
- LanguageVersionDiscoverer() - Constructor for class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
- LanguageVersionDiscoverer(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.internal.util.IteratorUtil
- LEGAL_PACKAGES - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.To limit the range of valid values, package names.
- legalPackageNames - Variable in class net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder
-
Deprecated.
- legalPackageNames - Variable in class net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder
-
Deprecated.
- legalPackageNames(String...) - Method in class net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder
-
Deprecated.Specify the allowed package prefixes.
- legalPackageNames(Collection<String>) - Method in class net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder
-
Deprecated.Specify the allowed package prefixes.
- legalPackageNamesIn(Map<PropertyDescriptorField, String>, char) - Static method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.
- legalPackages(String[]) - Method in class net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder
-
Deprecated.
- LENGTH_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
- lengthOfShortestIn(String[]) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Return the length of the shortest string in the array.
- line - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- LINE_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
- lineNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Returns the (1-based) line number of the character at the given index.
- lineNumberFromOffset(int) - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
- lineNumberFromOffset(int) - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
- lines - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
- 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.
- LINK_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
- listOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- listOfNotNull(T) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.
- load() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
- load(int, int) - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
-
Loads a range of lines.
- LOAD_RULES - net.sourceforge.pmd.benchmark.TimedOperationCategory
- loadClass(String, boolean) - Method in class net.sourceforge.pmd.util.ClasspathClassLoader
-
Deprecated.
- 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.
- 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(String, int, int) - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
- 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.
- LongMultiPBuilder(String) - Constructor for class net.sourceforge.pmd.properties.LongMultiProperty.LongMultiPBuilder
-
Deprecated.
- LongMultiProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<List<Long>>
instead. A builder is available fromPropertyFactory.longIntListProperty(String)
. This class will be removed in 7.0.0. - LongMultiProperty(String, String, Long, Long, Long[], float) - Constructor for class net.sourceforge.pmd.properties.LongMultiProperty
-
Deprecated.
- LongMultiProperty(String, String, Long, Long, List<Long>, float) - Constructor for class net.sourceforge.pmd.properties.LongMultiProperty
-
Deprecated.
- LongMultiProperty.LongMultiPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- LongProperty - Class in net.sourceforge.pmd.properties
-
Deprecated.Use a
PropertyDescriptor<Long>
instead. A builder is available fromPropertyFactory.longIntProperty(String)
. This class will be removed in 7.0.0. - LongProperty(String, String, Long, Long, Long, float) - Constructor for class net.sourceforge.pmd.properties.LongProperty
-
Deprecated.
- LongProperty(String, String, String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.LongProperty
-
Deprecated.
- LongProperty.LongPBuilder - Class in net.sourceforge.pmd.properties
-
Deprecated.
- 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.
- lowerLimit - Variable in class net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder
-
Deprecated.
- lowerLimit - Variable in class net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder
-
Deprecated.
- lowerLimit() - Method in interface net.sourceforge.pmd.properties.NumericPropertyDescriptor
-
Deprecated.Returns the minimum value that instances of the property can have.
M
- main(String[]) - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- main(String[]) - Static method in class net.sourceforge.pmd.cpd.CPD
- main(String[]) - Static method in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
- main(String[]) - Static method in class net.sourceforge.pmd.cpd.GUI
- main(String[]) - Static method in class net.sourceforge.pmd.PMD
-
Entry to invoke PMD as command line tool.
- main(String...) - Static method in class net.sourceforge.pmd.util.treeexport.TreeExportCli
- map(Iterable<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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
-
Deprecated.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.internal.util.IteratorUtil
- map(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.Map each element of the given iterator with the given function, and accumulates it into an unmodifiable list.
- map(Collector<? super U, A, ? extends C>, Iterable<? extends T>, Function<? super T, ? extends U>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.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
-
Deprecated.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
-
Deprecated.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.internal.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
-
Deprecated.
- mapNotNull(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
- mappings() - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- mappings() - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- mappings() - Method in interface net.sourceforge.pmd.properties.EnumeratedPropertyDescriptor
-
Deprecated.Returns an immutable map of the label - value mappings defined by this descriptor.
- mappings(Map<String, E>) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty.EnumMultiPBuilder
-
Deprecated.Sets the key-value mappings.
- mappings(Map<String, E>) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty.EnumPBuilder
-
Deprecated.
- Mark - Class in net.sourceforge.pmd.cpd
- Mark(TokenEntry) - Constructor for class net.sourceforge.pmd.cpd.Mark
- 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.
- Match - Class in net.sourceforge.pmd.cpd
- Match(int, Mark, Mark) - Constructor for class net.sourceforge.pmd.cpd.Match
- Match(int, TokenEntry, TokenEntry) - Constructor for class net.sourceforge.pmd.cpd.Match
- MATCH - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- MatchAlgorithm - Class in net.sourceforge.pmd.cpd
- MatchAlgorithm(Map<String, SourceCode>, Tokens, int) - Constructor for class net.sourceforge.pmd.cpd.MatchAlgorithm
- MatchAlgorithm(Map<String, SourceCode>, Tokens, int, CPDListener) - Constructor for class net.sourceforge.pmd.cpd.MatchAlgorithm
- MatchCollector - Class in net.sourceforge.pmd.cpd
- MatchCollector(MatchAlgorithm) - Constructor for class net.sourceforge.pmd.cpd.MatchCollector
- matches() - Method in class net.sourceforge.pmd.cpd.MatchAlgorithm
- MATCHES_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
- max(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
- MAX - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.The maximum allowed value for numeric properties.
- maxCommonLeadingWhitespaceForAll(String[]) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Determine the maximum number of common leading whitespace characters the strings share in the same sequence.
- maximumLanguageVersion(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- maxNextCharInd - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- 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
-
Deprecated.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(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- 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
- 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
- methodName - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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
- MIN - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.The minimum allowed value for numeric properties.
- minimumLanguageVersion(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- multi(ValueParser<U>, char) - Static method in class net.sourceforge.pmd.properties.ValueParserConstants
-
Deprecated.Returns a value parser parsing lists of values of type U.
- 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
- MultiNumericPropertyBuilder<V,T extends MultiNumericPropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.
- MultiNumericPropertyBuilder(String) - Constructor for class net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder
-
Deprecated.
- MultiPackagedPropertyBuilder<V,T extends MultiPackagedPropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.
- MultiPackagedPropertyBuilder(String) - Constructor for class net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder
-
Deprecated.
- MultiValue(Class<V>, ValueParser<V>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue
-
Deprecated.
- multiValueDelimiter - Variable in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.
- multiValueDelimiter() - Method in interface net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
-
Deprecated.
- MultiValuePropertyBuilder<V,T extends MultiValuePropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.
- MultiValuePropertyBuilder(String) - Constructor for class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
-
Deprecated.
- MultiValuePropertyDescriptor<V> - Interface in net.sourceforge.pmd.properties
-
Deprecated.The hard divide between multi- and single-value properties will be removed with 7.0.0
- mustBe(String, Object, String) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
N
- name - Variable in class net.sourceforge.pmd.lang.BaseLanguageModule
- name - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.
- 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 interface 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.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 - net.sourceforge.pmd.properties.PropertyDescriptorField
-
Deprecated.The name of the property.
- 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
- nameAliases() - Method in interface net.sourceforge.pmd.lang.metrics.Metric
-
List of name aliases by which the metric is recognisable.
- named(String) - Static method in class net.sourceforge.pmd.properties.BooleanMultiProperty
-
Deprecated.Not useful, will be removed with 7.0.0
- named(String) - Static method in class net.sourceforge.pmd.properties.BooleanProperty
-
Deprecated.Use
PropertyFactory.booleanProperty(String)
or its overloads. - named(String) - Static method in class net.sourceforge.pmd.properties.CharacterMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.CharacterProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.DoubleMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.DoubleProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.EnumeratedProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.FileProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.FloatMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.FloatProperty
-
Deprecated.Use
PropertyFactory.doubleProperty(String)
instead. - named(String) - Static method in class net.sourceforge.pmd.properties.IntegerMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.IntegerProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.LongMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.LongProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.RegexProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.StringMultiProperty
-
Deprecated.
- named(String) - Static method in class net.sourceforge.pmd.properties.StringProperty
-
Deprecated.
- 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.ant - package net.sourceforge.pmd.ant
- 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.cli - package net.sourceforge.pmd.cli
- net.sourceforge.pmd.cpd - package net.sourceforge.pmd.cpd
- net.sourceforge.pmd.cpd.renderer - package net.sourceforge.pmd.cpd.renderer
- net.sourceforge.pmd.cpd.token - package net.sourceforge.pmd.cpd.token
- net.sourceforge.pmd.document - package net.sourceforge.pmd.document
- 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
- 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.impl - package net.sourceforge.pmd.lang.rule.impl
- 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.processor - package net.sourceforge.pmd.processor
- net.sourceforge.pmd.properties - package net.sourceforge.pmd.properties
- net.sourceforge.pmd.properties.builders - package net.sourceforge.pmd.properties.builders
- net.sourceforge.pmd.properties.constraints - package net.sourceforge.pmd.properties.constraints
- net.sourceforge.pmd.properties.modules - package net.sourceforge.pmd.properties.modules
- 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.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 class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.
- newCharStream(JavaccTokenDocument) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- 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
- newDocument(String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- newFileProcessor(PMDConfiguration) - Static method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
-
Returns a new file processor.
- 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.
- newListener(Project, List<String>) - Method in class net.sourceforge.pmd.ant.Formatter
- 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)
. - 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.internal.util.IteratorUtil.AbstractIterator
- next() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractPausingIterator
- next() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
- nextCharBuf - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- nextCharInd - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- nextRow() - Method in class net.sourceforge.pmd.cpd.GridBagHelper
-
Deprecated.
- NO - net.sourceforge.pmd.util.OptionalBool
- NO_ERRORS_STATUS - Static variable in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- NO_EXIT_AFTER_RUN - Static variable in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.This is used for testing, but support for it will be removed in PMD 7. Use
PMD.runPmd(String...)
or an overload to avoid exiting the VM. In PMD 7,PMD.main(String[])
will callSystem.exit(int)
always. - NO_EXIT_AFTER_RUN - Static variable in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
- NO_FILE_NAME - Static variable in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
-
Default value of
FileAnalysisException.getFileName()
. - 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
-
Deprecated.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.internal.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.
- 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.
- normalizeFilename(String) - Static method in class net.sourceforge.pmd.util.FileUtil
-
Deprecated.Normalizes the filename by taking the casing into account, e.g.
- NULL_CHARACTER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- Numeric(Class<V>, ValueParser<V>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric
-
Deprecated.
- Numeric(Class<V>, ValueParser<V>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric
-
Deprecated.
- NumericConstraints - Class in net.sourceforge.pmd.properties.constraints
-
Common constraints for properties dealing with numbers.
- NumericPropertyDescriptor<T> - Interface in net.sourceforge.pmd.properties
-
Deprecated.Will be removed with 7.0.0. In the future this interface won't exist, but numeric properties will still be around
- NumericPropertyModule<T extends Number> - Class in net.sourceforge.pmd.properties.modules
-
Deprecated.
- NumericPropertyModule(T, T) - Constructor for class net.sourceforge.pmd.properties.modules.NumericPropertyModule
-
Deprecated.
- 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.
- OK - net.sourceforge.pmd.PMD.StatusCode
-
No errors, no violations.
- 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.
- oneLineCommentChar - Variable in class net.sourceforge.pmd.cpd.AbstractTokenizer
-
Deprecated.
- 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.
- 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() - 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
- OPTION_IGNORE_LITERAL_SEQUENCES - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
-
Ignore sequences of literals (e.g,
0,0,0,0...
). - OPTION_SKIP_BLOCKS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
-
Enables or disabled skipping of blocks like a pre-processor.
- OPTION_SKIP_BLOCKS_PATTERN - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
-
Configures the pattern, to find the blocks to skip.
- 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
- overridePropertiesFromEnv(String, PropertySource) - Method in class net.sourceforge.pmd.lang.AbstractPmdLanguageVersionHandler
-
Deprecated.
P
- Packaged(Class<E>, ValueParser<E>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged
-
Deprecated.
- Packaged(Class<V>, ValueParser<V>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged
-
Deprecated.
- packageName - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- ParametricRuleViolation<T extends Node> - Class in net.sourceforge.pmd.lang.rule
-
Deprecated.This is internal. Clients should exclusively use
RuleViolation
. - ParametricRuleViolation(Rule, T, String) - Constructor for class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
-
Deprecated.
- 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() - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
- 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(String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
- ParseException(String, JavaccToken) - 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
- parseProperties(TreeExportCli, TreeRendererDescriptor) - Static method in class net.sourceforge.pmd.util.treeexport.TreeExportCli
- parser - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue
-
Deprecated.
- parser - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue
-
Deprecated.
- 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(LanguageVersion, String, String, SemanticErrorReporter) - Constructor for class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- ParserTask(LanguageVersion, String, String, SemanticErrorReporter, ClassLoader) - Constructor for class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- PASCAL_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention
-
Deprecated.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.internal.util.IteratorUtil
- 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
-
Deprecated.Formats a double to a percentage, keeping
numDecimal
decimal places. - performAnalysis() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Run PMD with the current state of this instance.
- 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.
- plus(Map<K, V>, K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Deprecated.Produce a new map with the mappings of the first, and one additional mapping.
- PMD - Class in net.sourceforge.pmd
-
Entry point for PMD's CLI.
- PMD.StatusCode - Enum in net.sourceforge.pmd
-
Represents status codes that are used as exit codes during CLI runs.
- PmdAnalysis - Class in net.sourceforge.pmd
-
Main programmatic API of PMD.
- PMDCommandLineInterface - Class in net.sourceforge.pmd.cli
-
Deprecated.Internal API. Use
PMD.runPmd(String...)
orPMD.main(String[])
, orPmdParametersParseResult
if you just want to produce a configuration. - 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
- PMDParameters - Class in net.sourceforge.pmd.cli
-
Deprecated.Internal API. Use
PMD.runPmd(String[])
orPMD.main(String[])
- PMDParameters() - Constructor for class net.sourceforge.pmd.cli.PMDParameters
-
Deprecated.
- PMDParameters.PropertyConverter - Class in net.sourceforge.pmd.cli
-
Deprecated.
- PMDParameters.RulePriorityConverter - Class in net.sourceforge.pmd.cli
-
Deprecated.Will be removed in 7.0.0
- PMDParameters.RulePriorityValidator - Class in net.sourceforge.pmd.cli
-
Deprecated.
- PmdParametersParseResult - Class in net.sourceforge.pmd.cli
-
Result of parsing a bunch of CLI arguments.
- PMDTask - Class in net.sourceforge.pmd.ant
- PMDTask() - Constructor for class net.sourceforge.pmd.ant.PMDTask
- 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.
- 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.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric
-
Deprecated.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged
-
Deprecated.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue
-
Deprecated.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.Populates the builder with extracted fields.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric
-
Deprecated.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged
-
Deprecated.
- populate(T, Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue
-
Deprecated.
- positive() - Static method in class net.sourceforge.pmd.properties.constraints.NumericConstraints
-
Requires the number to be strictly positive.
- postContruct() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- 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
. - preferredRowCount() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.Was never implemented, and is none of the descriptor's concern. Will be removed with 7.0.0
- prepareViewOn(T) - Method in class net.sourceforge.pmd.internal.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 checkedIOException
- prevCharIsCR - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- prevCharIsLF - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- previousSpecials(JavaccToken) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns an iterable that enumerates all special tokens belonging to the given token.
- printJcommanderUsageOnConsole() - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- priority(int) - Method in class net.sourceforge.pmd.rules.RuleBuilder
-
Deprecated.
- priority(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag.PropertyBagBuilder
-
The pmd priority of the rule.
- processFiles(PMDConfiguration, List<RuleSet>, Collection<? extends DataSource>, List<Renderer>) - Static method in class net.sourceforge.pmd.PMD
-
Deprecated.Use
PmdAnalysis
- processFiles(RuleSets, List<DataSource>, GlobalAnalysisListener) - Method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
-
Analyse all files.
- ProcessingError(Throwable, String) - Constructor for class net.sourceforge.pmd.Report.ProcessingError
-
Creates a new processing error
- produceRenderer(PropertySource) - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
-
Builds a new renderer from the given properties.
- PROG_NAME - Static variable in class net.sourceforge.pmd.cli.PMDCommandLineInterface
-
Deprecated.
- 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.
- PropertyBuilder<B extends PropertyBuilder<B,T>,T> - Class in net.sourceforge.pmd.properties
-
Base class for generic property builders.
- PropertyBuilder.GenericCollectionPropertyBuilder<V,C extends Collection<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.constraints
-
Validates the value of a property.
- PropertyConverter() - Constructor for class net.sourceforge.pmd.cli.PMDParameters.PropertyConverter
-
Deprecated.
- PropertyDescriptor<T> - Interface in net.sourceforge.pmd.properties
-
Property value descriptor that defines the use & requirements for setting property values for use within PMD and any associated GUIs.
- PropertyDescriptorBuilder<E,T extends PropertyDescriptorBuilder<E,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.From 7.0.0 on, the only supported way to build properties will be through
PropertyFactory
. This class hierarchy is replaced by the newerPropertyBuilder
. - PropertyDescriptorBuilder(String) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
-
Deprecated.
- PropertyDescriptorBuilderConversionWrapper<E,T extends PropertyDescriptorBuilder<E,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.This was not public API and will be removed by 7.0.0
- PropertyDescriptorBuilderConversionWrapper(Class<?>) - Constructor for class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
-
Deprecated.
- PropertyDescriptorBuilderConversionWrapper.MultiValue<V,T extends MultiValuePropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For multi-value properties.
- PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<V,T extends MultiNumericPropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For multi-value numeric properties.
- PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged<V,T extends MultiPackagedPropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For multi-value packaged properties.
- PropertyDescriptorBuilderConversionWrapper.SingleValue<E,T extends SingleValuePropertyBuilder<E,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For single-value properties.
- PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<V,T extends SingleNumericPropertyBuilder<V,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For single-value numeric properties.
- PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged<E,T extends SinglePackagedPropertyBuilder<E,T>> - Class in net.sourceforge.pmd.properties.builders
-
Deprecated.For single-value packaged properties.
- PropertyDescriptorExternalBuilder<E> - Interface in net.sourceforge.pmd.properties.builders
-
Deprecated.
- PropertyDescriptorField - Enum in net.sourceforge.pmd.properties
-
Deprecated.Will be removed with 7.0.0
- propertyDescriptors - Variable in class net.sourceforge.pmd.properties.AbstractPropertySource
-
Deprecated.Will be made private final
- propertyErrorFor(Rule) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
-
Deprecated.Used nowhere, and fails if the rule doesn't define the property descriptor A better solution will be added on property source
- PropertyFactory - Class in net.sourceforge.pmd.properties
-
Provides factory methods for common property types.
- 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.
- propertyValuesByDescriptor - Variable in class net.sourceforge.pmd.properties.AbstractPropertySource
-
Deprecated.Will be made private final
- propertyValueType() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
-
Deprecated.
- 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
- quoteMessageFormat(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Deprecated.Escape the string so that it appears literally when interpreted by a
MessageFormat
.
R
- range(JavaccToken, JavaccToken) - 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).
- range(V, V) - Method in class net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder
-
Deprecated.Specify the range of acceptable values.
- range(V, V) - Method in class net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder
-
Deprecated.Specify the range of acceptable values.
- ReadByte() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStream
- ReadByte() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- readChar() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
-
Returns the next character from the input.
- readChar() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaCharStreamBase
- readContents() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Reads the contents of the underlying character source.
- ReaderCodeLoader(Reader) - Constructor for class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
- ReaderCodeLoader(Reader, String) - Constructor for class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
- ReaderDataSource - Class in net.sourceforge.pmd.util.datasource
-
DataSource implementation to read data from a Reader.
- ReaderDataSource(Reader, String) - Constructor for class net.sourceforge.pmd.util.datasource.ReaderDataSource
-
Create the DataSource from the Reader.
- readFilelist(File) - Static method in class net.sourceforge.pmd.util.FileUtil
-
Deprecated.Reads the file, which contains the filelist.