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
All Classes All Packages
A
- abortEscape(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
- above(N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints
-
Requires the number to be greater than a lower bound.
- absorb(FileCollector) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add all files collected in the other collector into this one.
- AbstractAccumulatingRenderer - Class in net.sourceforge.pmd.renderers
-
Abstract base class for
Renderer
implementations which only produce output once all source files are processed. - AbstractAccumulatingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
- AbstractConfiguration - Class in net.sourceforge.pmd
-
Base configuration class for both PMD and CPD.
- AbstractConfiguration(LanguageRegistry, PmdReporter) - Constructor for class net.sourceforge.pmd.AbstractConfiguration
- 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.util.IteratorUtil.AbstractIterator
- AbstractJjtreeNode<B extends AbstractJjtreeNode<B,N>,N extends JjtreeNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
Base class for node produced by JJTree.
- AbstractJjtreeNode(int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
-
The id is an index in the constant names array generated by jjtree, it must be set to some value that depends on the node type, not some arbitrary "1" or "2", and not necessarily a unique value.
- AbstractLanguageVersionHandler - Class in net.sourceforge.pmd.lang
-
This is a generic implementation of the LanguageVersionHandler interface.
- AbstractLanguageVersionHandler() - Constructor for class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
- AbstractNameDeclaration - Class in net.sourceforge.pmd.lang.symboltable
-
Base class for all name declarations.
- AbstractNameDeclaration(ScopedNode) - Constructor for class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
- AbstractNode<B extends AbstractNode<B,N>,N extends Node & GenericNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl
-
Base class for implementations of the Node interface whose children are stored in an array.
- AbstractNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- AbstractPausingIterator() - Constructor for class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- AbstractPmdLanguageVersionHandler - Class in net.sourceforge.pmd.lang
-
Base language version handler for languages that support PMD, i.e.
- AbstractPmdLanguageVersionHandler() - Constructor for class net.sourceforge.pmd.lang.AbstractPmdLanguageVersionHandler
- AbstractPropertySource - Class in net.sourceforge.pmd.properties
-
Base class for
PropertySource
. - AbstractPropertySource() - Constructor for class net.sourceforge.pmd.properties.AbstractPropertySource
- AbstractRenderer - Class in net.sourceforge.pmd.renderers
-
Abstract base class for
Renderer
implementations. - AbstractRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractRenderer
- AbstractRule - Class in net.sourceforge.pmd.lang.rule
-
Basic abstract implementation of all parser-independent methods of the Rule interface.
- AbstractRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractRule
- AbstractScope - Class in net.sourceforge.pmd.lang.symboltable
-
Base class for any
Scope
. - AbstractScope() - Constructor for class net.sourceforge.pmd.lang.symboltable.AbstractScope
- AbstractTokenManager - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
A base class for the token managers generated by JavaCC.
- AbstractTokenManager() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
- AbstractVisitorRule - Class in net.sourceforge.pmd.lang.rule
- AbstractVisitorRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractVisitorRule
- 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.
- addAllVersionsOf(Language) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Add all the versions of the given language, including the default version.
- addAnyChild(T) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
- addChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
-
Set the child at the given index to the given node.
- addChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- addDeclaration(NameDeclaration) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- addDeclaration(NameDeclaration) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Adds a new declaration to this scope.
- addDefaultVersion(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Add a new version by its name and make it the default version.
- addDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a directory recursively using
FileCollector.addFile(Path)
on all regular files. - addDirectory(Path, boolean) - Method in class net.sourceforge.pmd.lang.document.FileCollector
- addedFile(int) - Method in interface net.sourceforge.pmd.cpd.CPDListener
- addedFile(int) - Method in class net.sourceforge.pmd.cpd.CPDNullListener
- addedFile(int) - Method in class net.sourceforge.pmd.cpd.GUI
- addExample(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- addExample(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Add a single example for this Rule.
- addExample(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- addFile(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a file, language is determined automatically from the extension/file patterns.
- addFile(Path, Language) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a file with the given language (which overrides the file patterns).
- addFile(TextFile) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a pre-configured text file.
- addFileOrDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a file or directory recursively.
- addFileOrDirectory(Path, boolean) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a file or directory recursively.
- addInputPath(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Add an input path.
- AdditionalInfo(String) - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
- AdditionalInfo(String, String) - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
- addListener(GlobalAnalysisListener) - Method in class net.sourceforge.pmd.PmdAnalysis
-
Add a new listener.
- addListeners(Collection<? extends GlobalAnalysisListener>) - Method in class net.sourceforge.pmd.PmdAnalysis
-
Add several listeners at once.
- addNameOccurrence(NameOccurrence) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- addNameOccurrence(NameOccurrence) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Adds a
NameOccurrence
to this scope - only call this after getting a true back fromScope.contains(NameOccurrence)
. - addRelativizeRoot(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the path used to shorten paths output in the report.
- addRelativizeRoot(Path) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- addRelativizeRoots(List<Path>) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Add several paths to shorten paths that are output in the report.
- addRelativizeRoots(List<Path>) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- 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.
- addRuleName(String) - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
- addRuleSet(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Add a new ruleset paths to load when starting the analysis.
- addRuleSet(RuleSet) - Method in class net.sourceforge.pmd.PmdAnalysis
-
Add a new ruleset.
- addRuleSets(Collection<RuleSet>) - Method in class net.sourceforge.pmd.PmdAnalysis
-
Add several rulesets at once.
- addSourceFile(FileId, String) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Add a text file given its contents and a name.
- addVersion(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Add a new version by its name.
- addViolation(Node) - Method in class net.sourceforge.pmd.reporting.RuleContext
-
Record a new violation of the contextual rule, at the given node.
- addViolation(Node, Object...) - Method in class net.sourceforge.pmd.reporting.RuleContext
-
Record a new violation of the contextual rule, at the given node.
- addViolationWithMessage(Node, String) - Method in class net.sourceforge.pmd.reporting.RuleContext
-
Record a new violation of the contextual rule, at the given node.
- addViolationWithMessage(Node, String, Object...) - Method in class net.sourceforge.pmd.reporting.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.reporting.RuleContext
-
Record a new violation of the contextual rule, at the given node.
- addZipFileWithContent(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Opens a zip file and adds all files of the zip file to the list of files to be processed.
- advance(Iterator<?>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Advance
n
times. - all(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns true if all elements of the iterable match the predicate.
- all(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns whether all elements of this stream match the provided predicate.
- ALL - net.sourceforge.pmd.lang.rule.xpath.NoAttribute.NoAttrScope
-
All attributes are suppressed, except those from
Node
andAbstractNode
. - allMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Returns whether all elements match the predicate.
- ANALYSIS_CACHE - net.sourceforge.pmd.benchmark.TimedOperationCategory
- analyzeToken(T) - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
-
Extension point for subclasses to analyze all tokens (before filtering) and update internal status to decide on custom discard rules.
- analyzeTokens(T, Iterable<T>) - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
-
Extension point for subclasses to analyze all tokens (before filtering) and update internal status to decide on custom discard rules.
- ancestors() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- ancestors() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing all the strict ancestors of this node, in innermost to outermost order.
- ancestors() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the ancestors of the nodes contained in this stream.
- ancestors(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the ancestor stream of this node filtered by the given node type.
- ancestors(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the ancestor stream of each node in this stream, filtered by the given node type.
- ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing this node and its ancestors.
- ancestorsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing the nodes contained in this stream and their ancestors.
- AntlrBaseParser<N extends AntlrNode<N>,R extends BaseAntlrInnerNode<N> & RootNode> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Generic Antlr parser adapter for all Antlr parsers.
- AntlrBaseParser() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
- AntlrCpdLexer - Class in net.sourceforge.pmd.cpd.impl
-
Generic implementation of a
CpdLexer
useful to any Antlr grammar. - AntlrCpdLexer() - Constructor for class net.sourceforge.pmd.cpd.impl.AntlrCpdLexer
- AntlrErrorPmdAdapter(BaseAntlrTerminalNode<N>, Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrErrorPmdAdapter
- AntlrGeneratedParserBase<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
This is the base class for antlr generated parsers.
- AntlrGeneratedParserBase(TokenStream) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- AntlrNameDictionary - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Stores the XPath name of antlr terminals.
- AntlrNameDictionary(Vocabulary, String[]) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
- AntlrNode<N extends AntlrNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Base interface for all Antlr-based implementation of the Node interface.
- AntlrTerminalPmdAdapter(BaseAntlrTerminalNode<N>, Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrTerminalPmdAdapter
- AntlrToken - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Generic Antlr representation of a token.
- AntlrToken(Token, AntlrToken, TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
-
Constructor
- AntlrTokenFilter - Class in net.sourceforge.pmd.cpd.impl
-
A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream
- AntlrTokenFilter(TokenManager<AntlrToken>) - Constructor for class net.sourceforge.pmd.cpd.impl.AntlrTokenFilter
-
Creates a new AntlrTokenFilter
- AntlrTokenManager - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Generic token manager implementation for all Antlr lexers.
- AntlrTokenManager(Lexer, TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
- any(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns true if any element of the iterable matches the predicate.
- any(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns whether any elements of this stream match the provided predicate.
- AnyCpdLexer - Class in net.sourceforge.pmd.cpd
-
Simple tokenization into words and separators.
- AnyCpdLexer() - Constructor for class net.sourceforge.pmd.cpd.AnyCpdLexer
- AnyCpdLexer(String) - Constructor for class net.sourceforge.pmd.cpd.AnyCpdLexer
- anyMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Returns whether some element match the predicate.
- append(StringBuilder, CharSequence) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Like
StringBuilder.append(CharSequence)
, but uses an optimized implementation if the charsequence happens to be aChars
. - append(NodeStream<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a new node stream that contains all the elements of this stream, then all the elements of the given stream.
- appendBoundaryForNodeLn(Node, Appendable, String) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
- appendChars(StringBuilder) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Append this character sequence on the given stringbuilder.
- appendChars(StringBuilder, int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Appends the character range identified by start and end offset into the string builder.
- appendIndent(Appendable, String, boolean) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
- appendNodeInfoLn(Appendable, Node) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
-
Append info about the node.
- appendSuffix(StringBuilder, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Appends the suffix of length 'len' of the current token to the given string builder.
- Applier - Class in net.sourceforge.pmd.lang.symboltable
- apply(Predicate<E>, Iterator<? extends E>) - Static method in class net.sourceforge.pmd.lang.symboltable.Applier
- apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractVisitorRule
- apply(Node, RuleContext) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Process the given node.
- apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- apply(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.xpath.XPathRule
- apply(ViolationDecorator, Node) - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator
- asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
- asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- asAntlrNode() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- asChildOf(FileId, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a file ID whose methods behave the same as the first parameter, and whose
FileId.getParentFsPath()
returns the second parameter. - asCtx(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
-
Cast the argument to a
RuleContext
. - asInstanceOf(Class<? extends O>, Class<? extends O>...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a map function, that checks whether the parameter is an instance of any of the given classes.
- asPmdNode(RuleContext) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- asReadOnly() - Method in class net.sourceforge.pmd.lang.document.TextFileBuilder
-
Specify that the built file is read only.
- asReversed(List<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- AssertionUtil - Class in net.sourceforge.pmd.util
- assertValidJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- assertValidJavaBinaryNameNoArray(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- assertValidStringRange(CharSequence, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
-
Like
AssertionUtil.validateStringRange(CharSequence, int, int)
but eliminated at runtime if running without assertions. - asSingle(Set<T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
If the set has a single element, returns it, otherwise returns null.
- associateBy(Collection<? extends V>, Function<? super V, ? extends K>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- associateByTo(Map<K, V>, Collection<? extends V>, Function<? super V, ? extends K>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- associateWith(Collection<? extends K>, Function<? super K, ? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- associateWithTo(Map<K, V>, Collection<? extends K>, Function<? super K, ? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- asStream() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- asStream() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing only this node.
- asString(Object[], String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Formats all items onto a string with separators if more than one exists, return an empty string if the items are null or empty.
- AstInfo<T extends RootNode> - Class in net.sourceforge.pmd.lang.ast
-
The output of
Parser.parse(ParserTask)
. - AstInfo(Parser.ParserTask, T) - Constructor for class net.sourceforge.pmd.lang.ast.AstInfo
- AstVisitor<P,R> - Interface in net.sourceforge.pmd.lang.ast
-
Root interface for AST visitors.
- AstVisitorBase<P,R> - Class in net.sourceforge.pmd.lang.ast
-
Base implementation of
AstVisitor
, that performs a top-down (preorder) visit and may accumulate a result. - AstVisitorBase() - Constructor for class net.sourceforge.pmd.lang.ast.AstVisitorBase
- Attribute - Class in net.sourceforge.pmd.lang.rule.xpath
-
Represents an XPath attribute of a specific node.
- Attribute(Node, String, MethodHandle, Method) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Creates a new attribute belonging to the given node using its accessor.
- Attribute(Node, String, String) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Creates a new attribute belonging to the given node using its string value.
- AttributeAxisIterator - Class in net.sourceforge.pmd.lang.rule.xpath.impl
-
Explores an AST node reflectively to iterate over its XPath attributes.
- AttributeAxisIterator(Node) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
-
Creates a new iterator that enumerates the attributes of the given node.
- AUX_CLASSPATH - Static variable in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
- availableInXPath(boolean) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
If true, the property will be made available to XPath queries as an XPath variable.
B
- BackslashEscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
A base class for readers that handle escapes starting with a backslash.
- BackslashEscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
- backup(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Pushes a given number of already read chars into the buffer.
- BaseAntlrErrorNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
- BaseAntlrErrorNode(Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
- BaseAntlrInnerNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Base class for the inner nodes (corresponds to
ParserRuleContext
). - BaseAntlrInnerNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- BaseAntlrInnerNode(ParserRuleContext, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
- BaseAntlrNode<A extends BaseAntlrNode.AntlrToPmdParseTreeAdapter<N>,N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Base class for an antlr node.
- BaseAntlrNode() - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- BaseAntlrNode.AntlrToPmdParseTreeAdapter<N extends AntlrNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.antlr4
- BaseAntlrTerminalNode<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
-
Base class for terminal nodes (they wrap a
TerminalNode
). - BaseAntlrTerminalNode(Token) - Constructor for class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- BaseAntlrTerminalNode.AntlrErrorPmdAdapter<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
- BaseAntlrTerminalNode.AntlrTerminalPmdAdapter<N extends AntlrNode<N>> - Class in net.sourceforge.pmd.lang.ast.impl.antlr4
- BaseResultProducingCloseable<T> - Class in net.sourceforge.pmd.util
-
Base class for an autocloseable that produce a result once it has been closed.
- BaseResultProducingCloseable() - Constructor for class net.sourceforge.pmd.util.BaseResultProducingCloseable
- BaseTokenFilter<T extends GenericToken<T>> - Class in net.sourceforge.pmd.cpd.impl
-
A generic filter for PMD token managers that allows to use comments to enable / disable analysis of parts of the stream
- BaseTokenFilter(TokenManager<T>) - Constructor for class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
-
Creates a new BaseTokenFilter
- BatchLanguageProcessor<P extends LanguagePropertyBundle> - Class in net.sourceforge.pmd.lang.impl
-
A base class for language processors.
- BatchLanguageProcessor(P) - Constructor for class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- below(N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints
-
Requires the number to be lower than an upper bound.
- bench(String, Runnable) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
- bench(String, Supplier<T>) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
- BLACK - net.sourceforge.pmd.util.GraphUtil.DotColor
- body - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Content
- BODY_PLACEHOLDER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- booleanProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a boolean property.
- bufpos - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Position of the next char to read in the input.
- build() - Method in class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
- build() - Method in class net.sourceforge.pmd.lang.document.TextFileBuilder
-
Creates and returns the new text file.
- build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Builds the descriptor and returns it.
- build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
- builderForCharSeq(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a read-only TextFile reading from a string.
- builderForPath(Path, Charset, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a builder for a textfile that reads and write to the file.
- builderForReader(Reader, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a read-only builder reading from a reader.
- buildMap(Consumer<Map<K, V>>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- buildMap(Map<K, V>, Consumer<Map<K, V>>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- buildReport(Consumer<? super FileAnalysisListener>) - Static method in class net.sourceforge.pmd.reporting.Report
-
Create a report by making side effects on a
FileAnalysisListener
. - 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.xpath.XPathRule
- buildVisitor() - Method in class net.sourceforge.pmd.lang.rule.AbstractVisitorRule
-
Returns a rule visitor that can visit nodes for the given rule context.
C
- cached() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the elements of this node stream, but which will evaluate the upstream pipeline only once.
- call(Node, Object[]) - Method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.FunctionCall
-
This method is called at runtime to evaluate the XPath function expression.
- callableStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
CallableStatement to return source code.
- CAMEL_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention
-
camelCase.
- cannotVisit(Node, P) - Method in interface net.sourceforge.pmd.lang.ast.AstVisitor
-
Called by a node when it detects that the visitor is not of the language it is used to visiting.
- caret(FileId, int, int) - Static method in class net.sourceforge.pmd.lang.document.FileLocation
-
Returns a new location that starts and ends at the same position.
- caretAt(int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Builds a new region with zero length and placed at the given offset.
- castIfSupported(Node) - Method in interface net.sourceforge.pmd.lang.metrics.Metric
-
Casts the node to the more specific type
<N>
if this metric can be computed on it. - categories - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- chain(List<? extends ViolationDecorator>) - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator
-
Apply several decorators in a chain.
- CHARACTERSET - net.sourceforge.pmd.util.database.DBType.Property
- charAt(int) - Method in class net.sourceforge.pmd.lang.document.Chars
- charListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of characters.
- charProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a character property.
- Chars - Class in net.sourceforge.pmd.lang.document
-
View on a string which doesn't copy the array for subsequence operations.
- CharStream - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
PMD flavour of character streams used by JavaCC parsers.
- check_name - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- checkLanguageIsAcceptable(Language) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Check that it is correct to use the given language with this configuration.
- checkLanguageIsAcceptable(Language) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- checkLanguageIsAcceptable(Language) - Method in class net.sourceforge.pmd.PMDConfiguration
- children() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- children() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- children() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing all the children of this node.
- children() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the children of the nodes contained in this stream.
- children(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream of the children of this node that are of the given type.
- children(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the children stream of each node in this stream, filtered by the given node type.
- CLASS - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- CLASS_AND_METHOD_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
- CLASS_NAME - Static variable in interface net.sourceforge.pmd.reporting.RuleViolation
-
Key in
RuleViolation.getAdditionalInfo()
for the name of the class in which the violation was identified. - clearNodeScope(N) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
- close() - Method in interface net.sourceforge.pmd.benchmark.TimedOperation
-
Stops tracking if not already stopped.
- close() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
- close() - Method in interface net.sourceforge.pmd.cpd.TokenFactory
-
This adds the EOF token, it must be called when
CpdLexer.tokenize(TextDocument, TokenFactory)
is done. - close() - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Close registered resources like zip files.
- close() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Closing a document closes the underlying
TextFile
. - close() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Release resources associated with this text file.
- close() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- close() - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
-
Close all processors in this registry.
- close() - Method in class net.sourceforge.pmd.lang.rule.RuleSetWriter
- close() - Method in class net.sourceforge.pmd.PmdAnalysis
- close() - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
Signals the end of the analysis: no further calls will be made to this listener.
- close() - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
Notify the implementation that the analysis ended, ie all files have been processed.
- close() - Method in interface net.sourceforge.pmd.reporting.ListenerInitializer
-
Signals the end of initialization: no further calls will be made to this object.
- close() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
-
Close this object.
- close(int) - Method in interface net.sourceforge.pmd.benchmark.TimedOperation
-
Stops tracking if not already stopped.
- 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
- coerceWildcard(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Coerce an iterator with a wildcard.
- collect(Collector<? super T, A, R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Collects the elements of this node stream using the specified
Collector
. - COLLECT_FILES - net.sourceforge.pmd.benchmark.TimedOperationCategory
- collectFilesRecursively() - Method in class net.sourceforge.pmd.AbstractConfiguration
- collectFilesRecursively(boolean) - Method in class net.sourceforge.pmd.AbstractConfiguration
- CollectionUtil - Class in net.sourceforge.pmd.util
-
Generic collection-related utility functions for java.util types.
- columnNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Returns the (1-based) column number of the character at the given index.
- commaSeparatedList(Function<? super Language, String>) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Formats the set of languages with the given formatter, sort and join everything with commas.
- CommentNode - Interface in net.sourceforge.pmd.lang.rule.xpath
- COMPARATOR - Static variable in class net.sourceforge.pmd.lang.document.FileLocation
- compareLocation(Node) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- compareLocation(Node) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Compare the coordinates of this node with the other one as if with
Node.COORDS_COMPARATOR
. - compareTo(TextPos2d) - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Compares the start offset, then the length of a region.
- compareTo(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Compares the start offset, then the length of a region.
- compareTo(Mark) - Method in class net.sourceforge.pmd.cpd.Mark
- compareTo(Match) - Method in class net.sourceforge.pmd.cpd.Match
- compareTo(TokenEntry) - Method in class net.sourceforge.pmd.cpd.TokenEntry
- compareTo(AntlrToken) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- compareTo(FileId) - Method in interface net.sourceforge.pmd.lang.document.FileId
- compareTo(TextRange2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- compareTo(Language) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- compareTo(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersion
- compareTo(T) - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
This must return true if this token comes before the other token.
- compareToVersion(String) - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Compare this version to another version of the same language identified by the given version string.
- complement() - Method in enum net.sourceforge.pmd.util.OptionalBool
-
Returns the logical complement.
- compute(Metric<N, R>, Node, MetricOptions) - Static method in interface net.sourceforge.pmd.lang.metrics.Metric
-
Compute a metric on an arbitrary node, if possible.
- compute(DataMap.DataKey<? extends K, T>, Function<? super T, ? extends T>) - Method in class net.sourceforge.pmd.util.DataMap
-
Create or replace a mapping with a value computed from the current value (or null if missing).
- computeAllMetricsFor(Node) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
-
Computes all metrics available on the given node.
- computeFor(N, MetricOptions) - Method in interface net.sourceforge.pmd.lang.metrics.Metric
-
Computes the value of the metric for the given node.
- computeIfAbsent(DataMap.DataKey<? extends K, T>, Supplier<? extends T>) - Method in class net.sourceforge.pmd.util.DataMap
-
Retrieve the value, or compute it if it is missing.
- computeMetric(Metric<? super N, R>, N) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
-
Computes a metric identified by its code on a node, with the default options.
- computeMetric(Metric<? super N, R>, N, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
-
Computes a metric identified by its code on a node, possibly selecting a variant with the
options
parameter. - computeMetric(Metric<? super N, R>, N, MetricOptions, boolean) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
-
Computes a metric identified by its code on a node, possibly selecting a variant with the
options
parameter. - computeNext() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
-
Compute the next element.
- computeStatistics(Metric<? super O, ?>, Iterable<? extends O>) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
-
Computes statistics for the results of a metric over a sequence of nodes.
- computeStatistics(Metric<? super O, ?>, Iterable<? extends O>, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
-
Computes statistics for the results of a metric over a sequence of nodes.
- concat(Iterator<? extends T>, Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- concatView(List<? extends T>, List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns a list view that pretends it is the concatenation of both lists.
- configErrors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
-
Accumulated configuration errors.
- ConfigurableFileNameRenderer - Class in net.sourceforge.pmd.reporting
- ConfigurableFileNameRenderer() - Constructor for class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer
- ConfigurationError(Rule, String) - Constructor for class net.sourceforge.pmd.reporting.Report.ConfigurationError
-
Creates a new configuration error for a specific rule.
- connection - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Connection management
- ConstraintViolatedException - Exception in net.sourceforge.pmd.properties
-
Thrown when a property constraint is violated.
- CONSTRUCTOR - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- contains(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns true if this region contains the character at the given offset.
- contains(TextPos2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- contains(TextRange2d) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- contains(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns true if this region contains the entirety of the other region.
- contains(MetricOption) - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
-
Returns true if this bundle contains the given option.
- contains(NameOccurrence) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- contains(NameOccurrence) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Tests whether or not a
NameOccurrence
is directly contained in the scope. - content - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- Content(String) - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue.Content
-
Strip out all newlines from the body
- contentEquals(CharSequence) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Like
Chars.contentEquals(CharSequence, boolean)
, considering case distinctions. - contentEquals(CharSequence, boolean) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns true if this char sequence is logically equal to the parameter.
- contexted(AssertionError) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- contexted(RuntimeException) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- contexted(StackOverflowError) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- ContextedAssertionError - Error in net.sourceforge.pmd.util
-
An
AssertionError
with nice messages. - ContextedStackOverflowError - Error in net.sourceforge.pmd.util
-
A
StackOverflowError
with nice messages. - convertTo(StringUtil.CaseConvention, String) - Method in enum net.sourceforge.pmd.util.StringUtil.CaseConvention
- COORDS_COMPARATOR - Static variable in interface net.sourceforge.pmd.lang.ast.Node
-
Compares nodes according to their location in the file.
- COORDS_COMPARATOR - Static variable in class net.sourceforge.pmd.lang.document.FileLocation
- copy(RuleSet) - Static method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Creates a copy of the given ruleset.
- copyFrom(BaseAntlrInnerNode<N>) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- count() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the number of nodes in this stream.
- count(Iterator<?>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Counts the items in this iterator, exhausting it.
- CPD - Static variable in class net.sourceforge.pmd.lang.LanguageRegistry
-
Contains the languages that support CPD and are found on the classpath of the classloader of this class.
- CPD_ANONYMIZE_IDENTIFIERS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CPD_ANONYMIZE_LITERALS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CPD_IGNORE_IMPORTS - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CPD_IGNORE_LITERAL_AND_IDENTIFIER_SEQUENCES - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CPD_IGNORE_LITERAL_SEQUENCES - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CPD_IGNORE_METADATA - Static variable in class net.sourceforge.pmd.cpd.CpdLanguageProperties
- CpdAnalysis - Class in net.sourceforge.pmd.cpd
-
Main programmatic API of CPD.
- CpdCapableLanguage - Interface in net.sourceforge.pmd.cpd
-
A language that supports
CPD
. - CPDConfiguration - Class in net.sourceforge.pmd.cpd
- CPDConfiguration() - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
- CPDConfiguration(LanguageRegistry) - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
- CpdLanguageProperties - Class in net.sourceforge.pmd.cpd
-
These are language properties common to multiple
CpdCapableLanguage
s. - CpdLexer - Interface in net.sourceforge.pmd.cpd
-
Tokenizes a source file into tokens consumable by CPD.
- CpdLexerBase<T extends GenericToken<T>> - Class in net.sourceforge.pmd.cpd.impl
-
Generic base class for a
CpdLexer
. - CpdLexerBase() - Constructor for class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- CPDListener - Interface in net.sourceforge.pmd.cpd
- CPDNullListener - Class in net.sourceforge.pmd.cpd
- CPDNullListener() - Constructor for class net.sourceforge.pmd.cpd.CPDNullListener
- CpdOnlyLanguageModuleBase - Class in net.sourceforge.pmd.lang.impl
-
Base class for language modules that only support CPD and not PMD.
- CpdOnlyLanguageModuleBase(LanguageModuleBase.LanguageMetadata) - Constructor for class net.sourceforge.pmd.lang.impl.CpdOnlyLanguageModuleBase
-
Construct a module instance using the given metadata.
- CPDReport - Class in net.sourceforge.pmd.cpd
-
The result of a CPD analysis.
- CPDReportRenderer - Interface in net.sourceforge.pmd.cpd
-
Render a
CPDReport
to a file. - create(String, String, String, Collection<Pattern>, Collection<Pattern>, Iterable<? extends Rule>) - Static method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Creates a new ruleset with the given metadata such as name, description, fileName, exclude/include patterns are used.
- create(CPDConfiguration) - Static method in class net.sourceforge.pmd.cpd.CpdAnalysis
-
Create a new instance from the given configuration.
- create(TextDocument) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Create a new char stream for the given document with the default token document behavior.
- create(TextDocument, JavaccTokenDocument.TokenDocumentBehavior) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Create a new char stream for the given document.
- create(TextFile) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Create a new text document for the given text file.
- create(LanguageRegistry, Map<Language, LanguagePropertyBundle>, PmdReporter) - Static method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
-
Create a new instance by creating a processor for each language in the given language registry.
- create(PMDConfiguration) - Static method in class net.sourceforge.pmd.PmdAnalysis
-
Constructs a new instance from a configuration.
- createAnalysisTask(RuleSets, List<TextFile>, GlobalAnalysisListener, int, AnalysisCache, PmdReporter, LanguageProcessorRegistry) - Static method in class net.sourceforge.pmd.lang.InternalApiBridge
- createCpdLexer(LanguagePropertyBundle) - Method in interface net.sourceforge.pmd.cpd.CpdCapableLanguage
-
Create a new
CpdLexer
for this language, given a property bundle with configuration. - createCpdLexer(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.impl.CpdOnlyLanguageModuleBase
- createCpdLexer(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.PlainTextLanguage
- createErrorNode(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- createLineRange(int, int) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a region that spans the text of all the given lines.
- createPmdError(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- createPmdTerminal(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- createProcessor(LanguagePropertyBundle) - Method in class net.sourceforge.pmd.lang.impl.SimpleLanguageModuleBase
- createProcessor(LanguagePropertyBundle) - Method in interface net.sourceforge.pmd.lang.PmdCapableLanguage
-
Create a new
LanguageProcessor
for this language, given a property bundle with configuration. - createRenderer() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Create a Renderer instance based upon the configured reporting options.
- createRenderer(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Create a Renderer instance based upon the configured reporting options.
- createRenderer(String, Properties) - Static method in class net.sourceforge.pmd.renderers.RendererFactory
-
Construct an instance of a Renderer based on report format name.
- createRuleContext(FileAnalysisListener, Rule) - Static method in class net.sourceforge.pmd.reporting.InternalApiBridge
-
Create a new RuleContext.
- createRuleViolation(Rule, FileLocation, String, Map<String, String>) - Static method in class net.sourceforge.pmd.reporting.InternalApiBridge
- createTerminalNode(ParserRuleContext, Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- createToken(int, CharStream, String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
- createToken(JavaccTokenDocument, int, CharStream, String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
-
Creates a new token with the given kind.
- crossFindBoundaries() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream.DescendantNodeStream
-
An alias for
crossFindBoundaries(true)
. - crossFindBoundaries(boolean) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream.DescendantNodeStream
-
Returns a node stream that will not stop the tree traversal when encountering a find boundary.
- CSVRenderer - Class in net.sourceforge.pmd.cpd
-
Renders a report to CSV.
- CSVRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer the results to a comma-delimited text format.
- CSVRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
- CSVRenderer() - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
- CSVRenderer(boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
- CSVRenderer(char) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
- CSVRenderer(char, boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
- CSVRenderer(ColumnDescriptor<RuleViolation>[], String, String) - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
- CSVWithLinecountPerFileRenderer - Class in net.sourceforge.pmd.cpd
- CSVWithLinecountPerFileRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVWithLinecountPerFileRenderer
D
- DataMap<K> - Class in net.sourceforge.pmd.util
-
An opaque, strongly typed heterogeneous data container.
- DataMap.DataKey<K extends DataMap.DataKey<K,T>,T> - Interface in net.sourceforge.pmd.util
-
A key for type-safe access into a
DataMap
. - DataMap.SimpleDataKey<T> - Class in net.sourceforge.pmd.util
- DBMSMetadata - Class in net.sourceforge.pmd.util.database
-
Wrap JDBC connection for use by PMD:
DBURI
parameters specify the source code to be passed to PMD. - DBMSMetadata(String, String, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
-
Define database connection and source code to retrieve with explicit database username and password.
- DBMSMetadata(Connection) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
-
Minimal constructor
- DBMSMetadata(Properties, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
-
Define database connection and source code to retrieve with database properties.
- DBMSMetadata(DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
-
Define database connection and source code to retrieve.
- DBType - Class in net.sourceforge.pmd.util.database
-
Encapsulate the settings needed to access database source code.
- DBType(String) - Constructor for class net.sourceforge.pmd.util.database.DBType
- DBType(String, String) - Constructor for class net.sourceforge.pmd.util.database.DBType
-
Load the most specific dbType for the protocol
- DBType.Property - Enum in net.sourceforge.pmd.util.database
-
The names of the properties
- dburi - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
DBURI
- DBURI - Class in net.sourceforge.pmd.util.database
-
Provide a single parameter to specify database objects to process.
- DBURI(String) - Constructor for class net.sourceforge.pmd.util.database.DBURI
-
Create DBURI from a string, combining a JDBC URL and query parameters.
- DBURI(URI) - Constructor for class net.sourceforge.pmd.util.database.DBURI
-
Create DBURI from a URI, combining a JDBC URL and query parameters.
- decorate(Node, Map<String, String>) - Method in interface net.sourceforge.pmd.reporting.ViolationDecorator
-
Compute additional key/value pairs about the violation that should be reflected in
RuleViolation.getAdditionalInfo()
. - deepCopy() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- deepCopy() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Creates a new copy of this rule.
- deepCopy() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- deepCopy() - Method in class net.sourceforge.pmd.lang.rule.xpath.XPathRule
- DEFAULT - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
- DEFAULT - Static variable in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
-
The default XPath version for XPath queries.
- DEFAULT_COMPARATOR - Static variable in interface net.sourceforge.pmd.reporting.RuleViolation
-
A comparator for rule violations.
- DEFAULT_DELIMITER - Static variable in class net.sourceforge.pmd.properties.PropertyFactory
-
Default delimiter for all properties.
- DEFAULT_LANGUAGE - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
- DEFAULT_LINECOUNTPERFILE - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
- DEFAULT_RENDERER - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
- DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
- DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.SimpleRenderer
- DEFAULT_SUPPRESS_MARKER - Static variable in class net.sourceforge.pmd.PMDConfiguration
-
The default suppress marker string.
- DefaultDesignerBindings() - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.CSVRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.EmacsRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.IDEAJRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.JsonRenderer
- defaultFileExtension() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Return the default filename extension to use.
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.SarifRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextPadRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.TextRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.XSLTRenderer
- defaultFileExtension() - Method in class net.sourceforge.pmd.renderers.YAHTMLRenderer
- defaultValue() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
-
Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
- defaultValue(T) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Specify a default value.
- defaultValue(Iterable<? extends V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify a default value.
- defaultValue(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder
-
Specify a default value using a string pattern.
- defaultValue(String, int) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder
-
Specify a default value using a string pattern.
- defaultValues(V, V...) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify default values.
- defensiveUnmodifiableCopy(List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns an unmodifiable copy of the list.
- defensiveUnmodifiableCopyToSet(Collection<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.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.
- dependsOnContext() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
-
If the function depends on the context item, then this method should return
true
. - dependsOnLanguage(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Record that this language depends on another language, identified by its id.
- 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. - derivePropertiesFromStrings(Map<Language, Properties>, PmdReporter) - Static method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
- desc(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Specify the description of the property.
- descendants() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- descendants() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing all the descendants of this node.
- descendants() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the strict descendants of the nodes contained in this stream.
- descendants(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream of the descendants of this node that are of the given type.
- descendants(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the descendant stream of each node in this stream, filtered by the given node type.
- descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a node stream containing this node, then all its descendants.
- descendantsOrSelf() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing the nodes contained in this stream and their descendants.
- describeKind(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
- describeKind(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
-
Returns a string that describes the token kind.
- describeKindImpl(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
-
Describe the given kind.
- description - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
- description - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- description() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
-
Describes the property and the role it plays within the rule it is specified for.
- description() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
-
Returns a short description of the format of this renderer's output.
- 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(FileId) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
-
Determines the filename that should be used in the report for the given ID.
- diff(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns the set difference of the first collection with the other collections.
- displayName() - Method in enum net.sourceforge.pmd.benchmark.TimedOperationCategory
- displayName() - Method in interface net.sourceforge.pmd.lang.metrics.Metric
-
The full name of the metric.
- distinct() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream consisting of the distinct elements (w.r.t
Object.equals(Object)
) of this stream. - distinct(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- done() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
- DONE - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- doubleListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of decimal numbers.
- doubleProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a double property.
- DRIVER - net.sourceforge.pmd.util.database.DBType.Property
- drop(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream consisting of the remaining elements of this stream after discarding the first n elements of the stream.
- drop(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Produce an iterator whose first element is the nth element of the given source.
- drop(List<T>, int) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- dropLast(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream consisting of the elements of this stream except the n tail elements.
- dropLast(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Remove the last n elements of the iterator.
- dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.xpath.XPathRule
- 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
-
Truncate the given string to some maximum length.
- EmacsRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to GNU Emacs parsable format.
- EmacsRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmacsRenderer
- empty() - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns an empty node stream.
- empty() - Static method in class net.sourceforge.pmd.reporting.ReportStats
- EMPTY - Static variable in class net.sourceforge.pmd.lang.document.Chars
-
An empty Chars instance.
- emptyDefaultValue() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Specify that the default value is an empty collection.
- emptyList() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns the empty list.
- emptyOptions() - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions
-
Returns an empty options bundle.
- EmptyRenderer - Class in net.sourceforge.pmd.renderers
-
An empty renderer, for when you really don't want a report.
- EmptyRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmptyRenderer
- ENCODING - Static variable in class net.sourceforge.pmd.renderers.XMLRenderer
- end() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
- end() - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
- end() - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
- end() - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
- end() - Method in class net.sourceforge.pmd.renderers.JsonRenderer
- end() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
This method is at the very end of the Rendering process, after
Renderer.renderFileReport(Report)
. - end() - Method in class net.sourceforge.pmd.renderers.SarifRenderer
- end() - Method in class net.sourceforge.pmd.renderers.TextRenderer
- end() - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
- end() - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- end() - Method in class net.sourceforge.pmd.renderers.XSLTRenderer
- end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- end(RuleContext) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
End processing.
- end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- endsWith(String) - Method in class net.sourceforge.pmd.lang.document.Chars
- ensureOpen() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Check to make sure that the stream has not been closed
- ensureOpen() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
- ensureReadable() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- enterOuterAlt(BaseAntlrInnerNode<N>, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- enterRecursionRule(BaseAntlrInnerNode<N>, int, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- enterRule(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- enterRule(ParseTreeListener) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- enumListProperty(String, Class<T>, Function<? super T, String>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of
<T>
. - enumListProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of
<T>
. - enumProperty(String, Class<T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for an enumerated property for the given enum class, using the
toString
of its enum constants as labels. - enumProperty(String, Class<T>, Function<? super T, String>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for an enumerated property for the given enum class, using the given function to label its constants.
- enumProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for an enumerated property.
- EOF - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Kind for EOF tokens.
- EOL - Static variable in class net.sourceforge.pmd.renderers.EmacsRenderer
- equals(Object) - Method in class net.sourceforge.pmd.cpd.Mark
- equals(Object) - Method in class net.sourceforge.pmd.cpd.TokenEntry
- equals(Object) - Method in class net.sourceforge.pmd.lang.document.Chars
- equals(Object) - Method in interface net.sourceforge.pmd.lang.document.FileId
-
Two file IDs are equal if they have the same
FileId.getUriString()
. - equals(Object) - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Text file equality is implementation-defined.
- equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextPos2d
- equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- equals(Object) - Method in class net.sourceforge.pmd.lang.document.TextRegion
- equals(Object) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- equals(Object) - Method in class net.sourceforge.pmd.lang.LanguageVersion
- equals(Object) - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
- equals(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
-
Rules are equal if: They have the same implementation class. They have the same name. They have the same priority. They share the same properties.
- equals(Object) - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Two rulesets are equals, if they have the same name and contain the same rules.
- equals(Object) - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
- equals(Object) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- equals(Object) - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
- equals(Object) - Method in class net.sourceforge.pmd.util.database.DBType
- error(Throwable, String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
-
Only one of the cause or the message can be null.
- error(String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- error(Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- error(Node, String, Object...) - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
-
Report an error at the given location.
- errorEx(String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- errorEx(String, Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- errorKind() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
- errorKind() - Method in exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
- errorKind() - Method in exception net.sourceforge.pmd.lang.ast.LexException
- errorKind() - Method in exception net.sourceforge.pmd.lang.ast.ParseException
- errors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
-
Accumulated processing errors.
- escapeJava(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
- EscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
An object that can translate an input document into an output document, typically by replacing escape sequences with the character they represent.
- EscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Create a translator that will read from the given document.
- escapeWhitespace(Object) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Replace some whitespace characters so they are visually apparent.
- EVALUATION - net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
- exception - Variable in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- 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.
- exitRule(ParseTreeListener) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- Experimental - Annotation Type in net.sourceforge.pmd.annotation
-
Tagged API members are subject to change.
- export() - Method in class net.sourceforge.pmd.util.treeexport.TreeExporter
- extensions(String, String...) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Record the extensions assigned to the language.
- extensions(Collection<String>) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Record the extensions assigned to the language.
F
- FIELD - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- FILE_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
- FILE_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory
- 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.
- FileCollector - Class in net.sourceforge.pmd.lang.document
-
Collects files to analyse before a PMD run.
- FileId - Interface in net.sourceforge.pmd.lang.document
-
An identifier for a
TextFile
. - FileLocation - Class in net.sourceforge.pmd.lang.document
-
Represents the coordinates of a text region, used for reporting.
- fileNameRenderer() - Method in class net.sourceforge.pmd.PmdAnalysis
- FileNameRenderer - Interface in net.sourceforge.pmd.reporting
-
Strategy to render a
FileId
into a display name. - files() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
- files() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Returns the file collector for the analysed sources.
- filter(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream consisting of the nodes of this stream that match the given predicate.
- filter(Predicate<Language>) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Create a new registry with the languages that satisfy the predicate.
- filter(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- filterAbovePriority(RulePriority) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Filter loaded rules to only those that match or are above the given priority.
- filterIs(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Filters the nodes of this stream that are a subtype of the given class.
- filterLanguages(Set<Language>) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Exclude all collected files whose language is not part of the given collection.
- filterMatches(Predicate<Match>) - Method in class net.sourceforge.pmd.cpd.CPDReport
-
Creates a new CPD report taking all the information from this report, but filtering the matches.
- filterMatching(Function<? super T, ? extends U>, U) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Filters the nodes of this stream by comparing a value extracted from the nodes with the given constant.
- filterNot(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Filters the node of this stream using the negation of the given predicate.
- filterNotMatching(Function<? super T, ? extends U>, U) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Inverse of
NodeStream.filterMatching(Function, Object)
. - filterNotNull(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- filterTokenStream(TokenManager<T>) - Method in class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- filterViolations(Predicate<RuleViolation>) - Method in class net.sourceforge.pmd.reporting.Report
-
Creates a new report taking all the information from this report, but filtering the violations.
- findById(String) - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers
-
Returns the renderer descriptor registered by the given ID.
- finish(Collector<? super V, A, ? extends C>, A) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Finish the accumulated value of the collector.
- finishThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Finishes tracking a thread.
- first() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the first element of this stream, or
null
if the stream is empty. - first(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the first element of this stream of the given type, or
null
if there is none. - first(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the first element of this stream that matches the given predicate, or
null
if there is none. - firstChild(Class<? extends R>) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- firstChild(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the first child of this node that has the given type.
- firstChild(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream containing the first child of each of the nodes in this stream that has the given type.
- firstNonNull(Function<? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the first element of this stream for which the mapping function returns a non-null result.
- firstOpt() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns an optional containing the first element of this stream, or an empty optional if the stream is empty.
- firstOrThrow() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the first element of this stream, or throws a
NoSuchElementException
if the stream is empty. - fitTokensToChildren(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
-
Ensures that the first (resp.
- flatMap(Function<? super T, ? extends NodeStream<? extends R>>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream consisting of the results of replacing each node of this stream with the contents of a stream produced by the given mapping function.
- flatMap(Iterator<? extends T>, Function<? super T, ? extends Iterator<? extends R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- flatMapWithSelf(Iterator<? extends R>, Function<? super R, ? extends Iterator<? extends R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Like flatMap, but yields each element of the input iterator before yielding the results of the mapper function.
- flush() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- flush() - Method in interface net.sourceforge.pmd.renderers.Renderer
- followingSiblings() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the following siblings of the nodes contained in this stream.
- forCharSeq(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a read-only TextFile reading from a string.
- forEach(Consumer<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
- forkJoin(NodeStream<? extends T>, Function<? super T, ? extends NodeStream<? extends R>>, Function<? super T, ? extends NodeStream<? extends R>>, Function<? super T, ? extends NodeStream<? extends R>>...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Applies the given mapping functions to the given upstream in order and merges the results into a new node stream.
- forPath(Path, Charset, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns an instance of this interface reading and writing to a file.
- forReader(Reader, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns a read-only instance of this interface reading from a reader.
- forRootOnly() - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector
-
Target only the root of the tree.
- forSingleRule(Rule) - Static method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Creates a new ruleset containing a single rule.
- forTypes(Class<? extends Node>, Class<? extends Node>...) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector
-
Target nodes that are subtypes of any of the given classes.
- forTypes(Collection<Class<? extends Node>>) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector
-
Target nodes that are subtypes of any of the given classes.
- forXPathNames(Collection<String>) - Static method in class net.sourceforge.pmd.lang.rule.RuleTargetSelector
-
Target nodes having one of the given XPath local name.
- FragmentedDocBuilder - Class in net.sourceforge.pmd.lang.document
- FragmentedDocBuilder(TextDocument) - Constructor for class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
- fromAbsolutePath(String, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a file ID which interprets the first parameter as an absolute path.
- fromBothOffsets(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Builds a new region from start and end offset.
- fromCharSeq(CharSequence) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent
-
Normalize the line endings of the text to "\n", returns a
TextFileContent
containing the original line ending. - fromInputStream(InputStream, Charset) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent
-
Reads the contents of the input stream into a TextFileContent.
- fromIterable(Iterable<? extends T>) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a new node stream that contains the same elements as the given iterable.
- fromOffsetLength(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Builds a new region from offset and length.
- fromPath(Path) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a file ID for the given path.
- fromPath(Path, FileId) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a new path id for the given path.
- fromPathLikeString(String) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a path ID for the given string.
- fromPmdConfig(PMDConfiguration) - Static method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Configure a new ruleset factory builder according to the parameters of the given PMD configuration.
- fromPredicate(Predicate<? super U>, String) - Static method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Builds a new validator from a predicate, and description.
- fromPredicate(Predicate<? super U>, String, Map<String, String>) - Static method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Builds a new constraint from a predicate, a description and xml attributes to serialize the constraint.
- fromReader(Reader) - Static method in class net.sourceforge.pmd.lang.document.TextFileContent
-
Read the reader fully and produce a
TextFileContent
. - fromString(String) - Method in class net.sourceforge.pmd.properties.PropertySerializer
-
Read the value from a string, if it is supported.
- fromURI(String) - Static method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a file ID for a URI.
- fullLine(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d
G
- generate(T, Function<? super T, ? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Returns an iterator that applies a stepping function to the previous value yielded.
- GenericNode<N extends GenericNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl
-
Interface that binds the return type of some node methods to a type parameter.
- GenericToken<T extends GenericToken<T>> - Interface in net.sourceforge.pmd.lang.ast
-
Represents a token, part of a token chain in a source file.
- get(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the element at index n in this stream.
- get(DataMap.DataKey<? extends K, ? extends T>) - Method in class net.sourceforge.pmd.util.DataMap
-
Retrieves the data currently mapped to the key.
- GET_SOURCE_CODE_STATEMENT - net.sourceforge.pmd.util.database.DBType.Property
- getAbsolutePath() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
Return an absolute path to this file in its containing file system.
- getAdditionalInfo() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
A map of additional key-value pairs known about this violation.
- getAdditionalInfo(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- getAdditionalInfo(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
-
Returns a collection of "additional information" entries pertaining to the given node.
- getAnalysisCache() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getAnalysisClassLoader() - Method in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
-
Returns the classloader to use to resolve classes for this language.
- getArgumentTypes() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
-
Defines the types of the function arguments.
- getAstInfo() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the
AstInfo
for this root node. - getAstInfo() - Method in interface net.sourceforge.pmd.lang.ast.RootNode
- getAstInfo() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
- getBeginColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The column number where this token starts, inclusive.
- getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getBeginColumn() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Get the column number of the begin line in the source file in which this violation was identified.
- getBeginLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The line number where this token starts.
- getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getBeginLine() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Get the begin line number in the source file in which this violation was identified.
- getBeginTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
- getBytes(Charset) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns the characters of this charsequence encoded with the given charset.
- getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBType
- getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBURI
- getChars(int, char[], int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Copies 'count' characters from index 'srcBegin' into the given array, starting at 'dstBegin'.
- getChecksum() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
- getCheckSum() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a checksum for the contents of the file.
- getCheckSum() - Method in class net.sourceforge.pmd.lang.document.TextFileContent
-
Returns a checksum for the contents of the file.
- getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
- getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getChild(int) - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- getChild(int) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the child of this node at the given index.
- getClassLoader() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the ClassLoader being used by PMD when processing Rules.
- getCollectedFiles() - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Returns an unmodifiable list of all files that have been collected.
- getColumn() - Method in exception net.sourceforge.pmd.lang.ast.LexException
- getColumn() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Returns the (1-based) column number.
- getConfigurationErrors() - Method in class net.sourceforge.pmd.reporting.Report
-
Returns an unmodifiable list of configuration errors that have been recorded until now.
- getConnection() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Return JDBC Connection for direct JDBC access to the specified database.
- getConstantImageOfToken(Token) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
-
Returns the constant image of the given token (a shared string), or null if the token has none.
- getConstraint() - Method in exception net.sourceforge.pmd.properties.ConstraintViolatedException
- getConstraintDescription() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Returns a description of the constraint imposed by this validator on the values.
- getConstraints() - Method in class net.sourceforge.pmd.properties.PropertySerializer
-
Returns the constraints that this mapper applies to values after parsing them.
- getCPDReportRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getCurrentValue() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- getData() - Method in interface net.sourceforge.pmd.lang.rule.xpath.CommentNode
- getDbType() - Method in class net.sourceforge.pmd.util.database.DBURI
- getDecl() - Method in class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
- getDeclarations() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- getDeclarations() - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Gets all the declaration with the occurrences in this scope.
- getDeclarations(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- getDeclarations(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Helper method to get only a specific type of name declarations.
- getDefaultLanguageVersion(Language) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Get the current default LanguageVersion for the given Language.
- getDefaultLanguageVersionForFile(File) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Get the default LanguageVersion for the first Language of a given source file.
- getDefaultLanguageVersionForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Get the LanguageVersion for the first Language of a source file with the given name.
- getDefaultVersion() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the default language version for this language.
- getDefaultVersion() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getDependencies() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns a set of the IDs of languages that this language instance depends on.
- getDependencies() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getDependenciesOf(Language) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Creates a language registry containing the given language and its dependencies, fetched from this language registry or the parameter.
- getDescription() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getDescription() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the description of this Rule.
- getDescription() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getDescription() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
- 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.reporting.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.reporting.Report.ProcessingError
- getDisplayName(FileId) - Method in class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer
- getDisplayName(FileId) - Method in interface net.sourceforge.pmd.reporting.FileNameRenderer
-
Return a display name for the given file id.
- getDisplayName(TextFile) - Method in interface net.sourceforge.pmd.reporting.FileNameRenderer
- getDisplayName(FileId) - Method in class net.sourceforge.pmd.cpd.CPDReport
-
Return the display name of the given file.
- getDisplayString() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
-
Returns the string displayed to the user.
- getDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Returns the document owning this token.
- getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBType
- getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBURI
- getEnclosingScope(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- getEnclosingScope(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Helper method that goes up the parent scopes to find a scope of the specified type
- getEncoding() - Method in class net.sourceforge.pmd.cpd.XMLRenderer
- getEndColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The column number where this token ends, exclusive.
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the column number of the last character for the current token.
- getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getEndColumn() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Exclusive, 1-based column number.
- getEndColumn() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getEndColumn() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Get the column number of the end line in the source file in which this violation was identified.
- getEndIndex() - Method in class net.sourceforge.pmd.cpd.Match
- getEndLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry
-
The line number where this token ends.
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getEndLine() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the line number of the last character for current token.
- getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
- getEndLine() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Inclusive, 1-based line number.
- getEndLine() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getEndLine() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Get the end line number in the source file in which this violation was identified.
- getEndOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the end offset of the current token (in the translated source), exclusive.
- getEndOffset() - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
0-based, exclusive index.
- getEndPos() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Returns the end position.
- getEndPos() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getEndTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
- getEntireRegion() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a text region that corresponds to the entire document, in the coordinate system of this document.
- getError() - Method in class net.sourceforge.pmd.reporting.Report.ProcessingError
- getExamples() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getExamples() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the list of examples for this Rule.
- getExamples() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getExceptionContext() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
- getExceptionContext() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
- getExcludes() - Method in class net.sourceforge.pmd.AbstractConfiguration
- getExtensions() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the list of file extensions associated with this language.
- getExtensions() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getExternalInfoUrl() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get a URL for external information about this Rule.
- getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getExtraViolationSuppressors() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Returns additional language-specific violation suppressors.
- getFile() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getFileExclusions() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Returns the file exclusion patterns as an unmodifiable list.
- getFileId() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
-
The name of the file in which the error occurred.
- getFileId() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- getFileId() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
File name of this position.
- getFileId() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns
TextFile.getFileId()
for the text file backing this document. - getFileId() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns an identifier for this file.
- getFileId() - Method in class net.sourceforge.pmd.reporting.Report.ProcessingError
- getFileId() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Return the ID of the file where the violation was found.
- getFileInclusions() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Returns the file inclusion patterns as an unmodifiable list.
- getFileName() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
Return the simple file name, like
Path.getFileName()
. - getFileName() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
- getFiles() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getFirstAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getFirstChild() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- getFirstChild() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the first child of this node, or null if it doesn't exist.
- getFirstError() - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
-
If
SemanticErrorReporter.error(Node, String, Object...)
has been called, return a semantic exception instance with the correct message. - getFirstMark() - Method in class net.sourceforge.pmd.cpd.Match
- getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
- getFirstToken() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
- getFirstToken() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
-
Returns the first token of the token chain.
- getForcedVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
- getForceLanguageVersion() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the LanguageVersion specified by the force-language parameter.
- getFormat() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getFullText() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
-
Returns the original text of the file (without escaping).
- getFullVersionName() - Static method in class net.sourceforge.pmd.PMDVersion
- getHandlerForFunctionDefs(XPathFunctionDefinition, XPathFunctionDefinition...) - Static method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler
-
Returns a default XPath handler.
- getHighlightedNodesWhenSelecting(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.RelatedNodesSelector
-
Returns a list of nodes that should be highlighted when selecting the given node.
- getIcon(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- getIcon(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
-
Returns a constant describing an icon that the node should bear in the treeview and other relevant places.
- getId() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the ID of this language.
- getId() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getId() - Method in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
A name, for reporting and documentation purposes.
- getIgnoreFile() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns the path to the file list exclude file.
- getImage() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns the token's text as a string.
- getImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getImage() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a string token, usually filled-in by the parser, which describes some textual characteristic of this node.
- getImage() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
- getImage() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
- getImage() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration
-
Gets the image of the node.
- getImage() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence
-
Gets the image of the used declaration, such as the variable name.
- getImage(Tokens) - Method in class net.sourceforge.pmd.cpd.TokenEntry
- getImage(T) - Method in class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- getImageCs() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns the text of the token as a char sequence.
- getImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- 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.
- getInputFile() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns the path to the file list include file.
- getInputPathList() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns the list of input paths to explore.
- getInstance() - Static method in class net.sourceforge.pmd.lang.PlainTextLanguage
-
Returns the singleton instance of this language.
- getInstance() - Static method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
-
Returns the default instance.
- getIterationCount() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- getKeyOfValue(Map<K, V>, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns the key that corresponds to the given value in the map, or null if it is not contained in the map.
- getKind() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Gets a unique integer representing the kind of token this is.
- getKind() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getKind() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getLabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
- getLanguage() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- getLanguage() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor
-
The language of this processor.
- getLanguage() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- getLanguage() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Returns the language that owns this version.
- getLanguage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getLanguage() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the Language of this Rule.
- getLanguage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getLanguage() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getLanguageByFullName(String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a language from its full name (eg
"Java"
). - getLanguageById(String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a language from its ID (eg
"java"
). - getLanguageMetricsProvider() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Returns the metrics provider for this language version, or null if it has none.
- getLanguageProcessor() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
-
Returns the language processor that parsed the tree.
- getLanguageProcessor() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- getLanguageProperties() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getLanguageProperties(Language) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns a mutable bundle of language properties that are associated to the given language (always the same for a given language).
- getLanguageProperties(Language) - Method in class net.sourceforge.pmd.PmdAnalysis
-
Returns a mutable bundle of language properties that are associated to the given language (always the same for a given language).
- getLanguageRegistry() - Method in class net.sourceforge.pmd.AbstractConfiguration
- getLanguages() - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
-
Return the languages that are registered in this instance.
- getLanguages() - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a set of all the known languages.
- getLanguages() - Method in class net.sourceforge.pmd.util.database.DBType
- getLanguagesForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Get the Languages of a given source file.
- getLanguagesList() - Method in class net.sourceforge.pmd.util.database.DBURI
- getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the language version of this node.
- getLanguageVersion() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns the language version that should be used to parse this file.
- getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns the language version which should be used to process this file.
- getLanguageVersion() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- getLanguageVersion() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor
-
The language version that was configured when creating this processor.
- getLanguageVersion() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- getLanguageVersionById(String, String) - Method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Returns a language version from its language ID (eg
"java"
). - getLanguageVersionDiscoverer() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.
- getLanguageVersionOfFile(String) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the LanguageVersion of the source file with given name.
- getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getLastAntlrToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getLastChild() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- getLastChild() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the first last of this node, or null if it doesn't exist.
- getLastToken() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getLastToken() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
- getLatestVersion() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the latest language version.
- getLength() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns the length in characters of the text.
- getLength() - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns the length of the region in characters.
- getLexer(CharStream) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
- getLexerForSource(CharStream) - Method in class net.sourceforge.pmd.cpd.impl.AntlrCpdLexer
- getLine() - Method in exception net.sourceforge.pmd.lang.ast.LexException
- getLine() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Returns the (1-based) line number.
- getLineCount() - Method in class net.sourceforge.pmd.cpd.Match
- getLineCount() - Method in class net.sourceforge.pmd.lang.document.FileLocation
- getLineTerminator() - Method in class net.sourceforge.pmd.lang.document.TextFileContent
-
Returns the original line terminator found in the file.
- getListener() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getLocation() - Method in class net.sourceforge.pmd.cpd.Mark
-
Return the location of this source range in the source file.
- getLocation() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence
-
Gets the location where the usage occurred.
- getLocation() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Returns the location where the violation should be reported.
- getLpRegistry() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- getLpRegistry() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getMainAttribute(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- getMainAttribute(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
-
Returns the "main" attribute of the given node.
- getMarkCount() - Method in class net.sourceforge.pmd.cpd.Match
- getMarkSet() - Method in class net.sourceforge.pmd.cpd.Match
- getMatches() - Method in class net.sourceforge.pmd.cpd.CPDReport
-
Return the list of duplication matches found by the CPD analysis.
- getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getMaximumLanguageVersion() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the maximum LanguageVersion to which this Rule applies.
- getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getMaxRuleIndex() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
- getMaxTokenType() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
- getMessage() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
- getMessage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getMessage() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the message to show when this Rule identifies a violation.
- getMessage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getMessage() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
- getMessage() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
- getMessageReporter() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getMessageReporter() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getMessageWithoutValue() - Method in exception net.sourceforge.pmd.properties.ConstraintViolatedException
- 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.AbstractRule
- getMinimumLanguageVersion() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the minimum LanguageVersion to which this Rule applies.
- getMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getMinimumPriority() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the minimum priority threshold when loading Rules from RuleSets.
- getMinimumTileSize() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getMsg() - Method in class net.sourceforge.pmd.reporting.Report.ProcessingError
- getName() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the full name of this Language.
- getName() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getName() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- getName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Returns the name of this language version.
- getName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getName() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the name of this Rule.
- getName() - Method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Get the descriptive name of this priority.
- getName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getName() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
- getName() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Return the name of the attribute (without leading @ sign).
- getName() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
- getName() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration
-
Gets the name of the declaration, such as the variable name.
- getName() - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Returns the name of the property to be built.
- getName() - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Gets the name of this property source.
- getName() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- getName() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Get the name of the Renderer.
- getName() - Method in class net.sourceforge.pmd.util.database.SourceObject
- getNext() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Obtain the next generic token according to the input stream which generated the instance of this token.
- getNext() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getNext() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getNextMajorRelease() - Static method in class net.sourceforge.pmd.PMDVersion
-
Retrieves the next major release to be expected.
- getNextSibling() - Method in interface net.sourceforge.pmd.lang.ast.impl.GenericNode
- getNextSibling() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the next sibling of this node, or null if it does not exist.
- getNextToken() - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
- getNextToken() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrTokenManager
- getNextToken() - Method in interface net.sourceforge.pmd.lang.TokenManager
- 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.
- getNormalizedText() - Method in class net.sourceforge.pmd.lang.document.TextFileContent
-
The text of the file, with the following normalizations: Line endings are normalized to "\n".
- getNth(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Returns the nth element of this iterator, or null if the iterator is shorter.
- getNumberOfTokensPerFile() - Method in class net.sourceforge.pmd.cpd.CPDReport
-
Return a map containing the number of tokens by processed file.
- getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getNumChildren() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the number of children of this node.
- getNumErrors() - Method in class net.sourceforge.pmd.reporting.ReportStats
- getNumViolations() - Method in class net.sourceforge.pmd.reporting.ReportStats
- getOptions() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
-
Returns an immutable set of options.
- getOrDefault(DataMap.DataKey<? extends K, ? extends T>, T) - Method in class net.sourceforge.pmd.util.DataMap
- getOriginalName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOriginalPath() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
Return the path as it was input by the user.
- getOriginalText() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode
-
Returns the original source code underlying this node, before any escapes have been translated.
- getOverriddenDescription() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenExamples() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenMessage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenPriority() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- getOverriddenPropertiesByPropertyDescriptor() - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Returns a modifiable map of the property descriptors that don't use default values, to their overridden value.
- getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- getOverriddenPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Returns a modifiable list of the property descriptors that don't use default values.
- 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
-
Return the node that owns this attribute.
- getParent() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- getParent() - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Retrieves this scope's parent
- getParentFsPath() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
If this file is in a nested filesystem (eg a zip file), return the file ID of the container in the outer file system.
- getParser() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Returns the parser instance.
- getPhase() - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
- getPhaseText(int) - Method in class net.sourceforge.pmd.cpd.GUI
- 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.AbstractRule
- getPriority() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the priority of this Rule.
- getPriority() - Method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Get the priority value as a number.
- getPriority() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getProcessingErrors() - Method in class net.sourceforge.pmd.reporting.Report
-
Returns an unmodifiable list of processing errors that have been recorded until now.
- getProcessor(Language) - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
-
Return the processor for a given language.
- getProperties() - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- getProperties() - Method in class net.sourceforge.pmd.util.database.DBType
- getProperties() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- 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.RuleReference
- 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.RuleReference
- 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.RuleReference
- getPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- getPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Get the descriptors of all defined properties.
- getPropertyName() - Method in enum net.sourceforge.pmd.util.database.DBType.Property
- getPropertySourceType() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- getPropertySourceType() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getPropertySourceType() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- getPropertySourceType() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- getPseudoFileName() - Method in class net.sourceforge.pmd.util.database.SourceObject
-
Gets the data source as a pseudo file name (faux-file).
- getQName() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
- getReader(String) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
- getRegion() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns a text region with the coordinates of this token.
- getRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
-
Returns a text region with the coordinates of this token.
- getRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getRegionInFile() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Returns the region in the file, or null if this was not available.
- getRegisteredExtensionFunctions() - Method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler
-
Returns the set of extension functions for this language module.
- getRelatedNodesSelector() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- getRelatedNodesSelector() - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
-
Returns an instance of
RelatedNodesSelector
, or null if it should be defaulted to using the old symbol table (ScopedNode
). - getRelativizeRoots() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns the paths used to shorten paths output in the report.
- getRelativizeRoots() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- getRendererName() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getRenderers() - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getReporter() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Returns the message reporter that is to be used while running the analysis.
- getReporter() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
The error reporter for semantic checks.
- getReporter() - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Returns the reporter for the file collection phase.
- getReporter() - Method in class net.sourceforge.pmd.PmdAnalysis
- getReportFilePath() - 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.
- getReportLocation() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- getReportLocation() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- getReportLocation() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the location at which this element should be reported.
- getReportLocation() - Method in interface net.sourceforge.pmd.reporting.Reportable
-
Returns the location at which this element should be reported.
- getReportProperties() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the Report properties.
- 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.reporting.GlobalAnalysisListener.ViolationCounterListener
- getResultImpl() - Method in class net.sourceforge.pmd.reporting.Report.GlobalReportBuilderListener
- getResultImpl() - Method in class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- getResultImpl() - Method in class net.sourceforge.pmd.reporting.ReportStatsListener
- getResultImpl() - Method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
-
Produce the final result.
- getResultType() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
-
Defines the return type of the function.
- 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.lang.rule.RuleReference
- getRule() - Method in interface net.sourceforge.pmd.reporting.RuleViolation
-
Get the Rule which identified this violation.
- getRule(RuleContext) - Static method in class net.sourceforge.pmd.reporting.InternalApiBridge
- getRuleByName(String) - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Returns the first Rule found with the given name (case-sensitive).
- getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getRuleClass() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the implementation class of this Rule.
- getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- 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
- getRuleIndex() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getRuleName() - Method in exception net.sourceforge.pmd.lang.rule.xpath.PmdXPathException
- getRules() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Returns the actual Collection of rules in this ruleset
- getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getRuleSetName() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the name of the RuleSet containing this Rule.
- getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getRuleSetPaths() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Returns the list of ruleset URIs.
- getRuleSetReference() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getRulesets() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getRulesets() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Returns an unmodifiable view of the ruleset list.
- getRuleViolation() - Method in class net.sourceforge.pmd.reporting.Report.SuppressedViolation
- 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
- getShortName() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the short name of this language.
- getShortName() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getShortName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Get the short name of this LanguageVersion.
- getSince() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getSince() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Get the version of PMD in which this Rule was added.
- getSince() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getSkipBlocksPattern() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- getSortKey() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
-
Returns the string used to sort the additional info.
- getSourceCode(String, String, String) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
-
return source code text
- getSourceCode(SourceObject) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Return source code text from the database.
- getSourceCodeNamesList() - Method in class net.sourceforge.pmd.util.database.DBURI
- getSourceCodeReturnType() - Method in class net.sourceforge.pmd.util.database.DBType
- getSourceCodeSlice(Mark) - Method in class net.sourceforge.pmd.cpd.CPDReport
-
Return the slice of source code where the mark was found.
- getSourceCodeType() - Method in class net.sourceforge.pmd.util.database.DBURI
- getSourceCodeTypes() - Method in class net.sourceforge.pmd.util.database.DBType
- getSourceCodeTypesList() - Method in class net.sourceforge.pmd.util.database.DBURI
- getSourceEncoding() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the character encoding of source files.
- getSourceObjectList() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Return all source code objects associated with any associated DBURI.
- getSourceObjectList(List<String>, List<String>, List<String>, List<String>) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Return all source code objects associated with the specified languages, schemas, source code types and source code names.
- getSourceText() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
The full text of the file to parse.
- getStandardRuleSets() - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Returns an Iterator of RuleSet objects loaded from descriptions from the "categories.properties" resource for each language.
- getStartColumn() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Inclusive, 1-based column number.
- getStartColumn() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getStartLine() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Inclusive, 1-based line number.
- getStartLine() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getStartOffset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the start offset of the current token (in the translated source), inclusive.
- getStartOffset() - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
0-based, inclusive index.
- getStartPos() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Returns the start position.
- getStartPos() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- getStringValue() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Return the string value of the attribute.
- getSubnamePrefix() - Method in class net.sourceforge.pmd.util.database.DBURI
- getSubprotocol() - Method in class net.sourceforge.pmd.util.database.DBURI
- getSuffixFromType() - Method in class net.sourceforge.pmd.util.database.SourceObject
-
Map the type to a file suffix associated with a
Language
- getSuppressedViolations() - Method in class net.sourceforge.pmd.reporting.Report
-
Returns an unmodifiable list of violations that were suppressed.
- getSuppressionComments() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
-
Returns the map of line numbers to suppression / review comments.
- getSuppressMap() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
- getSuppressMarker() - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- getSuppressMarker() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the suppress marker.
- getSuppressor() - Method in class net.sourceforge.pmd.reporting.Report.SuppressedViolation
- getTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- getTargetSelector() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Returns the object that selects the nodes to which this rule applies.
- getTargetSelector() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- getTerseName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Get the terse name of this LanguageVersion.
- getText() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
- getText() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
-
Returns the text of the token.
- getText() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode
-
Returns the source code underlying this node, after any escapes have been translated.
- getText() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns the current text of this document.
- getText() - Method in interface net.sourceforge.pmd.lang.rule.xpath.TextNode
- getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.AstInfo
-
Returns the text document that was parsed.
- getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.TokenDocument
- getTextDocument() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns the text document from which this tree was parsed.
- getTextDocument() - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
-
The text document to parse.
- getTextRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getTextRegion() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- getTextRegion() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a region of text delimiting the node in the underlying text document.
- getTextRegion() - Method in interface net.sourceforge.pmd.lang.ast.TextAvailableNode
-
Returns the exact region of text delimiting the node in the underlying text document.
- getTextRegion() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
- getThreadCount() - Method in class net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask
- getThreads() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get the number of threads to use when processing Rules.
- getThrowable() - Method in error net.sourceforge.pmd.util.ContextedAssertionError
- getThrowable() - Method in error net.sourceforge.pmd.util.ContextedStackOverflowError
- getToken(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getTokenCount() - Method in class net.sourceforge.pmd.cpd.Match
- getTokenDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the token document for the tokens being built.
- getTokenImage() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns a string made up of characters from the token mark up to to the current buffer position.
- getTokenImageCs() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns a string made up of characters from the token mark up to to the current buffer position.
- getTokenKind() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode
- getTokens() - Method in class net.sourceforge.pmd.cpd.Tokens
- getTokens(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode
- getType() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Gets the generic type of the value of this attribute.
- getType() - Method in class net.sourceforge.pmd.util.database.SourceObject
- getTypeId(PropertyDescriptor<?>) - Static method in class net.sourceforge.pmd.properties.InternalApiBridge
- getUnlabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
- getUri() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Get the input URI to process for source code objects.
- getUri() - Method in class net.sourceforge.pmd.util.database.DBURI
- getUriString() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
Return a string that looks like a URI pointing to this file.
- getURL() - Method in class net.sourceforge.pmd.util.database.DBURI
- getUserMap() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- getUserMap() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode
- getUserMap() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns a data map used to store additional information on this node.
- getUserMessage() - Method in class net.sourceforge.pmd.reporting.Report.SuppressedViolation
- getValue() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Return the value of the attribute.
- getVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersion
-
Returns the version string.
- getVersion(String) - Method in interface net.sourceforge.pmd.lang.Language
-
Returns the language version with the given version string.
- getVersion(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getVersionNamesAndAliases() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns a complete set of supported version names for this language including all aliases.
- getVersionNamesAndAliases() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getVersions() - Method in interface net.sourceforge.pmd.lang.Language
-
Returns an ordered list of supported versions for this language.
- getVersions() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- getViolationDecorator() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Returns the language-specific violation decorator.
- getViolations() - Method in class net.sourceforge.pmd.reporting.Report
-
Returns an unmodifiable list of violations that have been recorded until now.
- getVocabulary() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
- getWallClockMillis() - Method in class net.sourceforge.pmd.benchmark.TimingReport
- getWriter() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- getWriter() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Get the Writer for the Renderer.
- getXmlConstraint() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Serializes this constraint as XML attributes, that are part of the property element of a rule definition.
- 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.xpath.XPathRule
-
Returns the XPath expression that implements this rule.
- getXPathHandler() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
-
Get the XPathHandler.
- getXPathNameOfRule(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
-
Gets the xpath name of an inner node with a given
RuleContext.getRuleIndex()
. - getXPathNameOfToken(int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
-
Gets the xpath name of a terminal node with a given
Token.getType()
. - getXPathNodeName() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrErrorNode
- getXPathNodeName() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Gets the name of the node that is used to match it with XPath queries.
- getXPathNodeName() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
- getXPathNodeName() - Method in interface net.sourceforge.pmd.lang.rule.xpath.CommentNode
- getXPathNodeName() - Method in interface net.sourceforge.pmd.lang.rule.xpath.TextNode
- 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.reporting.Report.GlobalReportBuilderListener
- gobbleMaxWithoutEscape(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
- gobbleMaxWithoutEscape(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Returns the max offset, EXclusive, up to which we can cut the input array from the bufpos to dump it into the output array.
- GraphUtil - Class in net.sourceforge.pmd.util
- GraphUtil.DotColor - Enum in net.sourceforge.pmd.util
- GREEN - net.sourceforge.pmd.util.GraphUtil.DotColor
- GROUPING - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- growLeft(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns a region that ends at the same point, but starts 'delta' characters before this region.
- growRight(int) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns a region that starts at the same point, but ends 'delta' characters after this region.
- GUI - Class in net.sourceforge.pmd.cpd
- GUI() - Constructor for class net.sourceforge.pmd.cpd.GUI
H
- handleAttributeFetchException(Attribute, Exception) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
-
Handle an exception that occurred while fetching the value of an attribute.
- handleBackslash(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
- handleBackslash(int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaEscapeTranslator
- 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)
. - hasExtension(String) - Method in interface net.sourceforge.pmd.lang.Language
-
Returns whether this language handles the given file extension.
- hasFileName() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
- HASH - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- hashCode() - Method in class net.sourceforge.pmd.cpd.Mark
- hashCode() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- hashCode() - Method in class net.sourceforge.pmd.lang.document.Chars
- hashCode() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
- hashCode() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- hashCode() - Method in class net.sourceforge.pmd.lang.document.TextRegion
- hashCode() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- hashCode() - Method in class net.sourceforge.pmd.lang.LanguageVersion
- hashCode() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
- hashCode() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- hashCode() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
- hashCode() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
- hashCode() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- hashCode() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
- hashCode() - Method in class net.sourceforge.pmd.util.database.DBType
- hasImageEqualTo(String) - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns true if this node's image is equal to the given string.
- hasNext() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
- hasNext() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
- hasOverriddenAttributes() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
-
Checks whether this rule reference explicitly overrides any of the possible attributes of the referenced rule.
- hasVersion(String) - Method in interface net.sourceforge.pmd.lang.Language
-
Returns true if a language version with the given version string is registered.
- HIGH - net.sourceforge.pmd.lang.rule.RulePriority
-
High: Change absolutely required.
- HTML_EXTENSION - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
- HTMLRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to basic HTML format.
- HTMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.HTMLRenderer
I
- id - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- id() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
-
Returns the ID of this renderer, used to select it.
- IDEAJRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer for IntelliJ IDEA integration.
- IDEAJRenderer() - Constructor for class net.sourceforge.pmd.renderers.IDEAJRenderer
- imageEquals(CharSequence) - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns true if the image of this token equals the given charsequence.
- ImageFinderFunction - Class in net.sourceforge.pmd.lang.symboltable
- ImageFinderFunction(String) - Constructor for class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
- ImageFinderFunction(List<String>) - Constructor for class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
- immutableEnumSet(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns an unmodifiable set containing the given elements.
- immutableSetOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns an unmodifiable set containing the given elements.
- IMPLICIT_TOKEN - Static variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Kind for implicit tokens.
- implicitBefore(JavaccToken) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Creates an implicit token, with zero length, that is linked to the given token as its special predecessor.
- includeDeprecatedRuleReferences(boolean) - Method in class net.sourceforge.pmd.lang.rule.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.
- indexOf(int) - Method in class net.sourceforge.pmd.lang.document.Chars
- indexOf(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- indexOf(String, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- inDoubleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil
- info(String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- 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(LanguageProcessor) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Initialize the rule using the language processor if needed.
- initialize(LanguageProcessor) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- initialize(LanguageProcessor) - Method in class net.sourceforge.pmd.lang.rule.xpath.XPathRule
- initializer() - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
Provides an initializer to gather analysis context before events start occurring.
- initThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Initialize a thread, starting to track it's own time.
- injectRight(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
- input - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Source characters.
- inRange(N, N) - Static method in class net.sourceforge.pmd.properties.NumericConstraints
-
Requires the number to be inside a range.
- insertChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
-
Insert a child at the given index, shifting all the following children to the right.
- insertChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- inSingleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil
- 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 but have to live in public packages (outside `internal` packages).
- InternalApiBridge - Class in net.sourceforge.pmd.lang.ast
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.lang.document
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.lang
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.lang.rule
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.lang.rule.xpath
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.properties
-
Internal API.
- InternalApiBridge - Class in net.sourceforge.pmd.reporting
-
Internal API.
- InternalApiBridge.InternalPropertySerializer<T> - Class in net.sourceforge.pmd.properties
- InternalPropertySerializer() - Constructor for class net.sourceforge.pmd.properties.InternalApiBridge.InternalPropertySerializer
- intersect(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns the set intersection of the given collections.
- intersect(TextRegion, TextRegion) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Computes the intersection of this region with the other.
- intListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of integers.
- intProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for an integer property.
- isAttributeAccessor(Class<?>, Method) - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
-
Returns whether the given method is an attribute accessor, in which case a corresponding Attribute will be added to the iterator.
- isDefault() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- isDeprecated() - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Gets whether this Rule is deprecated.
- isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
-
Return whether this attribute was deprecated.
- isEmpty() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns 'true' if the stream has no elements.
- isEmpty() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Whether this slice is the empty string.
- isEmpty() - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns true if the region contains no characters.
- isEof() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- isEof() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns true if this token is an end-of-file token.
- isEof() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- isEof() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- isExpandedByDefaultInTree(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
- isExpandedByDefaultInTree(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
-
Returns true if the children of this node should be displayed in the treeview by default.
- isFailOnViolation() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isFailOnViolation() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
- isFindBoundary() - Method in interface net.sourceforge.pmd.lang.ast.Node
-
Returns true if this node is considered a boundary by traversal methods.
- isForceLanguageVersion() - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Is the force-language parameter set to anything?
- isHelp() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isHidden() - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrToken
- isIgnoreAnnotations() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreIdentifierAndLiteralSequences() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreIdentifiers() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreIncrementalAnalysis() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Returns whether incremental analysis was explicitly disabled by the user or not.
- isIgnoreLiterals() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreLiteralSequences() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isIgnoreUsings() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isImplicit() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns true if this token is implicit, ie was inserted artificially and has a zero-length image.
- isImplicit() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- isInjectionPending() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
- isJavaIdentifier(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
-
Returns true if the charsequence is a valid java identifier.
- isKnown() - Method in enum net.sourceforge.pmd.util.OptionalBool
-
Returns true this is not
OptionalBool.UNKNOWN
. - isLanguageSpecificDiscarding() - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
-
Extension point for subclasses to indicate tokens are to be filtered.
- isLoggable(Level) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- isNoSkipBlocks() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isOverriddenDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- isPropertyOverridden(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Returns true if the given property has been set to a value somewhere in the XML.
- isReadOnly() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Returns true if this file cannot be written to.
- isReadStdin() - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- isSame(String, String, boolean, boolean, boolean) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Are the two String values the same.
- isSet(DataMap.DataKey<? extends K, ?>) - Method in class net.sourceforge.pmd.util.DataMap
-
Returns true if the given key has a non-null value in the map.
- isShowSuppressedViolations() - Method in class net.sourceforge.pmd.PMDConfiguration
-
Get whether the report should show suppressed violations.
- isShowSuppressedViolations() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- isShowSuppressedViolations() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Get the indicator for whether to show suppressed violations.
- isSkipDuplicates() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isSkipLexicalErrors() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- isSnapshot() - Static method in class net.sourceforge.pmd.PMDVersion
-
Checks if the current version is a snapshot.
- issue() - Method in class net.sourceforge.pmd.reporting.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.
- isValidJavaPackageName(CharSequence) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- isValidRegion(int, int, TextDocument) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Checks that the parameters are a valid region, this is provided to debug, will be a noop unless assertions are enabled.
- isXPathAvailable - Variable in class net.sourceforge.pmd.properties.PropertyBuilder
- isXPathAvailable() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
-
Returns whether the property is available to XPath queries.
- iterate(T...) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- iterator() - Method in class net.sourceforge.pmd.cpd.Match
- iterator() - Method in class net.sourceforge.pmd.lang.LanguageRegistry
- IteratorUtil - Class in net.sourceforge.pmd.util
-
Operations for dealing with
Iterator
s. - IteratorUtil.AbstractIterator<T> - Class in net.sourceforge.pmd.util
-
Note, that this iterator doesn't support the
remove
operation. - IteratorUtil.AbstractPausingIterator<T> - Class in net.sourceforge.pmd.util
J
- JavaccCpdLexer - Class in net.sourceforge.pmd.cpd.impl
-
Base class for a
CpdLexer
for a language implemented by a JavaCC tokenizer. - JavaccCpdLexer() - Constructor for class net.sourceforge.pmd.cpd.impl.JavaccCpdLexer
- JavaccToken - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
A generic token implementation for JavaCC parsers.
- JavaccToken(int, String, int, int, JavaccTokenDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Constructor with a
String
image (seethe other ctor
). - JavaccToken(int, Chars, int, int, JavaccTokenDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Builds a new token of the specified kind.
- JavaccTokenDocument - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
Token document for Javacc implementations.
- JavaccTokenDocument(TextDocument, JavaccTokenDocument.TokenDocumentBehavior) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument
- JavaccTokenDocument.TokenDocumentBehavior - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
Overridable configuration of a token document.
- JavaCCTokenFilter - Class in net.sourceforge.pmd.cpd.impl
-
A generic filter for JavaCC-based token managers that allows to use comments to enable / disable analysis of parts of the stream
- JavaCCTokenFilter(TokenManager<JavaccToken>) - Constructor for class net.sourceforge.pmd.cpd.impl.JavaCCTokenFilter
-
Creates a new JavaCCTokenFilter
- JavaEscapeTranslator - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
An implementation of
EscapeTranslator
that translates Java unicode escapes. - JavaEscapeTranslator(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaEscapeTranslator
- jjtClose() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
-
This method is called after all the child nodes have been added.
- jjtOpen() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
-
This method is called after the node has been made the current node.
- JjtreeBuilder<N extends AbstractJjtreeNode<N,?>> - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
Shared implementation of the tree builder generated by JJTree.
- JjtreeBuilder() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
- JjtreeNode<N extends JjtreeNode<N>> - Interface in net.sourceforge.pmd.lang.ast.impl.javacc
-
Base interface for nodes that are produced by a JJTree parser.
- JjtreeParserAdapter<R extends RootNode> - Class in net.sourceforge.pmd.lang.ast.impl.javacc
-
Base implementation of the
Parser
interface for JavaCC language implementations. - JjtreeParserAdapter() - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- join(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
-
If both values are the same, return it.
- joinCharsIntoStringBuilder(List<Chars>, String) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- joinOn(StringBuilder, Iterable<? extends T>, BiConsumer<? super StringBuilder, ? super T>, String) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Like
String.join(CharSequence, Iterable)
, except it appends on a preexistingStringBuilder
. - JsonRenderer - Class in net.sourceforge.pmd.renderers
- JsonRenderer() - Constructor for class net.sourceforge.pmd.renderers.JsonRenderer
- JvmLanguagePropertyBundle - Class in net.sourceforge.pmd.lang
-
Base properties class for JVM languages that use a classpath to resolve references.
- JvmLanguagePropertyBundle(Language) - Constructor for class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
K
- kind - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
An integer that describes the kind of this token.
L
- LABEL_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.GUI
- Language - Interface in net.sourceforge.pmd.lang
-
Represents a language module, and provides access to language-specific functionality.
- LANGUAGE_SPECIFIC_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory
-
Subdivided into one label for each stage.
- LANGUAGE_VERSION - Static variable in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- LanguageFilenameFilter - Class in net.sourceforge.pmd.lang
-
This is an implementation of the
FilenameFilter
interface which compares a file against a collection of Languages to see if the any are applicable. - LanguageFilenameFilter(Set<Language>) - Constructor for class net.sourceforge.pmd.lang.LanguageFilenameFilter
-
Create a LanguageFilenameFilter for a List of Languages.
- LanguageFilenameFilter(Language) - Constructor for class net.sourceforge.pmd.lang.LanguageFilenameFilter
-
Create a LanguageFilenameFilter for a single Language.
- LanguageMetricsProvider - Interface in net.sourceforge.pmd.lang.metrics
-
Language-specific provider for metrics.
- LanguageModuleBase - Class in net.sourceforge.pmd.lang
-
Base class for language modules.
- LanguageModuleBase(LanguageModuleBase.LanguageMetadata) - Constructor for class net.sourceforge.pmd.lang.LanguageModuleBase
-
Construct a module instance using the given metadata.
- LanguageModuleBase.LanguageMetadata - Class in net.sourceforge.pmd.lang
-
Metadata about a language, basically a builder pattern for the language instance.
- LanguageProcessor - Interface in net.sourceforge.pmd.lang
-
Stateful object managing the analysis for a given language.
- LanguageProcessor.AnalysisTask - Class in net.sourceforge.pmd.lang
-
Configuration of an analysis, as given to
LanguageProcessor.launchAnalysis(AnalysisTask)
. - LanguageProcessorRegistry - Class in net.sourceforge.pmd.lang
-
Stores all currently initialized
LanguageProcessor
s during analysis. - LanguageProcessorRegistry.LanguageTerminationException - Exception in net.sourceforge.pmd.lang
-
An exception that occurs during the closing of a
LanguageProcessor
, - LanguagePropertyBundle - Class in net.sourceforge.pmd.lang
-
A bundle of properties used by languages (see
Language.newPropertyBundle()
). - LanguagePropertyBundle(Language) - Constructor for class net.sourceforge.pmd.lang.LanguagePropertyBundle
-
Create a new bundle for the given language.
- LanguageRegistry - Class in net.sourceforge.pmd.lang
-
A set of languages with convenient methods.
- LanguageRegistry(Set<? extends Language>) - Constructor for class net.sourceforge.pmd.lang.LanguageRegistry
-
Create a new registry that contains the given set of languages.
- LANGUAGES - net.sourceforge.pmd.util.database.DBType.Property
- LanguageTerminationException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.LanguageProcessorRegistry.LanguageTerminationException
- languageVersion - Variable in class net.sourceforge.pmd.lang.document.TextFileBuilder
- LanguageVersion - Class in net.sourceforge.pmd.lang
-
Represents a version of a
Language
. - LanguageVersionDiscoverer - Class in net.sourceforge.pmd.lang
-
This class can discover the LanguageVersion of a source file.
- LanguageVersionDiscoverer(LanguageRegistry) - Constructor for class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Build a new instance with no forced version.
- LanguageVersionDiscoverer(LanguageRegistry, LanguageVersion) - Constructor for class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Build a new instance.
- LanguageVersionHandler - Interface in net.sourceforge.pmd.lang
-
Interface for obtaining the classes necessary for checking source files of a specific language.
- last() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the last element of this stream, or
null
if the stream is empty. - last(Class<? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the last element of this stream of the given type, or
null
if there is none. - last(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- lastIndexOf(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- launchAnalysis(LanguageProcessor.AnalysisTask) - Method in class net.sourceforge.pmd.lang.impl.BatchLanguageProcessor
- launchAnalysis(LanguageProcessor.AnalysisTask) - Method in interface net.sourceforge.pmd.lang.LanguageProcessor
-
Launch the analysis based on the given
analysis task
. - length() - Method in class net.sourceforge.pmd.lang.document.Chars
- LexException - Exception in net.sourceforge.pmd.lang.ast
-
An error thrown during lexical analysis of a file.
- LexException(int, int, FileId, String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.LexException
-
Create a new exception.
- LINE_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
- lineColumnAtOffset(int) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns the line and column at the given offset (inclusive).
- lineColumnAtOffset(int, boolean) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns the line and column at the given offset.
- lineNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Returns the (1-based) line number of the character at the given index.
- lines - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
- lines() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns an iterable over the lines of this char sequence.
- LINES_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
- lineSeparator(String) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
-
Sets the string that should be used to separate lines.
- lineStream() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns a stream of lines yielded by
Chars.lines()
. - linesWithTrimIndent(Chars) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Returns a list of
- LINK_PREFIX - Static variable in class net.sourceforge.pmd.renderers.HTMLRenderer
- ListenerInitializer - Interface in net.sourceforge.pmd.reporting
-
An initializer for
GlobalAnalysisListener
that gets notified of general analysis parameters. - listOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- listOfNotNull(T) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- LOAD_RULES - net.sourceforge.pmd.benchmark.TimedOperationCategory
- loadFromResource(String) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Parses and returns a ruleset from its location.
- loadFromResources(String, String...) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Parses several resources into a list of rulesets.
- loadFromResources(Collection<String>) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Parses several resources into a list of rulesets.
- loadFromString(String, String) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Parses and returns a ruleset from string content.
- loadLanguages(ClassLoader) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Create a new registry by loading the languages registered via
ServiceLoader
on the classpath of the given classloader. - loadResourcesWith(ClassLoader) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Specify that the given classloader should be used to resolve paths to external ruleset references.
- loadRuleSetsWithoutException(RuleSetLoader, List<String>) - Static method in class net.sourceforge.pmd.lang.rule.InternalApiBridge
- location - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- location() - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
- location() - Method in exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
- location() - Method in exception net.sourceforge.pmd.lang.ast.LexException
- location() - Method in exception net.sourceforge.pmd.lang.ast.ParseException
- Location(String, int, int) - Constructor for class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
- locationAt(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
- log(Level, String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- logEx(Level, String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- 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.
- LOW - net.sourceforge.pmd.lang.rule.RulePriority
-
Low: Change highly optional.
M
- main(String[]) - Static method in class net.sourceforge.pmd.cpd.GUI
- makeCallExpression() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
-
Create a call on this function.
- makeLexerImpl(TextDocument) - Method in class net.sourceforge.pmd.cpd.impl.AntlrCpdLexer
- makeLexerImpl(TextDocument) - Method in class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- makeLexException(int, int, String, Throwable) - Method in interface net.sourceforge.pmd.cpd.TokenFactory
- makeUnmodifiableAndNonNull(List<? extends T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- MalformedSourceException - Exception in net.sourceforge.pmd.lang.ast.impl.javacc
-
A
FileAnalysisException
thrown when the source format is invalid, for example if some unicode escapes cannot be translated. - MalformedSourceException(String, Throwable, FileLocation) - Constructor for exception net.sourceforge.pmd.lang.ast.impl.javacc.MalformedSourceException
- map(Iterable<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given iterable with the given function, and accumulates it into an unmodifiable list.
- map(Collection<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given collection with the given function, and accumulates it into an unmodifiable list.
- map(Function<? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream consisting of the results of applying the given mapping function to the node of this stream.
- map(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given iterator with the given function, and accumulates it into an unmodifiable list.
- map(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- map(Collector<? super U, A, ? extends C>, Iterable<? extends T>, Function<? super T, ? extends U>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given iterable with the given function, and accumulates it into the collector.
- map(Collector<? super U, A, ? extends C>, Iterator<? extends T>, Function<? super T, ? extends U>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given iterator with the given function, and accumulates it into the collector.
- map(T[], Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Map each element of the given array with the given function, and accumulates it into an unmodifiable list.
- mapIterator(Iterable<? extends T>, Function<? super Iterator<? extends T>, ? extends Iterator<R>>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Apply a transform on the iterator of an iterable.
- mapNotNull(Iterable<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- mapNotNull(Iterator<? extends T>, Function<? super T, ? extends R>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- mapOf(K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- mapOf(K, V, K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- Mark - Class in net.sourceforge.pmd.cpd
-
A range of tokens in a source file, identified by a start and end token (both included in the range).
- markTokenStart() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Calls
CharStream.readChar()
and returns its value, marking its position as the beginning of the next token. - Match - Class in net.sourceforge.pmd.cpd
- MATCH - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
- MATCHES_COMPARATOR - Static variable in class net.sourceforge.pmd.cpd.Match
- max(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
- MEDIUM - net.sourceforge.pmd.lang.rule.RulePriority
-
Medium: Change recommended.
- MEDIUM_HIGH - net.sourceforge.pmd.lang.rule.RulePriority
-
Medium to high: Change highly recommended.
- MEDIUM_LOW - net.sourceforge.pmd.lang.rule.RulePriority
-
Medium to low: Change optional.
- mergeMaps(Map<K, V>, Map<K, V>, BinaryOperator<V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Merge the second map into the first.
- METHOD - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- METHOD_NAME - Static variable in interface net.sourceforge.pmd.reporting.RuleViolation
-
Key in
RuleViolation.getAdditionalInfo()
for the name of the method in which the violation was identified. - Metric<N extends Node,R extends Number> - Interface in net.sourceforge.pmd.lang.metrics
-
A named computation that can be carried out on some nodes.
- MetricOption - Interface in net.sourceforge.pmd.lang.metrics
-
Option to pass to a metric.
- MetricOptions - Class in net.sourceforge.pmd.lang.metrics
-
Bundles a set of options to pass to a metric.
- MetricsUtil - Class in net.sourceforge.pmd.lang.metrics
-
Utilities to use
Metric
instances. - min(OptionalBool, OptionalBool) - Static method in enum net.sourceforge.pmd.util.OptionalBool
- mustBe(String, Object, String) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- mustBe(String, Object, String, Function<String, E>) - Static method in class net.sourceforge.pmd.util.AssertionUtil
N
- name - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
- name() - Method in interface net.sourceforge.pmd.lang.metrics.MetricOption
-
Returns the name of the option constant.
- name() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
-
The name of the property without spaces as it serves as the key into the property map.
- name(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Record the display name of the language.
- NAME - 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.
- NameDeclaration - Interface in net.sourceforge.pmd.lang.symboltable
-
This is a declaration of a name, e.g.
- NameOccurrence - Interface in net.sourceforge.pmd.lang.symboltable
-
A
NameOccurrence
represents one usage of a name declaration. - net.sourceforge.pmd - package net.sourceforge.pmd
-
This is the PMD programming mistake detector.
- net.sourceforge.pmd.annotation - package net.sourceforge.pmd.annotation
- net.sourceforge.pmd.benchmark - package net.sourceforge.pmd.benchmark
- net.sourceforge.pmd.cache - package net.sourceforge.pmd.cache
-
The violation caching system.
- net.sourceforge.pmd.cpd - package net.sourceforge.pmd.cpd
-
Token-based copy-paste detection.
- net.sourceforge.pmd.cpd.impl - package net.sourceforge.pmd.cpd.impl
-
Utilities to implement a CPD
CpdLexer
. - net.sourceforge.pmd.lang - package net.sourceforge.pmd.lang
- net.sourceforge.pmd.lang.ast - package net.sourceforge.pmd.lang.ast
- net.sourceforge.pmd.lang.ast.impl - package net.sourceforge.pmd.lang.ast.impl
- net.sourceforge.pmd.lang.ast.impl.antlr4 - package net.sourceforge.pmd.lang.ast.impl.antlr4
- net.sourceforge.pmd.lang.ast.impl.javacc - package net.sourceforge.pmd.lang.ast.impl.javacc
-
Support classes for language implementations based on JavaCC.
- net.sourceforge.pmd.lang.document - package net.sourceforge.pmd.lang.document
-
Contains types to model text files and handle operations on text.
- net.sourceforge.pmd.lang.impl - package net.sourceforge.pmd.lang.impl
- net.sourceforge.pmd.lang.metrics - package net.sourceforge.pmd.lang.metrics
-
Language-independent framework to represent code metrics.
- net.sourceforge.pmd.lang.rule - package net.sourceforge.pmd.lang.rule
- net.sourceforge.pmd.lang.rule.xpath - package net.sourceforge.pmd.lang.rule.xpath
- net.sourceforge.pmd.lang.rule.xpath.impl - package net.sourceforge.pmd.lang.rule.xpath.impl
- net.sourceforge.pmd.lang.symboltable - package net.sourceforge.pmd.lang.symboltable
- net.sourceforge.pmd.properties - package net.sourceforge.pmd.properties
- net.sourceforge.pmd.renderers - package net.sourceforge.pmd.renderers
- net.sourceforge.pmd.reporting - package net.sourceforge.pmd.reporting
-
Logic about reporting: violations, suppression etc.
- net.sourceforge.pmd.util - package net.sourceforge.pmd.util
- net.sourceforge.pmd.util.database - package net.sourceforge.pmd.util.database
- 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
- newCollector(FileCollector, PmdReporter) - Static method in class net.sourceforge.pmd.lang.document.InternalApiBridge
- newCollector(LanguageVersionDiscoverer, PmdReporter) - Static method in class net.sourceforge.pmd.lang.document.InternalApiBridge
- newDataMap() - Static method in class net.sourceforge.pmd.util.DataMap
- newException(Level, Throwable, String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
-
Logs and returns a new exception.
- newImplicit(int, JavaccTokenDocument) - Static method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Returns a new implicit token, positioned at the given offset.
- newLexException(boolean, String, int, int, String, char) - Static method in class net.sourceforge.pmd.lang.ast.InternalApiBridge
- newListener() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
- newListener() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Returns a new analysis listener, that handles violations by rendering them in an implementation-defined way.
- newPropertyBundle() - Method in interface net.sourceforge.pmd.lang.Language
-
Creates a new bundle of properties that will serve to configure the
LanguageProcessor
for this language. - newPropertyBundle() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
-
Returns a new property bundle, that can be used to configure the output of
TreeRendererDescriptor.produceRenderer(PropertySource)
. - newReader() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns a new reader for the whole contents of this char sequence.
- newReader() - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a reader over the text of this document.
- newRuleSetLoader() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Returns a new ruleset loader, which can be used to create new rulesets (add them then with
PmdAnalysis.addRuleSet(RuleSet)
). - newXPathRule() - Static method in class net.sourceforge.pmd.lang.rule.xpath.InternalApiBridge
- next - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
A reference to the next regular (non-special) token from the input stream.
- next() - Method in class net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator
- next() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
- next() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- NO - net.sourceforge.pmd.util.OptionalBool
- NO_REPLACEMENT - Static variable in annotation type net.sourceforge.pmd.lang.rule.xpath.DeprecatedAttribute
-
Sentinel expressing that the attribute is deprecated without replacement.
- NoAttribute - Annotation Type in net.sourceforge.pmd.lang.rule.xpath
-
Filters out some methods from the XPath attributes of a node.
- NoAttribute.NoAttrScope - Enum in net.sourceforge.pmd.lang.rule.xpath
- node - Variable in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
- Node - Interface in net.sourceforge.pmd.lang.ast
-
Root interface for all AST nodes.
- nodeArity() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Returns the number of children on the stack in the current node scope.
- nodeCreated() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Determines whether the current node was actually closed and pushed.
- NodeStream<T extends Node> - Interface in net.sourceforge.pmd.lang.ast
-
A sequence of AST nodes.
- NodeStream.DescendantNodeStream<T extends Node> - Interface in net.sourceforge.pmd.lang.ast
-
A specialization of
NodeStream
that allows configuring tree traversal behaviour when traversing the descendants of a node. - noFunctionDefinitions() - Static method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathHandler
- nonAlphaNumName(String) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrNameDictionary
-
Override this to customize the XPath name of tokes with no symbolic name and with an image that is non-alphanumeric.
- none(Iterable<? extends N>, Predicate<? super N>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns true if no element of the iterable matches the predicate.
- none(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns whether no elements of this stream match the provided predicate.
- noneMatch(Iterator<? extends T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Returns whether no elements match the predicate.
- nonEmpty() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns 'true' if the stream has at least one element.
- noop() - Static method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
- noop() - Static method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
A listener that does nothing.
- noop() - Static method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
A listener that does nothing.
- noop() - Static method in interface net.sourceforge.pmd.reporting.ListenerInitializer
-
A listener that does nothing.
- noop() - Static method in interface net.sourceforge.pmd.reporting.ViolationDecorator
- NOPMD_COMMENT_SUPPRESSOR - Static variable in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
Suppressor for regular NOPMD comments.
- NORMALIZED_LINE_TERM - Static variable in class net.sourceforge.pmd.lang.document.TextFileContent
-
The normalized line ending used to replace platform-specific line endings in the normalized text.
- NORMALIZED_LINE_TERM_CHAR - Static variable in class net.sourceforge.pmd.lang.document.TextFileContent
-
The normalized line ending as a char.
- NULL_CHARACTER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- nullToEmpty(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Return the empty string if the parameter is null.
- NumericConstraints - Class in net.sourceforge.pmd.properties
-
Common constraints for properties dealing with numbers.
- numErrors() - Method in interface net.sourceforge.pmd.util.log.PmdReporter
-
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.
- offsetAtLineColumn(TextPos2d) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Calculates the offset from a given line/column.
- ofId(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
-
Gets an XPath version from the string used to represent it in the XML.
- ofOptional(Optional<? extends T>) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing zero or one node, depending on whether the optional is empty or not.
- ofOptions(Collection<? extends MetricOption>) - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions
-
Gets an options bundle from a collection of options.
- ofOptions(MetricOption, MetricOption...) - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions
-
Gets an options bundle from options.
- onConfigError(Report.ConfigurationError) - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
Record a configuration error.
- onConfigError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.reporting.Report.GlobalReportBuilderListener
- onError(Report.ProcessingError) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
Handle an error that occurred while processing a file.
- onError(Report.ProcessingError) - Method in class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- onlyRecognizeLanguages(LanguageRegistry) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Make it so that the only extensions that are considered are those of the given language.
- onRuleViolation(RuleViolation) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
Handle a new violation (not suppressed).
- onRuleViolation(RuleViolation) - Method in class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- onSuppressedRuleViolation(Report.SuppressedViolation) - Method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
Handle a new suppressed violation.
- onSuppressedRuleViolation(Report.SuppressedViolation) - Method in class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- 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
- OPTIONAL_DECIMAL - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
- OPTIONAL_STRING - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
- OptionalBool - Enum in net.sourceforge.pmd.util
-
Represents a boolean that may not be present.
- OUTPUT_DIR - Static variable in class net.sourceforge.pmd.renderers.YAHTMLRenderer
- outputReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
-
Output the report, called once at the end of the analysis.
- outputReport(Report) - Method in class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
- outputReport(Report) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
- outputReport(Report) - Method in class net.sourceforge.pmd.renderers.YAHTMLRenderer
- overlaps(TextRegion) - Method in class net.sourceforge.pmd.lang.document.TextRegion
-
Returns true if this region overlaps the other region by at least one character.
P
- PACKAGE_NAME - Static variable in interface net.sourceforge.pmd.reporting.RuleViolation
-
Key in
RuleViolation.getAdditionalInfo()
for the name of the package in which the violation was identified. - parentFsId - Variable in class net.sourceforge.pmd.lang.document.TextFileBuilder
- parents() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the (first-degree) parents of the nodes contained in this stream.
- parse(Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
- parse(Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- parse(Parser.ParserTask) - Method in interface net.sourceforge.pmd.lang.ast.Parser
-
Parses an entire tree for this language.
- parse(Lexer, Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrBaseParser
- ParseException - Exception in net.sourceforge.pmd.lang.ast
- ParseException(JavaccToken, int[][]) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
-
This constructor is called by Javacc.
- ParseException(String) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
- ParseException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.ParseException
- parseImpl(CharStream, Parser.ParserTask) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- Parser - Interface in net.sourceforge.pmd.lang.ast
-
Produces an AST from a source file.
- PARSER - net.sourceforge.pmd.benchmark.TimedOperationCategory
- Parser.ParserTask - Class in net.sourceforge.pmd.lang.ast
-
Parameters passed to a parsing task.
- ParserTask(TextDocument, SemanticErrorReporter, LanguageProcessorRegistry) - Constructor for class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- PASCAL_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention
-
PascalCase.
- PASSWORD - net.sourceforge.pmd.util.database.DBType.Property
- path - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Location
- peek(Consumer<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
- peek(Iterator<? extends T>, Consumer<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- peekLastToken() - Method in interface net.sourceforge.pmd.cpd.TokenFactory
-
Returns the last token that has been recorded in this file.
- peekNode() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Returns the node currently on the top of the stack.
- peekNode(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Peek the nth node from the top of the stack.
- percentageString(double, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Formats a double to a percentage, keeping
numDecimal
decimal places. - performAnalysis() - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
- performAnalysis() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Run PMD with the current state of this instance.
- performAnalysis(Consumer<CPDReport>) - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
- performAnalysisAndCollectReport() - Method in class net.sourceforge.pmd.PmdAnalysis
-
Run PMD with the current state of this instance.
- 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
- PlainTextLanguage - Class in net.sourceforge.pmd.lang
-
A dummy language implementation whose parser produces a single node.
- PlainTextLanguage.PlainTextFile - Class in net.sourceforge.pmd.lang
-
The only node produced by the parser of
PlainTextLanguage
. - plus(List<V>, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Produce a new list with the elements of the first, and one additional item.
- plus(Map<K, V>, K, V) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Produce a new map with the mappings of the first, and one additional mapping.
- PMD - Static variable in class net.sourceforge.pmd.lang.LanguageRegistry
-
Contains the languages that support PMD and are found on the classpath of the classloader of this class.
- PmdAnalysis - Class in net.sourceforge.pmd
-
Main programmatic API of PMD.
- PmdCapableLanguage - Interface in net.sourceforge.pmd.lang
-
A language that supports
PMD
. - PMDConfiguration - Class in net.sourceforge.pmd
-
This class contains the details for the runtime configuration of a PMD run.
- PMDConfiguration() - Constructor for class net.sourceforge.pmd.PMDConfiguration
- PMDConfiguration(LanguageRegistry) - Constructor for class net.sourceforge.pmd.PMDConfiguration
- PmdReporter - Interface in net.sourceforge.pmd.util.log
-
Façade to report user-facing messages (info, warning and error).
- 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.
- pos2d(int, int) - Static method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Builds a new region from offset and length.
- positive() - Static method in class net.sourceforge.pmd.properties.NumericConstraints
-
Requires the number to be strictly positive.
- precedingSiblings() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the preceding siblings of the nodes contained in this stream.
- prepareViewOn(T) - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractPausingIterator
- prepend(NodeStream<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a new node stream that contains all the elements of the given stream, then all the elements of this stream.
- prependAuxClasspath(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Prepend the specified classpath like string to the current ClassLoader of the configuration.
- previousSpecials(T) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns an iterable that enumerates all special tokens belonging to the given token.
- ProcessingError(Throwable, FileId) - Constructor for class net.sourceforge.pmd.reporting.Report.ProcessingError
-
Creates a new processing error
- processToken(TokenFactory, T) - Method in class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- produceRenderer(PropertySource) - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
-
Builds a new renderer from the given properties.
- PropertyBuilder<B extends PropertyBuilder<B,T>,T> - Class in net.sourceforge.pmd.properties
-
Base class for generic property builders.
- PropertyBuilder.GenericCollectionPropertyBuilder<V,C extends Iterable<V>> - Class in net.sourceforge.pmd.properties
-
Generic builder for a collection-valued property.
- PropertyBuilder.GenericPropertyBuilder<T> - Class in net.sourceforge.pmd.properties
-
Generic builder for a single-value property.
- PropertyBuilder.RegexPropertyBuilder - Class in net.sourceforge.pmd.properties
-
Specialized builder for regex properties.
- PropertyConstraint<T> - Interface in net.sourceforge.pmd.properties
-
Validates the value of a property.
- PropertyDescriptor<T> - Class in net.sourceforge.pmd.properties
-
Describes a property of a rule or a renderer.
- PropertyFactory - Class in net.sourceforge.pmd.properties
-
Provides factory methods for common property types.
- PropertySerializer<T> - Class in net.sourceforge.pmd.properties
-
Strategy to serialize a value to and from strings.
- PropertySource - Interface in net.sourceforge.pmd.properties
-
Entity that manages a list of properties.
- pushNewRecursionContext(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- pushNode(N) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Pushes a node on to the stack.
Q
- quiet() - Static method in interface net.sourceforge.pmd.util.log.PmdReporter
-
Returns a reporter instance that does not output anything, but still counts errors.
- quoteMessageFormat(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Escape the string so that it appears literally when interpreted by a
MessageFormat
.
R
- range(FileId, TextRange2d) - Static method in class net.sourceforge.pmd.lang.document.FileLocation
-
Creates a new location for a range of text.
- range(T, T) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns an iterator that enumerates all (non-special) tokens between the two tokens (bounds included).
- range2d(int, int, int, int) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d
- range2d(TextPos2d, TextPos2d) - Static method in class net.sourceforge.pmd.lang.document.TextRange2d
- readChar() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.CharStream
-
Returns the next character from the input.
- readContents() - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Reads the contents of the underlying character source.
- ReadOnlyFileException - Exception in net.sourceforge.pmd.lang.document
-
Thrown when an attempt to write through a
TextFile
fails because the file is read-only. - ReadOnlyFileException(TextFile) - Constructor for exception net.sourceforge.pmd.lang.document.ReadOnlyFileException
- readOnlyString(CharSequence, FileId, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a read-only document for the given text.
- readOnlyString(CharSequence, LanguageVersion) - Static method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a read-only document for the given text.
- recordDelta(int, int, Chars) - Method in class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
-
Add a new fragment.
- recordEscape(int, int, Chars) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.BackslashEscapeTranslator
- recordEscape(int, int, Chars) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
- recordToken(String, int, int, int, int) - Method in interface net.sourceforge.pmd.cpd.TokenFactory
-
Record a token given its coordinates.
- recordToken(String, FileLocation) - Method in interface net.sourceforge.pmd.cpd.TokenFactory
-
Record a token given its coordinates.
- reduce(R, BiFunction<? super R, ? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Reduce the elements of this stream sequentially.
- REGEX_SUPPRESSOR - Static variable in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
Suppressor for the violationSuppressRegex property.
- regexProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a regex property.
- register(TreeRendererDescriptor) - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers
-
Registers the given renderer.
- registeredRenderers() - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers
-
Returns the set of renderers currently registered.
- RelatedNodesSelector - Interface in net.sourceforge.pmd.util.designerbindings
-
Provides a way for the designer to highlight related nodes upon selection, eg those nodes referring to the same variable or method.
- relativizeWith(Path) - Method in class net.sourceforge.pmd.reporting.ConfigurableFileNameRenderer
-
Add a prefix that is used to relativize file paths as their display name.
- remediation_points - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- REMEDIATION_POINTS_DEFAULT - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- remove() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- remove() - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
-
This implementation throws an instance of
UnsupportedOperationException
and performs no other action. - removeChildAtIndex(int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- removedInvalidXml10Characters(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Remove characters, that are not allowed in XML 1.0 documents.
- removeDoubleQuotes(String) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Like
removeSurrounding
with a double quote as a delimiter. - removeDysfunctionalRules(Collection<Rule>) - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Remove and collect any misconfigured rules.
- removePrefix(String) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Remove the prefix if it is present, otherwise returns this.
- removeSuffix(String) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Remove the suffix if it is present, otherwise returns this.
- removeSurrounding(String, char) - Static method in class net.sourceforge.pmd.util.StringUtil
-
If the string starts and ends with the delimiter, returns the substring within the delimiters.
- render(TimingReport, Writer) - Method in class net.sourceforge.pmd.benchmark.TextTimingReportRenderer
- render(TimingReport, Writer) - Method in interface net.sourceforge.pmd.benchmark.TimingReportRenderer
-
Renders the given report into the given writer.
- render(CPDReport, Writer) - Method in interface net.sourceforge.pmd.cpd.CPDReportRenderer
-
Write out the contents of the report to the given writer.
- render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.CSVRenderer
- render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.SimpleRenderer
- render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.VSRenderer
- render(CPDReport, Writer) - Method in class net.sourceforge.pmd.cpd.XMLRenderer
- renderBody(PrintWriter, Report) - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
-
Write the body of the main body of the HTML content.
- Renderer - Interface in net.sourceforge.pmd.renderers
-
This is an interface for rendering a Report.
- RendererFactory - Class in net.sourceforge.pmd.renderers
-
This class handles the creation of Renderers.
- renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
-
Render the given file Report.
- renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
- renderFileReport(Report) - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
- renderFileReport(Report) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Render the given file Report.
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
-
Render a series of
RuleViolation
s. - renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.CodeClimateRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.CSVRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.EmacsRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.IDEAJRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.JsonRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.SarifRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.TextPadRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.TextRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
- renderFileViolations(Iterator<RuleViolation>) - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- renderProlog(boolean) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
-
Sets whether to render an XML prolog or not.
- renderSubtree(Node, Appendable) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
- renderSubtree(Node, Appendable) - Method in interface net.sourceforge.pmd.util.treeexport.TreeRenderer
-
Appends the subtree rooted at the given node on the provided output writer.
- renderSubtree(Node, Appendable) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer
-
Appends the subtree rooted at the given node on the provided output writer.
- renderToString(CPDReport) - Method in interface net.sourceforge.pmd.cpd.CPDReportRenderer
-
Call the other render method on a StringWriter.
- replaceImage(CharStream) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Returns a new token with the same kind as this one, whose image is replaced by the one marked on the char stream.
- replacementIfDeprecated(Attribute) - Static method in class net.sourceforge.pmd.lang.rule.xpath.InternalApiBridge
- replaceWith() - Method in annotation type net.sourceforge.pmd.lang.rule.xpath.DeprecatedAttribute
-
An XPath expression to suggest as a replacement for use of the deprecated attribute.
- Report - Class in net.sourceforge.pmd.reporting
-
A
Report
collects all information during a PMD execution. - Report.ConfigurationError - Class in net.sourceforge.pmd.reporting
-
Represents a configuration error.
- Report.GlobalReportBuilderListener - Class in net.sourceforge.pmd.reporting
-
A
GlobalAnalysisListener
that accumulates the events of all files into aReport
. - Report.ProcessingError - Class in net.sourceforge.pmd.reporting
-
Represents a processing error, such as a parse error.
- Report.ReportBuilderListener - Class in net.sourceforge.pmd.reporting
-
A
FileAnalysisListener
that accumulates events into aReport
. - Report.SuppressedViolation - Class in net.sourceforge.pmd.reporting
-
Represents a violation, that has been suppressed.
- Reportable - Interface in net.sourceforge.pmd.reporting
-
Interface implemented by those objects that can be the target of a
RuleViolation
. - ReportBuilderListener() - Constructor for class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- REPORTING - net.sourceforge.pmd.benchmark.TimedOperationCategory
- ReportStats - Class in net.sourceforge.pmd.reporting
-
Summarized info about a report.
- ReportStatsListener - Class in net.sourceforge.pmd.reporting
-
Collects summarized info about a PMD run.
- ReportStatsListener() - Constructor for class net.sourceforge.pmd.reporting.ReportStatsListener
- reportToLogger(PmdReporter) - Static method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
-
Forwards to a
PmdReporter
, except trace and debug messages which are reported on a logger. - require(PropertyConstraint<? super C>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
- require(PropertyConstraint<? super T>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
-
Add a constraint on the values that this property may take.
- requireContainsNoNullValue(String, Collection<?>) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireEach(PropertyConstraint<? super V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
-
Require that the given constraint be fulfilled on each item of the value of this property.
- requireIndexNonNegative(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireInExclusiveRange(String, int, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireInInclusiveRange(String, int, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireInNonNegativeRange(String, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireInPositiveRange(String, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireInRange(String, int, int, int, boolean) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireNonNegative(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireNotEmpty(String, Collection<?>) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireOver1(String, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- requireParamNotNull(String, T) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- reset() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Call this to reinitialize the node stack.
- resolve(String, String) - Method in class net.sourceforge.pmd.util.database.ResourceResolver
- ResourceLoader - Class in net.sourceforge.pmd.util.database
-
Helper class for retrieving resources relative to the installation.
- ResourceLoader() - Constructor for class net.sourceforge.pmd.util.database.ResourceLoader
- ResourceResolver - Class in net.sourceforge.pmd.util.database
- ResourceResolver() - Constructor for class net.sourceforge.pmd.util.database.ResourceResolver
- RETURN_TYPE - net.sourceforge.pmd.util.database.DBType.Property
- returnSourceCodeObjectsStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Procedural statement to return list of source code objects.
- returnSourceCodeStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Procedural statement to return source code.
- returnType - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
-
Types
value representing the type returned byDBMSMetadata.callableStatement
Currently only java.sql.Types.String and java.sql.Types.Clob are supported - reverse(Iterator<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- rootNode() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeBuilder
-
Returns the root node of the AST.
- RootNode - Interface in net.sourceforge.pmd.lang.ast
-
This interface identifies the root node of an AST.
- rule() - Method in class net.sourceforge.pmd.reporting.Report.ConfigurationError
-
Gets the wrongly configured rule.
- Rule - Interface in net.sourceforge.pmd.lang.rule
-
This is the basic Rule interface for PMD rules.
- RULE - net.sourceforge.pmd.benchmark.TimedOperationCategory
-
Rule execution proper.
- RULE_AST_INDEXATION - net.sourceforge.pmd.benchmark.TimedOperationCategory
- RuleContext - Class in net.sourceforge.pmd.reporting
-
The API for rules to report violations or errors during analysis.
- RulePriority - Enum in net.sourceforge.pmd.lang.rule
-
These are the possible Rule priority values.
- RuleReference - Class in net.sourceforge.pmd.lang.rule
-
This class represents a Rule which is a reference to Rule defined in another RuleSet.
- RuleReference(Rule, RuleSetReference) - Constructor for class net.sourceforge.pmd.lang.rule.RuleReference
-
Create a new reference to the given rule.
- RuleSet - Class in net.sourceforge.pmd.lang.rule
-
This class represents a collection of rules along with some optional filter patterns that can preclude their application on specific files.
- RuleSet(RuleSet) - Constructor for class net.sourceforge.pmd.lang.rule.RuleSet
- RULESET_2_0_0_NS_URI - Static variable in class net.sourceforge.pmd.lang.rule.RuleSetWriter
- ruleSetApplies(Rule, LanguageVersion) - Static method in class net.sourceforge.pmd.lang.rule.InternalApiBridge
- ruleSetApplies(RuleSet, FileId) - Static method in class net.sourceforge.pmd.lang.rule.InternalApiBridge
- RuleSetLoader - Class in net.sourceforge.pmd.lang.rule
-
Configurable object to load rulesets from XML resources.
- RuleSetLoader() - Constructor for class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Create a new RuleSetLoader with a default configuration.
- RuleSetLoadException - Exception in net.sourceforge.pmd.lang.rule
-
An exception that is thrown when something wrong occurs while loading rulesets.
- RuleSetWriter - Class in net.sourceforge.pmd.lang.rule
-
This class represents a way to serialize a RuleSet to an XML configuration file.
- RuleSetWriter(OutputStream) - Constructor for class net.sourceforge.pmd.lang.rule.RuleSetWriter
- RuleTargetSelector - Class in net.sourceforge.pmd.lang.rule
-
A strategy for selecting nodes that will be targeted by a rule.
- RuleViolation - Interface in net.sourceforge.pmd.reporting
-
A RuleViolation is created by a Rule when it identifies a violation of the Rule constraints.
- runAndReturnStats() - Method in class net.sourceforge.pmd.PmdAnalysis
S
- SarifRenderer - Class in net.sourceforge.pmd.renderers
- SarifRenderer() - Constructor for class net.sourceforge.pmd.renderers.SarifRenderer
- SCHEMAS - net.sourceforge.pmd.util.database.DBType.Property
- scope() - Method in annotation type net.sourceforge.pmd.lang.rule.xpath.NoAttribute
-
When applied to a type declaration, this value determines which XPath attributes are filtered out.
- Scope - Interface in net.sourceforge.pmd.lang.symboltable
-
A scope is a region within variables and other declarations are visible.
- ScopedNode - Interface in net.sourceforge.pmd.lang.symboltable
-
A
Node
which knows about the scope within it has been declared. - SCREAMING_SNAKE_CASE - net.sourceforge.pmd.util.StringUtil.CaseConvention
-
SCREAMING_SNAKE_CASE.
- SemanticErrorReporter - Interface in net.sourceforge.pmd.lang.ast
-
Reports errors that occur after parsing.
- SemanticException - Exception in net.sourceforge.pmd.lang.ast
-
An error that occurs after validating a file.
- SemanticException() - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
- SemanticException(String) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
- SemanticException(String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
- SemanticException(Throwable) - Constructor for exception net.sourceforge.pmd.lang.ast.SemanticException
- sempred(BaseAntlrInnerNode<N>, int, int) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.AntlrGeneratedParserBase
- serializer() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
-
Returns the strategy used to read and write this property to XML.
- services() - Method in interface net.sourceforge.pmd.lang.LanguageProcessor
-
A collection of extension points implemented by the language.
- set(DataMap.DataKey<? extends K, ? super T>, T) - Method in class net.sourceforge.pmd.util.DataMap
-
Set the mapping to the given data.
- setAnalysisCacheLocation(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Sets the location of the analysis cache to be used.
- setCharacterSet(String) - Method in class net.sourceforge.pmd.util.database.DBURI
- setCharset(Charset) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Sets the charset to use for subsequent calls to
FileCollector.addFile(Path)
and other overloads using aPath
. - setChild(B, int) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
-
Set the child at the given index.
- setClassLoader(ClassLoader) - Method in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
-
Set the classloader to use for analysis.
- setClassLoader(ClassLoader) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the ClassLoader being used by PMD when processing Rules.
- setCpdListener(CPDListener) - Method in class net.sourceforge.pmd.cpd.CpdAnalysis
- setDbType(DBType) - Method in class net.sourceforge.pmd.util.database.DBURI
- setDefaultLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the given LanguageVersion as the current default for it's Language.
- setDefaultLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
-
Set the given LanguageVersion as the current default for it's Language.
- setDefaultLanguageVersions(List<LanguageVersion>) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the given LanguageVersions as the current default for their Languages.
- setDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setDeprecated(boolean) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Sets whether this Rule is deprecated.
- setDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setDescription(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setDescription(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the description of this Rule.
- setDescription(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setDescription(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- setDescription(String) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Set the description of the Renderer.
- setDriverClass(String) - Method in class net.sourceforge.pmd.util.database.DBURI
- setEncoding(String) - Method in class net.sourceforge.pmd.cpd.XMLRenderer
- setExcludes(List<Path>) - Method in class net.sourceforge.pmd.AbstractConfiguration
- setExternalInfoUrl(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setExternalInfoUrl(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set a URL for external information about this Rule.
- setExternalInfoUrl(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setFailOnViolation(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setFailOnViolation(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Sets whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
- setFile(Path) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setFileFilter(Predicate<FileId>) - Method in class net.sourceforge.pmd.lang.document.FileCollector
-
Sets an additional filter that is being called before adding the file to the list.
- setFileId(FileId) - Method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
- setFileId(FileId) - Method in exception net.sourceforge.pmd.lang.ast.LexException
-
Replace the file name of this error.
- setFileNameRenderer(FileNameRenderer) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- setFileNameRenderer(FileNameRenderer) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Set the
FileNameRenderer
used to render file paths to the report. - setFileNameRenderer(FileNameRenderer) - Method in interface net.sourceforge.pmd.reporting.ListenerInitializer
-
Notify this listener that the given
FileNameRenderer
will be used by default for this analysis. - setFirstToken(JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- setForcedVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
- setForceLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the LanguageVersion specified by the force-language parameter.
- setFormat(String) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setHelp(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreAnnotations(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreFilePath(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
The input file path points to a single file, which contains a comma-separated list of source file names to ignore.
- setIgnoreIdentifierAndLiteralSequences(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreIdentifiers(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreIncrementalAnalysis(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Sets whether the user has explicitly disabled incremental analysis or not.
- setIgnoreLiterals(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreLiteralSequences(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setIgnoreUsings(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setImage(String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- setImage(TokenEntry, String) - Method in interface net.sourceforge.pmd.cpd.TokenFactory
-
Sets the image of an existing token entry.
- setInputFilePath(Path) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
The input file path points to a single file, which contains a comma-separated list of source file names to process.
- setInputPathList(List<Path>) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the input paths to the given list of paths.
- setInputUri(URI) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the input URI to process for source code objects.
- setLanguage(Language) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setLanguage(Language) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the Language of this Rule.
- setLanguage(Language) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setLanguage(Language) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setLanguageProperties(Properties) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setLanguagesList(List<String>) - Method in class net.sourceforge.pmd.util.database.DBURI
- setLanguageVersion(String) - Method in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- setLastToken(JavaccToken) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
- setMaximumLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setMaximumLanguageVersion(LanguageVersion) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the maximum LanguageVersion to which this Rule applies.
- setMaximumLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setMessage(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setMessage(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the message to show when this Rule identifies a violation.
- setMessage(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setMessageReporter(PmdReporter) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setMinimumLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setMinimumLanguageVersion(LanguageVersion) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the minimum LanguageVersion to which this Rule applies.
- setMinimumLanguageVersion(LanguageVersion) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setMinimumPriority(RulePriority) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the minimum priority threshold when loading Rules from RuleSets.
- setMinimumTileSize(int) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setName(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setName(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the name of this Rule.
- setName(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setName(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- setName(String) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Set the name of the Renderer.
- setName(String) - Method in class net.sourceforge.pmd.util.database.SourceObject
- setNext(T) - Method in class net.sourceforge.pmd.util.IteratorUtil.AbstractIterator
- setNoSkipBlocks(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setNumberOfFilesToAnalyze(int) - Method in interface net.sourceforge.pmd.reporting.ListenerInitializer
-
Notifies the total number of files collected for analysis.
- setOf(T, T...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns a set containing the given elements.
- setOnlyRecognizeLanguage(Language) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Make it so that the only extensions that are considered are those of the given language.
- setParameters(Map<String, String>) - Method in class net.sourceforge.pmd.util.database.DBURI
- setParent(B) - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- setParent(Scope) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
- setParent(Scope) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
-
Points this scope to its parent
- setParent(RuleContext) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode.PmdAsAntlrInnerNode
- setParent(RuleContext) - Method in class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrTerminalNode.AntlrTerminalPmdAdapter
- setParentFsPath(FileId) - Method in class net.sourceforge.pmd.lang.document.TextFileBuilder
- setPriority(RulePriority) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setPriority(RulePriority) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the priority of this Rule.
- setPriority(RulePriority) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setProperties(Properties) - Method in class net.sourceforge.pmd.util.database.DBType
- setProperties(Properties) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setProperty(PropertyDescriptor<T>, T) - Method in class net.sourceforge.pmd.lang.JvmLanguagePropertyBundle
- setProperty(PropertyDescriptor<T>, T) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setProperty(PropertyDescriptor<T>, T) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
- setProperty(PropertyDescriptor<T>, T) - Method in interface net.sourceforge.pmd.properties.PropertySource
-
Set the property value specified.
- setReadStdin(boolean) - Method in class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- setRecursive(boolean) - Method in class net.sourceforge.pmd.lang.document.FileCollector
- setRendererName(String) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setReporter(PmdReporter) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Sets the message reporter that is to be used while running the analysis.
- setReportFile(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
-
Sets the filename where the report should be written to.
- setReportFile(String) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Sets the filename where the report should be written to.
- setReportFile(String) - Method in class net.sourceforge.pmd.renderers.SarifRenderer
- setReportFile(String) - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- setReportFile(Path) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the file to which the report should render.
- setReportFormat(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the report format.
- setReportProperties(Properties) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the Report properties.
- setRevision(String) - Method in class net.sourceforge.pmd.util.database.SourceObject
- setRuleClass(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setRuleClass(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the class of this Rule.
- setRuleClass(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setRuleSetName(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setRuleSetName(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the name of the RuleSet containing this Rule.
- setRuleSetName(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setRuleSets(List<String>) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Sets the list of ruleset paths to load when starting the analysis.
- setSchema(String) - Method in class net.sourceforge.pmd.util.database.SourceObject
- setSchemasList(List<String>) - Method in class net.sourceforge.pmd.util.database.DBURI
- setShowSuppressedViolations(boolean) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set whether the report should show suppressed violations.
- setShowSuppressedViolations(boolean) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- setShowSuppressedViolations(boolean) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Set the indicator for whether to show suppressed violations.
- setSince(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- setSince(String) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Set the version of PMD in which this Rule was added.
- setSince(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- setSkipBlocksPattern(String) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setSkipDuplicates(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setSkipLexicalErrors(boolean) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setSourceCodeNamesList(List<String>) - Method in class net.sourceforge.pmd.util.database.DBURI
- setSourceCodeType(int) - Method in class net.sourceforge.pmd.util.database.DBURI
- setSourceCodeTypesList(List<String>) - Method in class net.sourceforge.pmd.util.database.DBURI
- setSourceEncoding(Charset) - Method in class net.sourceforge.pmd.AbstractConfiguration
-
Set the character encoding of source files.
- setSourceEncoding(Charset) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
- setSubnamePrefix(String) - Method in class net.sourceforge.pmd.util.database.DBURI
- setSubprotocol(String) - Method in class net.sourceforge.pmd.util.database.DBURI
- setSuppressMarker(String) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
- setSuppressMarker(String) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the suppress marker.
- setThreads(int) - Method in class net.sourceforge.pmd.PMDConfiguration
-
Set the number of threads to use when processing Rules.
- setType(String) - Method in class net.sourceforge.pmd.util.database.SourceObject
- setUnion(Collection<? extends V>, V, V...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns an unmodifiable set containing the set union of the collection, and the new elements.
- setUri(URI) - Method in class net.sourceforge.pmd.util.database.DBURI
- setURL(String) - Method in class net.sourceforge.pmd.util.database.DBURI
- setWriter(Writer) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
- setWriter(Writer) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
Set the Writer for the Renderer.
- setWriter(Writer) - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- severity - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- shortName(String) - Method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Record the short name of the language.
- shouldNotReachHere(String) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- shouldNotReachHere(String, Throwable) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- shouldStopProcessing(T) - Method in class net.sourceforge.pmd.cpd.impl.BaseTokenFilter
-
Extension point for subclasses to indicate when to stop filtering tokens.
- showSuppressedViolations - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
- simpleDataKey(String) - Static method in class net.sourceforge.pmd.util.DataMap
- SimpleLanguageModuleBase - Class in net.sourceforge.pmd.lang.impl
-
The simplest implementation of a language, where only a
LanguageVersionHandler
needs to be implemented. - SimpleLanguageModuleBase(LanguageModuleBase.LanguageMetadata, Function<LanguagePropertyBundle, LanguageVersionHandler>) - Constructor for class net.sourceforge.pmd.lang.impl.SimpleLanguageModuleBase
- SimpleLanguageModuleBase(LanguageModuleBase.LanguageMetadata, LanguageVersionHandler) - Constructor for class net.sourceforge.pmd.lang.impl.SimpleLanguageModuleBase
- SimpleRenderer - Class in net.sourceforge.pmd.cpd
- SimpleRenderer() - Constructor for class net.sourceforge.pmd.cpd.SimpleRenderer
- SimpleRenderer(boolean) - Constructor for class net.sourceforge.pmd.cpd.SimpleRenderer
- SimpleRenderer(String) - Constructor for class net.sourceforge.pmd.cpd.SimpleRenderer
- SINGLE_BOOLEAN - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Represents
Boolean
. - SINGLE_ELEMENT - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Represents any node.
- SINGLE_INTEGER - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Represents
Integer
. - SINGLE_STRING - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Represents
String
. - singleQuoteAttributes(boolean) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
-
Sets the delimiters use for attribute values.
- singleton(LanguageProcessor) - Static method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
-
Create a registry with a single language processor.
- singleton(Language) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
-
Creates a language registry containing a single language.
- singletonIterator(T) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- size() - Method in class net.sourceforge.pmd.cpd.Tokens
- size() - Method in class net.sourceforge.pmd.lang.rule.RuleSet
-
Returns the number of rules in this ruleset
- slice(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Like
Chars.subSequence(int, int)
but with offset + length instead of start + end. - slice(TextRegion) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Slice a region of text.
- sliceOriginalText(TextRegion) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a slice of the original text.
- sliceTranslatedText(TextRegion) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Returns a slice of the source text.
- SOURCE_NAMES - net.sourceforge.pmd.util.database.DBType.Property
- SOURCE_PATH - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
- SOURCE_TYPES - net.sourceforge.pmd.util.database.DBType.Property
- SourceObject - Class in net.sourceforge.pmd.util.database
-
Instantiate the fields required to retrieve the source code.
- SPACE_SEPARATED - net.sourceforge.pmd.util.StringUtil.CaseConvention
-
space separated.
- specialToken - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
- splits(Pattern) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Split this slice into subslices, like
String.split(String)
, except it's iterated lazily. - start() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
- start() - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
- start() - Method in class net.sourceforge.pmd.renderers.CSVRenderer
- start() - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
- start() - Method in class net.sourceforge.pmd.renderers.HTMLRenderer
- start() - Method in class net.sourceforge.pmd.renderers.JsonRenderer
- start() - Method in interface net.sourceforge.pmd.renderers.Renderer
-
This method is called before any source files are processed.
- start() - Method in class net.sourceforge.pmd.renderers.SarifRenderer
- start() - Method in class net.sourceforge.pmd.renderers.VBHTMLRenderer
- start() - Method in class net.sourceforge.pmd.renderers.XMLRenderer
- start() - Method in class net.sourceforge.pmd.renderers.XSLTRenderer
- start(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
- start(RuleContext) - Method in interface net.sourceforge.pmd.lang.rule.Rule
-
Start processing.
- start(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.renderers.EmptyRenderer
- startFileAnalysis(TextFile) - Method in interface net.sourceforge.pmd.renderers.Renderer
-
This method is called each time a source file is processed.
- startFileAnalysis(TextFile) - Method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
Returns a file listener that will handle events occurring during the analysis of the given file.
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.reporting.GlobalAnalysisListener.ViolationCounterListener
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.reporting.Report.GlobalReportBuilderListener
- startFileAnalysis(TextFile) - Method in class net.sourceforge.pmd.reporting.ReportStatsListener
- startGlobalTracking() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Starts global tracking.
- startOperation(TimedOperationCategory) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Starts tracking an operation.
- startOperation(TimedOperationCategory, String) - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Starts tracking an operation.
- startPosToString() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Formats the start position as e.g.
- startPosToStringWithFile() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Formats the start position as e.g.
- startsWith(char, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- startsWith(String) - Method in class net.sourceforge.pmd.lang.document.Chars
- startsWith(String, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- staticInit(Object[]) - Method in interface net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.FunctionCall
-
This is called once before the function is evaluated.
- STDIN - Static variable in interface net.sourceforge.pmd.lang.document.FileId
-
The virtual file ID for standard input.
- stopGlobalTracking() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
-
Stops global tracking.
- streamRange(T, T) - Static method in interface net.sourceforge.pmd.lang.ast.GenericToken
-
Returns a stream corresponding to
GenericToken.range(GenericToken, GenericToken)
. - STRING_SEQUENCE - net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
- stringListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a property having as value a list of strings.
- stringProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
-
Returns a builder for a string property.
- StringUtil - Class in net.sourceforge.pmd.util
-
String-related utility functions.
- StringUtil.CaseConvention - Enum in net.sourceforge.pmd.util
- subSequence(int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns the subsequence that starts at the given offset and ends at the end of this string.
- subSequence(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
- substring(int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns the substring between the given offsets.
- substringAfterLast(String, int) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Returns the substring following the last occurrence of the given character.
- sumBy(ToIntFunction<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Sum the elements of this stream by associating them to an integer.
- sumByInt(ToIntFunction<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the sum of the value of the function applied to all elements of this stream.
- SummaryHTMLRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to a summarized HTML format.
- SummaryHTMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.SummaryHTMLRenderer
- supportedRenderers() - Static method in class net.sourceforge.pmd.renderers.RendererFactory
-
Retrieves a collection of all supported renderer names.
- supports(Node) - Method in interface net.sourceforge.pmd.lang.metrics.Metric
-
Checks if the metric can be computed on the node.
- supportsAll(Node, Metric<?, ?>...) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
- SUPPRESS_MARKER - Static variable in class net.sourceforge.pmd.lang.LanguagePropertyBundle
- suppressed - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
-
Accumulated suppressed violations.
- SuppressedViolation(RuleViolation, ViolationSuppressor, String) - Constructor for class net.sourceforge.pmd.reporting.Report.SuppressedViolation
-
Creates a suppressed violation.
- suppressMap - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
- suppressMarker - Variable in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractTokenManager
- suppressOrNull(List<ViolationSuppressor>, RuleViolation, Node) - Static method in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
Apply a list of suppressors on the violation.
- suppressOrNull(RuleViolation, Node) - Method in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
Returns a
Report.SuppressedViolation
if the given violation is suppressed by this object.
T
- take(int) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a stream consisting of the elements of this stream, truncated to be no longer than maxSize in length.
- take(Iterator<? extends T>, int) - Static method in class net.sourceforge.pmd.util.IteratorUtil
-
Limit the number of elements yielded by this iterator to the given number.
- take(List<T>, int) - Static method in class net.sourceforge.pmd.util.CollectionUtil
- takeAttribute(Node, Attribute) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
-
Returns true if the attribute should be included in the element corresponding to the given node.
- takeWhile(Predicate<? super T>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns the longest prefix of elements that satisfy the given predicate.
- takeWhile(Iterator<T>, Predicate<? super T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- taskWithFiles(LanguageProcessor.AnalysisTask, List<TextFile>) - Static method in class net.sourceforge.pmd.lang.InternalApiBridge
- tee(Collection<? extends FileAnalysisListener>) - Static method in interface net.sourceforge.pmd.reporting.FileAnalysisListener
-
Produce an analysis listener that forwards all events to the given listeners.
- tee(Collection<? extends GlobalAnalysisListener>) - Static method in interface net.sourceforge.pmd.reporting.GlobalAnalysisListener
-
Produce an analysis listener that forwards all events to the given listeners.
- tee(Collection<? extends ListenerInitializer>) - Static method in interface net.sourceforge.pmd.reporting.ListenerInitializer
-
Produce an analysis listener that forwards all events to the given listeners.
- test(NameDeclaration) - Method in class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
- TextAvailableNode - Interface in net.sourceforge.pmd.lang.ast
-
Refinement of
Node
for nodes that can provide the underlying source text. - TextColorRenderer - Class in net.sourceforge.pmd.renderers
-
A console renderer with color support for terminal supporting ansi color codes.
- TextColorRenderer() - Constructor for class net.sourceforge.pmd.renderers.TextColorRenderer
- TextDocument - Interface in net.sourceforge.pmd.lang.document
-
Represents a textual document, providing methods to edit it incrementally and address regions of text.
- TextFile - Interface in net.sourceforge.pmd.lang.document
-
Represents some location containing character data.
- TextFileBuilder - Class in net.sourceforge.pmd.lang.document
-
A builder for a new text file.
- TextFileContent - Class in net.sourceforge.pmd.lang.document
-
Contents of a text file.
- TextNode - Interface in net.sourceforge.pmd.lang.rule.xpath
- TextPadRenderer - Class in net.sourceforge.pmd.renderers
-
A Renderer for running PMD via a TextPad 'tool'.
- TextPadRenderer() - Constructor for class net.sourceforge.pmd.renderers.TextPadRenderer
- TextPos2d - Class in net.sourceforge.pmd.lang.document
-
A place in a text document, represented as line/column information.
- TextRange2d - Class in net.sourceforge.pmd.lang.document
-
A place in a text document, represented as line/column information.
- TextRange2d(int, int, int, int) - Constructor for class net.sourceforge.pmd.lang.document.TextRange2d
- TextRegion - Class in net.sourceforge.pmd.lang.document
-
A contiguous range of text in a
TextDocument
. - TextRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to simple text format.
- TextRenderer() - Constructor for class net.sourceforge.pmd.renderers.TextRenderer
- TextTimingReportRenderer - Class in net.sourceforge.pmd.benchmark
-
A text based renderer for
TimingReport
. - TextTimingReportRenderer() - Constructor for class net.sourceforge.pmd.benchmark.TextTimingReportRenderer
- TextTreeRenderer - Class in net.sourceforge.pmd.util.treeexport
-
A simple recursive printer.
- TextTreeRenderer(boolean, int) - Constructor for class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
-
Creates a new text renderer.
- TimedOperation - Interface in net.sourceforge.pmd.benchmark
-
Describes a timed operation.
- TimedOperationCategory - Enum in net.sourceforge.pmd.benchmark
-
A category for a
TimedOperation
, rendered either as a section if several operations are registered on the same category but with distinct labels, or put into the "remaining categories" section. - TimeTracker - Class in net.sourceforge.pmd.benchmark
-
A time tracker class to measure time spent on different sections of PMD analysis.
- TimingReport - Class in net.sourceforge.pmd.benchmark
-
A report on timing data obtained through the execution of PMD
- TimingReportRenderer - Interface in net.sourceforge.pmd.benchmark
-
Defines a renderer for
TimingReport
. - toCollectionConstraint() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Returns a constraint that validates a collection of Ts by checking each component conforms to this validator.
- toDisplayStringInEnglish() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Returns a string looking like
"line 2, column 4")
. - toDisplayStringWithColon() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Returns a string looking like
"2:4")
. - toDisplayStringWithColon() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- toDot(Collection<? extends V>, Function<? super V, ? extends Collection<? extends V>>, Function<? super V, GraphUtil.DotColor>, Function<? super V, String>) - Static method in class net.sourceforge.pmd.util.GraphUtil
-
Generate a DOT representation for a graph.
- toIterable(Iterator<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- tokenBehavior() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- TokenDocument<T extends GenericToken> - Class in net.sourceforge.pmd.lang.ast.impl
-
Token layer of a parsed file.
- TokenDocument(TextDocument) - Constructor for class net.sourceforge.pmd.lang.ast.impl.TokenDocument
- TokenDocumentBehavior(List<String>) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
- TokenEntry - Class in net.sourceforge.pmd.cpd
- TokenFactory - Interface in net.sourceforge.pmd.cpd
-
Proxy to record tokens from within
CpdLexer.tokenize(TextDocument, TokenFactory)
. - tokenize(CpdLexer, TextDocument) - Static method in interface net.sourceforge.pmd.cpd.CpdLexer
- tokenize(CpdLexer, TextDocument, Tokens) - Static method in interface net.sourceforge.pmd.cpd.CpdLexer
-
Wraps a call to
CpdLexer.tokenize(TextDocument, TokenFactory)
to properly create and close the token factory. - tokenize(TextDocument, TokenFactory) - Method in class net.sourceforge.pmd.cpd.AnyCpdLexer
- tokenize(TextDocument, TokenFactory) - Method in interface net.sourceforge.pmd.cpd.CpdLexer
-
Tokenize the source code and record tokens using the provided token factory.
- tokenize(TextDocument, TokenFactory) - Method in class net.sourceforge.pmd.cpd.impl.CpdLexerBase
- TokenManager<T extends GenericToken<T>> - Interface in net.sourceforge.pmd.lang
-
Common interface for interacting with parser Token Managers.
- tokens() - Method in interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode
-
Returns a token range, that includes the first and last token.
- Tokens - Class in net.sourceforge.pmd.cpd
-
Global token collector for CPD.
- toList() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Collects the elements of this node stream into a list.
- toList(Function<? super T, ? extends R>) - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Maps the elements of this node stream using the given mapping and collects the results into a list.
- toList(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- toLocation(int) - Method in class net.sourceforge.pmd.lang.document.FragmentedDocBuilder
- toLocation(TextRegion) - Method in interface net.sourceforge.pmd.lang.document.TextDocument
-
Turn a text region into a
FileLocation
. - toMutableList() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
A collector that returns a mutable list.
- toMutableSet() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
A collector that returns a mutable set.
- toNonNullList(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- toOptionalConstraint() - Method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Returns a constraint that validates an
Optional<T>
by checking that the value conforms to this constraint if it is non-empty. - toPersistentSet() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
A collectors that accumulates into a persistent set.
- toRange2d() - Method in class net.sourceforge.pmd.lang.document.FileLocation
-
Turn this into a range country.
- toStream() - Method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a new stream of Ts having the pipeline of operations defined by this node stream.
- toStream(Iterable<T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- toStream(Iterator<? extends T>) - Static method in class net.sourceforge.pmd.util.IteratorUtil
- toString() - Method in class net.sourceforge.pmd.cpd.Match
- toString() - Method in class net.sourceforge.pmd.cpd.TokenEntry
- toString() - Method in class net.sourceforge.pmd.lang.ast.impl.AbstractNode
- toString() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
-
This toString implementation is only meant for debugging purposes.
- toString() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
- toString() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeParserAdapter
- toString() - Method in class net.sourceforge.pmd.lang.document.Chars
- toString() - Method in class net.sourceforge.pmd.lang.document.FileCollector
- toString() - Method in interface net.sourceforge.pmd.lang.document.FileId
-
This method is intentionally only meant for debugging, and its output is unspecified.
- toString() - Method in class net.sourceforge.pmd.lang.document.FileLocation
- toString() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
- toString() - Method in class net.sourceforge.pmd.lang.document.TextRange2d
- toString() - Method in class net.sourceforge.pmd.lang.document.TextRegion
- toString() - Method in class net.sourceforge.pmd.lang.LanguageFilenameFilter
- toString() - Method in class net.sourceforge.pmd.lang.LanguageModuleBase
- toString() - Method in class net.sourceforge.pmd.lang.LanguageProcessorRegistry
- toString() - Method in class net.sourceforge.pmd.lang.LanguageRegistry
- toString() - Method in class net.sourceforge.pmd.lang.LanguageVersion
- toString() - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
- toString() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
- toString() - Method in class net.sourceforge.pmd.lang.PlainTextLanguage.PlainTextFile
- toString() - Method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Returns the descriptive name of the priority.
- toString() - Method in class net.sourceforge.pmd.lang.rule.xpath.Attribute
- toString() - Method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
- toString() - Method in class net.sourceforge.pmd.properties.PropertyDescriptor
- toString() - Method in class net.sourceforge.pmd.reporting.Report.ReportBuilderListener
- toString() - Method in class net.sourceforge.pmd.reporting.ReportStats
- toString() - Method in class net.sourceforge.pmd.util.database.DBType
- toString() - Method in class net.sourceforge.pmd.util.database.DBURI
- toString() - Method in class net.sourceforge.pmd.util.database.SourceObject
- toString() - Method in class net.sourceforge.pmd.util.DataMap.SimpleDataKey
- toString(T) - Method in class net.sourceforge.pmd.properties.PropertySerializer
-
Format the value to a string.
- toStringBuilder() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns a new stringbuilder containing the whole contents of this char sequence.
- toTupleString() - Method in class net.sourceforge.pmd.lang.document.TextPos2d
-
Returns a string looking like
"(line=2, column=4)"
. - toUnmodifiableList() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
A collector that returns an unmodifiable list.
- toUnmodifiableSet() - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
A collector that returns an unmodifiable set.
- translate(TextDocument) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
-
Translate the escapes of the source document.
- translateDocument() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.EscapeTranslator
-
Translate all the input in the buffer.
- TreeExportConfiguration - Class in net.sourceforge.pmd.util.treeexport
- TreeExportConfiguration() - Constructor for class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- TreeExportConfiguration(LanguageRegistry) - Constructor for class net.sourceforge.pmd.util.treeexport.TreeExportConfiguration
- TreeExporter - Class in net.sourceforge.pmd.util.treeexport
- TreeExporter(TreeExportConfiguration) - Constructor for class net.sourceforge.pmd.util.treeexport.TreeExporter
- TreeRenderer - Interface in net.sourceforge.pmd.util.treeexport
-
An object that can export a tree to an external text format.
- TreeRendererDescriptor - Interface in net.sourceforge.pmd.util.treeexport
-
Describes the configuration options of a specific
TreeRenderer
. - TreeRenderers - Class in net.sourceforge.pmd.util.treeexport
-
Entry point to fetch and register tree renderers.
- trim() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Like
String.trim()
. - trimBlankLines() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Remove trailing and leading blank lines.
- trimEnd() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns a subsequence which does not end with control characters (
<= 32
). - trimIndent(Chars) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Trim common indentation in the lines of the string.
- trimIndentInPlace(List<Chars>) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Trim the common indentation of each line in place in the input list.
- trimStart() - Method in class net.sourceforge.pmd.lang.document.Chars
-
Returns a subsequence which does not start with control characters (
<= 32
). - type - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
- typeId - Variable in class net.sourceforge.pmd.properties.PropertyBuilder
-
Non-null if declared in XML.
U
- UNACCOUNTED - net.sourceforge.pmd.benchmark.TimedOperationCategory
- union(Iterable<? extends NodeStream<? extends T>>) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the elements of the given streams, one after the other.
- union(Collection<? extends T>, Collection<? extends T>, Collection<? extends T>...) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns the set union of the given collections.
- union(NodeStream<? extends T>...) - Static method in interface net.sourceforge.pmd.lang.ast.NodeStream
-
Returns a node stream containing all the elements of the given streams, one after the other.
- union(TextRegion, TextRegion) - Static method in class net.sourceforge.pmd.lang.document.TextRegion
-
Computes the union of this region with the other.
- union(Report) - Method in class net.sourceforge.pmd.reporting.Report
-
Creates a new report by combining this report with another report.
- union(PSet<V>, PSet<V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Union of two PSets, which avoids creating a new pset if possible.
- UNKNOWN - net.sourceforge.pmd.util.OptionalBool
- UNKNOWN - Static variable in interface net.sourceforge.pmd.lang.document.FileId
-
The name used for an unknown file.
- unless(boolean) - Static method in enum net.sourceforge.pmd.util.OptionalBool
- useMarkSuffix() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument.TokenDocumentBehavior
-
Returns true if the lexer should accumulate the image of MORE tokens into the StringBuilder jjimage.
- USER - net.sourceforge.pmd.util.database.DBType.Property
- using(C, Consumer<? super C>) - Static method in class net.sourceforge.pmd.util.BaseResultProducingCloseable
V
- validate(T) - Method in interface net.sourceforge.pmd.properties.PropertyConstraint
-
Checks that the value conforms to this constraint.
- validateState(boolean, String) - Static method in class net.sourceforge.pmd.util.AssertionUtil
-
Throws
IllegalStateException
if the condition is false. - validateStringRange(CharSequence, int, int) - Static method in class net.sourceforge.pmd.util.AssertionUtil
- value() - Method in annotation type net.sourceforge.pmd.annotation.Experimental
-
A reason given for the experimental status.
- valueName() - Method in interface net.sourceforge.pmd.lang.metrics.MetricOption
-
Returns the name of the option as it should be used in properties.
- valueOf(int) - Static method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Get the priority which corresponds to the given number as returned by
RulePriority.getPriority()
. - valueOf(String) - Static method in enum net.sourceforge.pmd.benchmark.TimedOperationCategory
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.NoAttribute.NoAttrScope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.util.database.DBType.Property
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.util.GraphUtil.DotColor
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.util.OptionalBool
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.sourceforge.pmd.util.StringUtil.CaseConvention
-
Returns the enum constant of this type with the specified name.
- valueOfNullable(int) - Static method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Returns the priority which corresponds to the given number as returned by
RulePriority.getPriority()
. - valueOfNullable(String) - Static method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Returns the priority which corresponds to the given number as returned by
RulePriority.getPriority()
. - values() - Static method in enum net.sourceforge.pmd.benchmark.TimedOperationCategory
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.lang.rule.RulePriority
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.lang.rule.xpath.NoAttribute.NoAttrScope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.lang.rule.xpath.PmdXPathException.Phase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.util.database.DBType.Property
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.util.GraphUtil.DotColor
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.util.OptionalBool
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum net.sourceforge.pmd.util.StringUtil.CaseConvention
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VARIABLE - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
- VARIABLE_NAME - Static variable in interface net.sourceforge.pmd.reporting.RuleViolation
-
Key in
RuleViolation.getAdditionalInfo()
for the name of the variable related to the violation. - VBHTMLRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to another HTML format.
- VBHTMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.VBHTMLRenderer
- VERSION - Static variable in class net.sourceforge.pmd.PMDVersion
-
Constant that contains always the current version of PMD.
- VIOLATION_SUPPRESS_REGEX_DESCRIPTOR - Static variable in interface net.sourceforge.pmd.lang.rule.Rule
-
The property descriptor to universally suppress violations with messages matching a regular expression.
- VIOLATION_SUPPRESS_XPATH_DESCRIPTOR - Static variable in interface net.sourceforge.pmd.lang.rule.Rule
-
Name of the property to universally suppress violations on nodes which match a given relative XPath expression.
- ViolationCounterListener() - Constructor for class net.sourceforge.pmd.reporting.GlobalAnalysisListener.ViolationCounterListener
- ViolationDecorator - Interface in net.sourceforge.pmd.reporting
-
Adds additional key/value pairs to a violation in a language-specific manner.
- ViolationSuppressor - Interface in net.sourceforge.pmd.reporting
-
An object that suppresses rule violations.
- visitChildren(Node, P) - Method in class net.sourceforge.pmd.lang.ast.AstVisitorBase
-
Visit the children.
- visitNode(Node, P) - Method in interface net.sourceforge.pmd.lang.ast.AstVisitor
-
Visit a node.
- visitNode(Node, P) - Method in class net.sourceforge.pmd.lang.ast.AstVisitorBase
- VSRenderer - Class in net.sourceforge.pmd.cpd
- VSRenderer() - Constructor for class net.sourceforge.pmd.cpd.VSRenderer
W
- warn(String, Object...) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- warnDeprecated(boolean) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
-
Log a warning when referencing a deprecated rule.
- warnEx(String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- warnEx(String, Throwable) - Method in interface net.sourceforge.pmd.util.log.PmdReporter
- warning(Node, String, Object...) - Method in interface net.sourceforge.pmd.lang.ast.SemanticErrorReporter
-
Report a warning at the given location.
- withConstraint(PropertyConstraint<? super T>) - Method in class net.sourceforge.pmd.properties.PropertySerializer
-
Returns a new XML mapper that will check parsed values with the given constraint.
- withId(String) - Static method in class net.sourceforge.pmd.lang.LanguageModuleBase.LanguageMetadata
-
Factory method to create an ID.
- withKind(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken
-
Returns a new token with the given kind, and all other parameters identical to this one.
- withLanguages(LanguageRegistry) - Method in class net.sourceforge.pmd.lang.rule.RuleSetLoader
- withLocation(FileLocation) - Method in exception net.sourceforge.pmd.lang.ast.ParseException
- withLocation(Reportable) - Method in exception net.sourceforge.pmd.lang.ast.ParseException
- withoutPrefixes(String, String...) - Static method in class net.sourceforge.pmd.util.StringUtil
-
Checks for the existence of any of the listed prefixes on the non-null text and removes them.
- withReporter(RuleSetLoader, PmdReporter) - Static method in class net.sourceforge.pmd.lang.rule.InternalApiBridge
- withSuppressMap(Map<Integer, String>) - Method in class net.sourceforge.pmd.lang.ast.AstInfo
- withTextDocument(TextDocument) - Method in class net.sourceforge.pmd.lang.ast.Parser.ParserTask
- withTypeId(PropertyBuilder<B, ?>, PropertyTypeId) - Static method in class net.sourceforge.pmd.properties.InternalApiBridge
- wrap(FileId, String, Throwable) - Static method in exception net.sourceforge.pmd.lang.ast.FileAnalysisException
-
Wraps the cause into an analysis exception.
- wrap(AssertionError) - Static method in error net.sourceforge.pmd.util.ContextedAssertionError
- wrap(CharSequence) - Static method in class net.sourceforge.pmd.lang.document.Chars
-
Wraps the given char sequence into a
Chars
. - wrap(StackOverflowError) - Static method in error net.sourceforge.pmd.util.ContextedStackOverflowError
- write(Writer, int, int) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Write a range of characters to the given writer.
- write(RuleSet) - Method in class net.sourceforge.pmd.lang.rule.RuleSetWriter
- writeContents(TextFileContent) - Method in interface net.sourceforge.pmd.lang.document.TextFile
-
Writes the given content to the underlying character store.
- writeFully(Writer) - Method in class net.sourceforge.pmd.lang.document.Chars
-
Write all characters of this buffer into the given writer.
- writer - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
X
- XMLRenderer - Class in net.sourceforge.pmd.cpd
- XMLRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to XML format.
- XMLRenderer() - Constructor for class net.sourceforge.pmd.cpd.XMLRenderer
-
Creates a XML Renderer with the default (platform dependent) encoding.
- XMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.XMLRenderer
- XMLRenderer(String) - Constructor for class net.sourceforge.pmd.cpd.XMLRenderer
-
Creates a XML Renderer with a specific output encoding.
- XMLRenderer(String) - Constructor for class net.sourceforge.pmd.renderers.XMLRenderer
- XmlRenderingConfig() - Constructor for class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
- XmlTreeRenderer - Class in net.sourceforge.pmd.util.treeexport
-
Renders a tree to XML.
- XmlTreeRenderer() - Constructor for class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer
-
Creates a new XML renderer with a default configuration.
- XmlTreeRenderer(XmlTreeRenderer.XmlRenderingConfig) - Constructor for class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer
-
Creates a new XML renderer.
- XmlTreeRenderer.XmlRenderingConfig - Class in net.sourceforge.pmd.util.treeexport
-
A strategy to parameterize an
XmlTreeRenderer
. - XPATH_3_1 - net.sourceforge.pmd.lang.rule.xpath.XPathVersion
-
XPath 3.1.
- XPATH_SUPPRESSOR - Static variable in interface net.sourceforge.pmd.reporting.ViolationSuppressor
-
Suppressor for the violationSuppressXPath property.
- XPathFunctionDefinition - Class in net.sourceforge.pmd.lang.rule.xpath.impl
-
Base impl for an XPath function definition.
- XPathFunctionDefinition(String) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
- XPathFunctionDefinition(String, Language) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition
- XPathFunctionDefinition.FunctionCall - Interface in net.sourceforge.pmd.lang.rule.xpath.impl
-
Provides the actual implementation of a custom XPath function.
- XPathFunctionDefinition.Type - Enum in net.sourceforge.pmd.lang.rule.xpath.impl
-
Supported types of a custom XPath function.
- XPathFunctionException - Exception in net.sourceforge.pmd.lang.rule.xpath.impl
-
Indicates a problem during the execution of a custom XPath function.
- XPathFunctionException(String) - Constructor for exception net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionException
- XPathFunctionException(String, Throwable) - Constructor for exception net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionException
- XPathHandler - Interface in net.sourceforge.pmd.lang.rule.xpath.impl
-
Interface for performing Language specific XPath handling, such as initialization and navigation.
- XPathRule - Class in net.sourceforge.pmd.lang.rule.xpath
-
Rule that tries to match an XPath expression against a DOM view of an AST.
- XPathRule(XPathVersion, String) - Constructor for class net.sourceforge.pmd.lang.rule.xpath.XPathRule
-
Make a new XPath rule with the given version + expression
- XPathVersion - Enum in net.sourceforge.pmd.lang.rule.xpath
-
Constants for XPath language version used in XPath queries.
- XSLT_FILENAME - Static variable in class net.sourceforge.pmd.renderers.XSLTRenderer
- XSLTRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to XML format with a XSL Transformation applied.
- XSLTRenderer() - Constructor for class net.sourceforge.pmd.renderers.XSLTRenderer
Y
- YAHTMLRenderer - Class in net.sourceforge.pmd.renderers
-
Renderer to another HTML format.
- YAHTMLRenderer() - Constructor for class net.sourceforge.pmd.renderers.YAHTMLRenderer
- YES - net.sourceforge.pmd.util.OptionalBool
Z
- zip(List<? extends K>, List<? extends V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
-
Returns a map associating each key in the first list to its corresponding value in the second.
All Classes All Packages