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

A

AbstractAccumulatingRenderer - Class in net.sourceforge.pmd.renderers
Abstract base class for Renderer implementations which only produce output once all source files are processed.
AbstractAccumulatingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
 
AbstractAnalysisCache - Class in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
AbstractAnalysisCache() - Constructor for class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
Creates a new empty cache
AbstractASTXPathHandler - Class in net.sourceforge.pmd.lang.ast.xpath
Deprecated.
AbstractASTXPathHandler() - Constructor for class net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler
Deprecated.
 
AbstractCompoundFilter<T> - Class in net.sourceforge.pmd.util.filter
Deprecated.
See Filter
AbstractCompoundFilter() - Constructor for class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
AbstractCompoundFilter(Filter<T>...) - Constructor for class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
AbstractConfiguration - Class in net.sourceforge.pmd
Base configuration class for both PMD and CPD.
AbstractConfiguration() - Constructor for class net.sourceforge.pmd.AbstractConfiguration
Create a new abstract configuration.
AbstractDataFlowNode - Class in net.sourceforge.pmd.lang.dfa
Deprecated.
AbstractDataFlowNode(List<DataFlowNode>) - Constructor for class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
AbstractDataFlowNode(List<DataFlowNode>, Node) - Constructor for class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
AbstractDelegateFilter<T> - Class in net.sourceforge.pmd.util.filter
Deprecated.
See Filter
AbstractDelegateFilter() - Constructor for class net.sourceforge.pmd.util.filter.AbstractDelegateFilter
Deprecated.
 
AbstractDelegateFilter(Filter<T>) - Constructor for class net.sourceforge.pmd.util.filter.AbstractDelegateFilter
Deprecated.
 
AbstractDelegateRule - Class in net.sourceforge.pmd.lang.rule
Deprecated.
This is only relevant to RuleReference, but prevents sharing the implementation of AbstractPropertySource. Will be removed in 7.0.0
AbstractDelegateRule() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
AbstractIncrementingRenderer - Class in net.sourceforge.pmd.renderers
Abstract base class for Renderer implementations which can produce output incrementally for RuleViolations as source files are processed.
AbstractIncrementingRenderer(String, String) - Constructor for class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
 
AbstractIterator() - Constructor for class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
 
AbstractJjtreeNode<N extends Node> - 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
 
AbstractJjtreeNode(int, int, int, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
 
AbstractLanguage - Class in net.sourceforge.pmd.cpd
 
AbstractLanguage(String, String, Tokenizer, String...) - Constructor for class net.sourceforge.pmd.cpd.AbstractLanguage
 
AbstractLanguageVersionHandler - Class in net.sourceforge.pmd.lang
This is a generic implementation of the LanguageVersionHandler interface.
AbstractLanguageVersionHandler() - Constructor for class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
AbstractMetric<N extends Node> - Class in net.sourceforge.pmd.lang.metrics
Abstract class for all metrics.
AbstractMetric() - Constructor for class net.sourceforge.pmd.lang.metrics.AbstractMetric
 
AbstractMetricsComputer<T extends QualifiableNode,​O extends QualifiableNode> - Class in net.sourceforge.pmd.lang.metrics
Deprecated.
See package description
AbstractMetricsComputer() - Constructor for class net.sourceforge.pmd.lang.metrics.AbstractMetricsComputer
Deprecated.
 
AbstractMetricsFacade<T extends QualifiableNode,​O extends QualifiableNode> - Class in net.sourceforge.pmd.lang.metrics
Deprecated.
See package description
AbstractMetricsFacade() - Constructor for class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
 
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 - Class in net.sourceforge.pmd.lang.ast
Base class for all implementations of the Node interface.
AbstractNode(int) - Constructor for class net.sourceforge.pmd.lang.ast.AbstractNode
 
AbstractNode(int, int, int, int, int) - Constructor for class net.sourceforge.pmd.lang.ast.AbstractNode
 
AbstractNodeInfo - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
AbstractNodeInfo() - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
AbstractParser - Class in net.sourceforge.pmd.lang
Deprecated.
This will become useless in PMD 7. Implement or use Parser directly
AbstractParser(ParserOptions) - Constructor for class net.sourceforge.pmd.lang.AbstractParser
Deprecated.
 
AbstractPMDProcessor - Class in net.sourceforge.pmd.processor
Deprecated.
Is internal API
AbstractPMDProcessor(PMDConfiguration) - Constructor for class net.sourceforge.pmd.processor.AbstractPMDProcessor
Deprecated.
 
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
 
AbstractReportNode - Class in net.sourceforge.pmd.lang.dfa.report
Deprecated.
AbstractReportNode() - Constructor for class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
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
 
AbstractRuleChainVisitor - Class in net.sourceforge.pmd.lang.rule
Deprecated.
AbstractRuleChainVisitor() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
 
AbstractRuleViolationFactory - Class in net.sourceforge.pmd.lang.rule
 
AbstractRuleViolationFactory() - Constructor for class net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory
 
AbstractScope - Class in net.sourceforge.pmd.lang.symboltable
Base class for any Scope.
AbstractScope() - Constructor for class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
AbstractTokenizer - Class in net.sourceforge.pmd.cpd
Deprecated.
Use an AnyTokenizer instead, it's basically as powerful.
AbstractTokenizer() - Constructor for class net.sourceforge.pmd.cpd.AbstractTokenizer
Deprecated.
 
AbstractTokenManager - Class in net.sourceforge.pmd.lang.ast
 
AbstractTokenManager() - Constructor for class net.sourceforge.pmd.lang.ast.AbstractTokenManager
 
AbstractXPathRuleQuery - Class in net.sourceforge.pmd.lang.rule.xpath
Deprecated.
Internal API
AbstractXPathRuleQuery() - Constructor for class net.sourceforge.pmd.lang.rule.xpath.AbstractXPathRuleQuery
Deprecated.
 
accept(File, String) - Method in class net.sourceforge.pmd.lang.LanguageFilenameFilter
Check if a file should be checked by PMD.
accept(NodeVisitor, Object) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
accept(NodeVisitor, Object) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
accept(NodeVisitor, Object) - Method in interface net.sourceforge.pmd.dcd.graph.NodeVisitorAcceptor
Deprecated.
 
accept(NodeVisitor, Object) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
accept(ReportVisitor) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
accessor - Variable in class net.sourceforge.pmd.renderers.ColumnDescriptor
Deprecated.
 
accessTypeMatches(int) - Method in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
ActionCommands - Class in net.sourceforge.pmd.util.viewer.gui
Deprecated.
actionPerformed(ActionEvent) - Method in class net.sourceforge.pmd.util.designer.CreateXMLRulePanel
Deprecated.
We let our class implement the ActionListener interface and use it to generate the xml code when the user presses the "Create rule XML" button.
actionPerformed(ActionEvent) - Method in class net.sourceforge.pmd.util.viewer.gui.MainFrame
Deprecated.
 
actionPerformed(ActionEvent) - Method in class net.sourceforge.pmd.util.viewer.gui.menu.XPathFragmentAddingItem
Deprecated.
 
actionPerformed(ActionEvent) - Method in class net.sourceforge.pmd.util.viewer.gui.ParseExceptionHandler
Deprecated.
 
add(Component) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
Deprecated.
 
add(Component, int) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
Deprecated.
 
add(File) - Method in class net.sourceforge.pmd.cpd.CPD
 
add(Class<?>) - Method in class net.sourceforge.pmd.util.TypeMap
Deprecated.
Adds a type to the receiver and stores it keyed by both its full and short names.
add(Class<?>...) - Method in class net.sourceforge.pmd.util.TypeMap
Deprecated.
Adds an array of types to the receiver at once.
add(List<File>) - Method in class net.sourceforge.pmd.cpd.CPD
 
add(SourceCode) - Method in class net.sourceforge.pmd.cpd.CPD
 
add(TokenEntry) - Method in class net.sourceforge.pmd.cpd.Tokens
 
add(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
Adds the child at the end.
add(RuleSet) - Method in class net.sourceforge.pmd.RuleChain
Deprecated.
Add all Rules from the given RuleSet which want to participate in the RuleChain.
add(RuleSet, Rule) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
 
add(RuleSet, Rule) - Method in interface net.sourceforge.pmd.lang.rule.RuleChainVisitor
Deprecated.
Add the given rule to the visitor.
add(RuleViolation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
 
add(DBURI) - Method in class net.sourceforge.pmd.cpd.CPD
 
addAllInDirectory(File) - Method in class net.sourceforge.pmd.cpd.CPD
 
addAttributesTo(Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
Deprecated.
 
addAttributesTo(Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.modules.PackagedPropertyModule
Deprecated.
 
addConfigError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.Report
Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addConfigurationError(Report.ConfigurationError) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
 
addConfiguredParam(Parameter) - Method in class net.sourceforge.pmd.ant.Formatter
 
addConfiguredSourceLanguage(SourceLanguage) - Method in class net.sourceforge.pmd.ant.PMDTask
 
addDataPoint(DataPoint) - Method in interface net.sourceforge.pmd.lang.rule.stat.StatisticalRule
Deprecated.
 
addDataPoint(DataPoint) - Method in class net.sourceforge.pmd.lang.rule.stat.StatisticalRuleHelper
Deprecated.
 
addDeclaration(NameDeclaration) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
addDeclaration(NameDeclaration) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
Adds a new declaration to this scope.
addDefaultVersion(String, LanguageVersionHandler, String...) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
Adds a version with the given identifier, and sets it as the default.
addDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a directory recursively using FileCollector.addFile(Path) on all regular files.
addDocumentOperation(DocumentOperation) - Method in class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
 
addedFile(int, File) - Method in interface net.sourceforge.pmd.cpd.CPDListener
 
addedFile(int, File) - Method in class net.sourceforge.pmd.cpd.CPDNullListener
 
addedFile(int, File) - Method in class net.sourceforge.pmd.cpd.GUI
 
addError(Report.ProcessingError) - Method in class net.sourceforge.pmd.Report
Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addEscapes(String) - Static method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
addExample(String) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
addExample(String) - Method in interface net.sourceforge.pmd.Rule
Add a single example for this Rule.
addExample(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
Deprecated.
 
addFile(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a file, language is determined automatically from the extension/file patterns.
addFile(Path, Language) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a file with the given language (which overrides the file patterns).
addFile(TextFile) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a pre-configured text file.
addFileOrDirectory(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a file or directory recursively.
addFileset(FileSet) - Method in class net.sourceforge.pmd.ant.PMDTask
 
addFileset(FileSet) - Method in class net.sourceforge.pmd.cpd.CPDTask
 
addFilter(Filter<T>) - Method in class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
addFirst(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
Adds the child in front of any other childs.
addFormatter(Formatter) - Method in class net.sourceforge.pmd.ant.PMDTask
 
addInputPath(String) - Method in class net.sourceforge.pmd.PMDConfiguration
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
 
addLabel(String) - Method in class net.sourceforge.pmd.cpd.GridBagHelper
Deprecated.
 
addLast(DataFlowNode) - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
addListener(ThreadSafeReportListener) - Method in class net.sourceforge.pmd.Report
Deprecated.
addListeners(List<ThreadSafeReportListener>) - Method in class net.sourceforge.pmd.Report
Deprecated.
addMetric(Metric) - Method in class net.sourceforge.pmd.Report
Deprecated.
addNameOccurrence(NameOccurrence) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
addNameOccurrence(NameOccurrence) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
Adds a NameOccurrence to this scope - only call this after getting a true back from Scope.contains(NameOccurrence).
addNumberOfViolation(int) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
addPathToChild(DataFlowNode) - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
addPathToChild(DataFlowNode) - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
addRecursively(File) - Method in class net.sourceforge.pmd.cpd.CPD
 
addRenderer(Renderer) - Method in class net.sourceforge.pmd.PmdAnalysis
Add a new renderer.
addRenderers(Collection<Renderer>) - Method in class net.sourceforge.pmd.PmdAnalysis
Add several renderers at once.
addRuleChainVisit(Class<? extends Node>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
addRuleChainVisit(Class<? extends Node>) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
addRuleChainVisit(Class<? extends Node>) - Method in interface net.sourceforge.pmd.Rule
Adds an AST node by class to be visited by the Rule on the RuleChain.
addRuleChainVisit(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
addRuleChainVisit(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
addRuleChainVisit(String) - Method in interface net.sourceforge.pmd.Rule
Adds an AST node by name to be visited by the Rule on the RuleChain.
addRuleset(RuleSetWrapper) - Method in class net.sourceforge.pmd.ant.PMDTask
 
addRuleSet(String) - Method in class net.sourceforge.pmd.PMDConfiguration
Add a new ruleset paths to load when starting the analysis.
addRuleSet(RuleSet) - Method in class net.sourceforge.pmd.PmdAnalysis
Add a new ruleset.
addRuleSet(RuleSet) - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Use RuleSets(List) and don't mutate RuleSets after creation
addRuleSets(Collection<RuleSet>) - Method in class net.sourceforge.pmd.PmdAnalysis
Add several rulesets at once.
addRuleViolation(RuleViolation) - Method in class net.sourceforge.pmd.lang.dfa.report.ReportTree
Deprecated.
Adds the RuleViolation to the tree.
addRuleViolation(RuleViolation) - Method in class net.sourceforge.pmd.Report
Deprecated.
PMD's way of creating a report is internal and may be changed in pmd 7.
addRunTimeError(Report.ProcessingError) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
 
addSourceFile(String, String) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Add a text file given its contents and a name.
addSourceFilesToCPD(CPD, CPDConfiguration) - Static method in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
Deprecated.
 
addText(String) - Method in class net.sourceforge.pmd.ant.RuleSetWrapper
 
addTokenEntry(TokenEntry) - Method in class net.sourceforge.pmd.cpd.Match
 
addTreeModelListener(TreeModelListener) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
addUse(MemberNode) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
addUser(MemberNode) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
addVersion(String, LanguageVersionHandler, boolean) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
addVersion(String, LanguageVersionHandler, String...) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
Adds a non-default version with the given identifier.
addViewerModelListener(ViewerModelListener) - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
 
addViolation(Object, Node) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolation(node).
addViolation(Object, Node, Object...) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolation(node, arg1, arg2).
addViolation(Object, Node, String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolation(node, arg).
addViolation(Node) - Method in class net.sourceforge.pmd.RuleContext
Record a new violation of the contextual rule, at the given node.
addViolation(Node, Object...) - Method in class net.sourceforge.pmd.RuleContext
Record a new violation of the contextual rule, at the given node.
addViolation(RuleContext, Rule, Node, String, int, int, Object[]) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory
 
addViolation(RuleContext, Rule, Node, String, int, int, Object[]) - Method in interface net.sourceforge.pmd.lang.rule.RuleViolationFactory
 
addViolation(RuleContext, Rule, Node, String, Object[]) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory
 
addViolation(RuleContext, Rule, Node, String, Object[]) - Method in interface net.sourceforge.pmd.lang.rule.RuleViolationFactory
Adds a violation to the report.
addViolation(RuleViolation) - Method in class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
addViolations(List<RuleViolation>) - Method in class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
addViolationWithMessage(Object, Node, String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolationWithMessage(node, message).
addViolationWithMessage(Object, Node, String, int, int) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolationWithPosition(node, beginLine, endLine, message).
addViolationWithMessage(Object, Node, String, Object[]) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Replace with asCtx(data).addViolationWithMessage(node, message, args).
addViolationWithMessage(Node, String) - Method in class net.sourceforge.pmd.RuleContext
Record a new violation of the contextual rule, at the given node.
addViolationWithMessage(Node, String, Object...) - Method in class net.sourceforge.pmd.RuleContext
Record a new violation of the contextual rule, at the given node.
addViolationWithPosition(Node, int, int, String, Object...) - Method in class net.sourceforge.pmd.RuleContext
Record a new violation of the contextual rule, at the given node.
addWithoutDuplicates(Collection<T>, Collection<T>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Add elements from the source to the target as long as they don't already exist there.
addWithoutDuplicates(T[], T) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
addWithoutDuplicates(T[], T[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
addZipFile(Path) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Opens a zip file and returns a FileSystem for its contents, so it can be explored with the Path API.
adjustBeginLineColumn(int, int) - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Method to adjust line and column numbers for the start of a token.
adjustBeginLineColumn(int, int) - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Method to adjust line and column numbers for the start of a token.
AdjustBuffSize() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
advance() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeAxisIterator
Deprecated.
 
ANALYSIS_CACHE - net.sourceforge.pmd.benchmark.TimedOperationCategory
 
AnalysisCache - Interface in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
analysisFailed(File) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
analysisFailed(File) - Method in interface net.sourceforge.pmd.cache.AnalysisCache
Deprecated.
Notifies the cache that analysis of the given file has failed and should not be cached.
analysisFailed(File) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
Deprecated.
 
AnalysisResult - Class in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
AnalysisResult(long, List<RuleViolation>) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
AnalysisResult(File) - Constructor for class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
AndFilter<T> - Class in net.sourceforge.pmd.util.filter
Deprecated.
See Filter
AndFilter() - Constructor for class net.sourceforge.pmd.util.filter.AndFilter
Deprecated.
 
AndFilter(Filter<T>...) - Constructor for class net.sourceforge.pmd.util.filter.AndFilter
Deprecated.
 
AntLogHandler - Class in net.sourceforge.pmd.util.log
Deprecated.
Is internal API
AntLogHandler(Project) - Constructor for class net.sourceforge.pmd.util.log.AntLogHandler
Deprecated.
 
AntlrToken - Class in net.sourceforge.pmd.cpd.token
Generic Antlr representation of a token.
AntlrToken(Token, AntlrToken) - Constructor for class net.sourceforge.pmd.cpd.token.AntlrToken
Constructor
AntlrTokenFilter - Class in net.sourceforge.pmd.cpd.token
A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream
AntlrTokenFilter(AntlrTokenManager) - Constructor for class net.sourceforge.pmd.cpd.token.AntlrTokenFilter
Creates a new AntlrTokenFilter
AntlrTokenizer - Class in net.sourceforge.pmd.cpd
Deprecated.
This is an internal API.
AntlrTokenizer() - Constructor for class net.sourceforge.pmd.cpd.AntlrTokenizer
Deprecated.
 
AntlrTokenManager - Class in net.sourceforge.pmd.lang.antlr
Generic token manager implementation for all Antlr lexers.
AntlrTokenManager(Lexer, String) - Constructor for class net.sourceforge.pmd.lang.antlr.AntlrTokenManager
Constructor
AntlrTokenManager.ANTLRSyntaxError - Exception in net.sourceforge.pmd.lang.antlr
Deprecated.
On 7.0.x branch this has been replaced by TokenMgrError already
AnyLanguage - Class in net.sourceforge.pmd.cpd
 
AnyLanguage(String...) - Constructor for class net.sourceforge.pmd.cpd.AnyLanguage
 
AnyTokenizer - Class in net.sourceforge.pmd.cpd
Simple tokenization into words and separators.
AnyTokenizer() - Constructor for class net.sourceforge.pmd.cpd.AnyTokenizer
 
AnyTokenizer(String) - Constructor for class net.sourceforge.pmd.cpd.AnyTokenizer
 
appendBoundaryForNodeLn(Node, Appendable, String) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
 
appendElement(Node) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
appendIndent(Appendable, String, boolean) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
 
appendLn(String...) - Method in class net.sourceforge.pmd.benchmark.StringBuilderCR
Deprecated.
 
appendNodeInfoLn(Appendable, Node) - Method in class net.sourceforge.pmd.util.treeexport.TextTreeRenderer
Append info about the node.
appendToXPathExpression(String, Object) - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
Appends the given fragment to the XPath expression.
appendXmlEscaped(StringBuilder, String, boolean) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
for removal. Use Java's XML implementations, that do the escaping, use StringUtil.removedInvalidXml10Characters(String) for fixing invalid characters in XML 1.0 documents or use StringEscapeUtils#escapeXml10(String) from apache commons-text instead.
Applier - Class in net.sourceforge.pmd.lang.symboltable
 
applies(File) - Method in class net.sourceforge.pmd.RuleSet
Check if a given source file should be checked by rules in this RuleSet.
applies(File) - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Check if a given source file should be checked by rules in this RuleSets.
applies(Rule, LanguageVersion) - Static method in class net.sourceforge.pmd.RuleSet
Deprecated.
This is internal API, removed in PMD 7. You should not use a ruleset directly.
apply() - Method in class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
 
apply(List<? extends Node>, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
apply(List<? extends Node>, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.MockRule
Deprecated.
 
apply(List<? extends Node>, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.XPathRule
 
apply(List<? extends Node>, RuleContext) - Method in interface net.sourceforge.pmd.Rule
Apply this rule to the given collection of nodes, using the given context.
apply(List<? extends Node>, RuleContext) - Method in class net.sourceforge.pmd.RuleSet
Deprecated.
This is internal API, removed in PMD 7. You should not use a ruleset directly.
apply(List<Node>, RuleContext, Language) - Method in class net.sourceforge.pmd.RuleChain
Deprecated.
Apply the RuleChain to the given Nodes using the given RuleContext, for those rules using the given Language.
apply(List<Node>, RuleContext, Language) - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Apply all applicable rules to the compilation units.
apply(Document) - Method in class net.sourceforge.pmd.document.DeleteDocumentOperation
 
apply(Document) - Method in class net.sourceforge.pmd.document.DocumentOperation
Apply this operation to the specified document
apply(Document) - Method in class net.sourceforge.pmd.document.InsertDocumentOperation
 
apply(Document) - Method in class net.sourceforge.pmd.document.ReplaceDocumentOperation
 
apply(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.stat.StatisticalRuleHelper
Deprecated.
 
apply(SearchFunction<E>, Iterator<? extends E>) - Static method in class net.sourceforge.pmd.lang.symboltable.Applier
 
applyTo(E) - Method in interface net.sourceforge.pmd.util.SearchFunction
Deprecated.
Applies the search function over a single element.
applyTo(NameDeclaration) - Method in class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
 
areEqual(Object, Object) - Static method in class net.sourceforge.pmd.util.CollectionUtil
areSemanticEquals(String, String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
areSemanticEquals(T[], T[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil
ARRAY_FLAG - Static variable in class net.sourceforge.pmd.properties.modules.MethodPropertyModule
Deprecated.
 
arraysAreEqual(Object, Object) - Static method in class net.sourceforge.pmd.util.CollectionUtil
artifactLocation(SarifLog.ArtifactLocation) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation.PhysicalLocationBuilder
The location of the artifact.
asCtx(Object) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Cast the argument to a RuleContext.
asDelimitedString(T) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
PMD 7.0.0 will use a more powerful scheme to represent values than simple strings, this method won't be general enough
asHoursMinutesSeconds(long) - Static method in class net.sourceforge.pmd.util.DateTimeUtil
Deprecated.
 
asInverseWithShortName() - Method in class net.sourceforge.pmd.util.TypeMap
Deprecated.
Creates and returns a map of short type names (without the package prefixes) keyed by the classes themselves.
asMethodGroupsByTypeName(Method[]) - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
Return the methods as a map keyed by their common declaration types.
asMethodGroupsByTypeName(List<Method>) - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
Return the methods as a map keyed by their common declaration types.
asOperationNode(Node) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.
asReversed(List<T>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
 
ASSERT_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
AssertionUtil - Class in net.sourceforge.pmd.internal.util
 
assertValidJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
 
asSet(T[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Returns the items as a populated set.
asShortestName(Class<?>) - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
Return the name of the type in its short form if its known to us otherwise return its name fully packaged.
associatedRule(SarifLog.AssociatedRule) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder
An associated rule
asString(E) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
Deprecated.
 
asString(E) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
Deprecated.
 
asString(Class) - Method in class net.sourceforge.pmd.properties.TypeMultiProperty
Deprecated.
 
asString(Class) - Method in class net.sourceforge.pmd.properties.TypeProperty
Deprecated.
 
asString(Object[], String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Formats all items onto a string with separators if more than one exists, return an empty string if the items are null or empty.
asString(Method) - Method in class net.sourceforge.pmd.properties.MethodMultiProperty
Deprecated.
 
asString(Method) - Method in class net.sourceforge.pmd.properties.MethodProperty
Deprecated.
 
asString(Method) - Static method in class net.sourceforge.pmd.properties.modules.MethodPropertyModule
Deprecated.
 
asStringOn(StringBuffer, Iterator<?>, String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
StringUtils.join(Iterator, String)
asStringOn(StringBuilder, Object[], String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
StringUtils.join(Iterable, String)
ASTModel - Class in net.sourceforge.pmd.util.viewer.model
Deprecated.
ASTModel(Node) - Constructor for class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
creates the tree model
ASTNodePopupMenu - Class in net.sourceforge.pmd.util.viewer.gui.menu
Deprecated.
ASTNodePopupMenu(ViewerModel, Node) - Constructor for class net.sourceforge.pmd.util.viewer.gui.menu.ASTNodePopupMenu
Deprecated.
 
ASTPanel - Class in net.sourceforge.pmd.util.viewer.gui
Deprecated.
ASTPanel(ViewerModel) - Constructor for class net.sourceforge.pmd.util.viewer.gui.ASTPanel
Deprecated.
constructs the panel
asTypeNode(Node) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.
atomize() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
atomize() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
atomize() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
attribute - Variable in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
Attribute - Class in net.sourceforge.pmd.lang.ast.xpath
Represents an XPath attribute of a specific node.
Attribute(Node, String, Method) - Constructor for class net.sourceforge.pmd.lang.ast.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.ast.xpath.Attribute
Creates a new attribute belonging to the given node using its string value.
AttributeAxisIterator - Class in net.sourceforge.pmd.lang.ast.xpath
AttributeAxisIterator - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
AttributeAxisIterator(Node) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator
Deprecated.
Creates a new iterator that enumerates the attributes of the given node.
AttributeAxisIterator(ElementNode) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeAxisIterator
Deprecated.
Create an iterator over the Attribute axis for the given ElementNode.
attributeName() - Method in enum net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
Returns the String name of this attribute.
AttributeNode - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
AttributeNode - Interface in net.sourceforge.pmd.lang.ast.xpath
Deprecated.
See Node.getXPathAttributesIterator(). Will be removed in 7.0.0
AttributeNode(ElementNode, Attribute, int) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
Creates a new AttributeNode from a PMD Attribute.
AttributesSubMenu - Class in net.sourceforge.pmd.util.viewer.gui.menu
Deprecated.
AttributesSubMenu(ViewerModel, Node) - Constructor for class net.sourceforge.pmd.util.viewer.gui.menu.AttributesSubMenu
Deprecated.
 
AttributeToolkit - Class in net.sourceforge.pmd.util.viewer.model
Deprecated.
attributeValuesById() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
Will be removed with 7.0.0
auxClassPathChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
AVERAGE - net.sourceforge.pmd.lang.metrics.ResultOption
Compute the average on all operations.

B

backup(int) - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Backs up the input stream by amount steps.
backup(int) - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Retreat.
backup(int) - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Backup a number of characters.
BaseLanguageModule - Class in net.sourceforge.pmd.lang
Created by christoferdutz on 21.09.14.
BaseLanguageModule(String, String, String, Class<?>, String...) - Constructor for class net.sourceforge.pmd.lang.BaseLanguageModule
Deprecated.
Use the other constructor. It doesn't require a rulechain visitor class, but forces you to mention at least one file extension.
BaseLanguageModule(String, String, String, String, String...) - Constructor for class net.sourceforge.pmd.lang.BaseLanguageModule
 
BasicMetricMemoizer<N extends Node> - Class in net.sourceforge.pmd.lang.metrics
Deprecated.
See package description
BasicMetricMemoizer() - Constructor for class net.sourceforge.pmd.lang.metrics.BasicMetricMemoizer
Deprecated.
 
BasicProjectMemoizer<T extends QualifiableNode,​O extends QualifiableNode> - Class in net.sourceforge.pmd.lang.metrics
Deprecated.
See package description
BasicProjectMemoizer() - Constructor for class net.sourceforge.pmd.lang.metrics.BasicProjectMemoizer
Deprecated.
 
beginColumn - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
This will be removed to delegate to the tokens for nodes that are backed by tokens.
beginColumn - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
beginLine - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
This will be removed to delegate to the tokens for nodes that are backed by tokens.
beginLine - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
BeginToken() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns the next character that marks the beginning of the next token.
BeginToken() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
BeginToken() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Start.
Benchmark - Enum in net.sourceforge.pmd.benchmark
Deprecated.
Benchmarker - Class in net.sourceforge.pmd.benchmark
Deprecated.
use TimeTracker instead
BenchmarkReport - Interface in net.sourceforge.pmd.benchmark
Deprecated.
body - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue.Content
 
BODY_PLACEHOLDER - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
 
BomAwareInputStream(InputStream) - Constructor for class net.sourceforge.pmd.util.IOUtil.BomAwareInputStream
Deprecated.
 
BOOLEAN - net.sourceforge.pmd.properties.PropertyTypeId
 
BOOLEAN_LIST - net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
BooleanMultiProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Not useful, will be removed with 7.0.0
BooleanMultiProperty(String, String, Boolean[], float) - Constructor for class net.sourceforge.pmd.properties.BooleanMultiProperty
Deprecated.
Not useful, will be removed with 7.0.0
BooleanMultiProperty(String, String, List<Boolean>, float) - Constructor for class net.sourceforge.pmd.properties.BooleanMultiProperty
Deprecated.
Not useful, will be removed with 7.0.0
BooleanMultiProperty.BooleanMultiPBuilder - Class in net.sourceforge.pmd.properties
Deprecated.
Not useful, will be removed with 7.0.0
booleanProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a boolean property.
BooleanProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<Boolean> instead. A builder is available from PropertyFactory.booleanProperty(String) and its overloads. This class will be removed in 7.0.0.
BooleanProperty(String, String, boolean, float) - Constructor for class net.sourceforge.pmd.properties.BooleanProperty
Deprecated.
BooleanProperty(String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.BooleanProperty
Deprecated.
BooleanProperty.BooleanPBuilder - Class in net.sourceforge.pmd.properties
Deprecated.
BREAK_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
bufcolumn - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
bufcolumn - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
buffer - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
buffer - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
bufline - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
bufline - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
bufpos - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Position in buffer.
bufpos - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Position in buffer.
BUG_RISK - net.sourceforge.pmd.renderers.CodeClimateRule.CodeClimateCategory
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.BooleanMultiProperty.BooleanMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.BooleanProperty.BooleanPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
Deprecated.
Builds the descriptor and returns it.
build() - Method in class net.sourceforge.pmd.properties.CharacterMultiProperty.CharacterMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.CharacterProperty.CharacterPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.DoubleMultiProperty.DoubleMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.DoubleProperty.DoublePBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty.EnumMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.EnumeratedProperty.EnumPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.FileProperty.FilePBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.FloatMultiProperty.FloatMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.FloatProperty.FloatPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.IntegerMultiProperty.IntegerMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.IntegerProperty.IntegerPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.LongMultiProperty.LongMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.LongProperty.LongPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.MethodMultiProperty.MethodMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.MethodProperty.MethodPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder
Builds the descriptor and returns it.
build() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
 
build() - Method in class net.sourceforge.pmd.properties.RegexProperty.RegexPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.StringMultiProperty.StringMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.StringProperty.StringPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.TypeMultiProperty.TypeMultiPBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.properties.TypeProperty.TypePBuilder
Deprecated.
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation.ArtifactLocationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule.AssociatedRuleBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception.ExceptionBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation.InvocationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location.LocationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message.MessageBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage.MultiformatMessageBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation.PhysicalLocationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag.PropertyBagBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.SarifLogBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool.ToolBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification.ToolConfigurationNotificationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder
 
build() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLogBuilder
 
build() - Method in class net.sourceforge.pmd.rules.RuleBuilder
Deprecated.
 
build(Map<PropertyDescriptorField, String>) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
Deprecated.
 
build(Map<PropertyDescriptorField, String>) - Method in interface net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder
Deprecated.
Builds a descriptor.
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
 
builder() - Static method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
 
buildRegexFilterExcludeOverInclude(List<String>, List<String>) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Construct a String Filter using set of include and exclude regular expressions.
buildRegexFilterIncludeOverExclude(List<String>, List<String>) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Construct a String Filter using set of include and exclude regular expressions.
buildRule(Element) - Method in class net.sourceforge.pmd.rules.RuleFactory
Deprecated.
Parses a rule element and returns a new rule instance.
buildUsageText() - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
Deprecated.
 
buildUsageText() - Static method in class net.sourceforge.pmd.cpd.CPDCommandLineInterface
Deprecated.
buildUsageText(JCommander) - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface
Deprecated.
BY_EXTENSION - Static variable in class net.sourceforge.pmd.cpd.LanguageFactory
 

C

CachedRuleMapper - Class in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
CachedRuleMapper() - Constructor for class net.sourceforge.pmd.cache.CachedRuleMapper
Deprecated.
 
CachedRuleViolation - Class in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
cacheExists() - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
Returns true if the cache exists.
cacheExists() - Method in class net.sourceforge.pmd.cache.FileAnalysisCache
Deprecated.
 
call() - Method in class net.sourceforge.pmd.processor.PmdRunnable
Deprecated.
 
call(Context, List) - Method in class net.sourceforge.pmd.lang.xpath.MatchesFunction
Deprecated.
 
callableStatement - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
CallableStatement to return source code.
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
 
canEqual(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
 
canParse() - Method in interface net.sourceforge.pmd.lang.Parser
Deprecated.
With 7.0.0, all parsers will be able to parse and this method will be removed. Note that in the meantime, you probably still need to check this method.
CASE_LAST_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
categories - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
 
CHARACTER - net.sourceforge.pmd.properties.PropertyTypeId
 
CHARACTER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
 
CharacterMultiProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<List<Character>>. A builder is available from PropertyFactory.charListProperty(String). This class will be removed in 7.0.0.
CharacterMultiProperty(String, String, Character[], float, char) - Constructor for class net.sourceforge.pmd.properties.CharacterMultiProperty
CharacterMultiProperty(String, String, List<Character>, float, char) - Constructor for class net.sourceforge.pmd.properties.CharacterMultiProperty
CharacterMultiProperty.CharacterMultiPBuilder - Class in net.sourceforge.pmd.properties
CharacterProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<Character>. A builder is available from PropertyFactory.charProperty(String). This class will be removed in 7.0.0.
CharacterProperty(String, String, Character, float) - Constructor for class net.sourceforge.pmd.properties.CharacterProperty
CharacterProperty(String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.CharacterProperty
CharacterProperty.CharacterPBuilder - Class in net.sourceforge.pmd.properties
CHARACTERSET - net.sourceforge.pmd.util.database.DBType.Property
 
charFrom(String) - Static method in class net.sourceforge.pmd.properties.CharacterProperty
Deprecated.
Parses a String into a Character.
charListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a property having as value a list of characters.
charProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a character property.
CharStream - Interface in net.sourceforge.pmd.lang.ast
Deprecated.
check_name - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
 
checkNumber(T) - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
Deprecated.
 
ChecksumAware - Interface in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
checkValidity(RuleSets, ClassLoader) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
checkValidity(RuleSets, ClassLoader) - Method in interface net.sourceforge.pmd.cache.AnalysisCache
Deprecated.
Checks if the cache is valid for the configured rulesets and class loader.
checkValidity(RuleSets, ClassLoader) - Method in class net.sourceforge.pmd.cache.FileAnalysisCache
Deprecated.
 
checkValidity(RuleSets, ClassLoader) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
Deprecated.
 
checkValue(E) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
childIndex - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
children - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
children - Variable in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
children - Variable in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
children() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
children() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
 
children() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns an iterable enumerating the children of this node.
children() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
childrenAccept(ReportVisitor) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
choiceFrom(String) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
CHOICES - net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
Choices for enumerated properties.
CLARITY - net.sourceforge.pmd.renderers.CodeClimateRule.CodeClimateCategory
Deprecated.
 
CLASS - net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
CLASS - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
 
CLASS_AND_METHOD_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
 
CLASS_LIST - net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
CLASS_METHOD_DELIMITER - Static variable in class net.sourceforge.pmd.properties.modules.MethodPropertyModule
Deprecated.
 
classFilter - Variable in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
classFilter - Variable in class net.sourceforge.pmd.dcd.graph.UsageGraphBuilder
Deprecated.
 
ClassLoaderUtil - Class in net.sourceforge.pmd.dcd
Deprecated.
See DCD
className - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
classNode - Variable in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
ClassNode - Class in net.sourceforge.pmd.dcd.graph
Deprecated.
See DCD
ClassNode - Class in net.sourceforge.pmd.lang.dfa.report
Deprecated.
ClassNode(String) - Constructor for class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
ClassNode(String) - Constructor for class net.sourceforge.pmd.lang.dfa.report.ClassNode
Deprecated.
 
ClassNodeComparator - Class in net.sourceforge.pmd.dcd.graph
Deprecated.
See DCD
ClasspathClassLoader - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
ClasspathClassLoader(String, ClassLoader) - Constructor for class net.sourceforge.pmd.util.ClasspathClassLoader
Deprecated.
 
ClasspathClassLoader(List<File>, ClassLoader) - Constructor for class net.sourceforge.pmd.util.ClasspathClassLoader
Deprecated.
 
ClassUtil - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
clear() - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
Clears the internal data structure used to manage the nodes visited between visiting different ASTs.
clearImages() - Static method in class net.sourceforge.pmd.cpd.TokenEntry
 
clearResults() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
 
CLINIT - Static variable in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
close() - Method in interface net.sourceforge.pmd.benchmark.TimedOperation
Stops tracking if not already stopped.
close() - Method in class net.sourceforge.pmd.document.DocumentFile
 
close() - Method in class net.sourceforge.pmd.lang.document.FileCollector
Close registered resources like zip files.
close() - Method in class net.sourceforge.pmd.PmdAnalysis
 
close() - Method in class net.sourceforge.pmd.RuleSetWriter
 
close() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
 
close() - Method in class net.sourceforge.pmd.util.log.AntLogHandler
Deprecated.
 
close() - Method in class net.sourceforge.pmd.util.log.ConsoleLogHandler
Deprecated.
 
close() - Method in class net.sourceforge.pmd.util.log.ScopedLogHandlersManager
Deprecated.
 
close(int) - Method in interface net.sourceforge.pmd.benchmark.TimedOperation
Stops tracking if not already stopped.
closeAll(Collection<? extends AutoCloseable>) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
Close all closeable resources in order.
closeQuietly(Closeable) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
CODE_RECOMPILED - Static variable in class net.sourceforge.pmd.util.viewer.model.ViewerModelEvent
Deprecated.
reason in the case of code recompilation
CODECLIMATE_BLOCK_HIGHLIGHTING - Static variable in interface net.sourceforge.pmd.renderers.CodeClimateRule
Deprecated.
Defines if the whole related block or just the first line of the issue should be highlighted at the Code Climate Platform.
CODECLIMATE_CATEGORIES - Static variable in interface net.sourceforge.pmd.renderers.CodeClimateRule
Deprecated.
Defines the code climate categories for which this rule will find violations.
CODECLIMATE_DEFAULT_CATEGORIES - Static variable in class net.sourceforge.pmd.renderers.CodeClimateRenderer
 
CODECLIMATE_REMEDIATION_MULTIPLIER - Static variable in interface net.sourceforge.pmd.renderers.CodeClimateRule
Deprecated.
Defines the remediation points for this rule.
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
 
CodeClimateRule - Interface in net.sourceforge.pmd.renderers
Deprecated.
CodeClimateRule.CodeClimateCategory - Enum in net.sourceforge.pmd.renderers
Deprecated.
Represent a CodeClimate category.
CodeEditorTextPane - Class in net.sourceforge.pmd.util.designer
Deprecated.
CodeEditorTextPane() - Constructor for class net.sourceforge.pmd.util.designer.CodeEditorTextPane
Deprecated.
 
CodeLoader() - Constructor for class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
 
collect(List<TokenEntry>) - Method in class net.sourceforge.pmd.cpd.MatchCollector
 
COLLECT_FILES - net.sourceforge.pmd.benchmark.TimedOperationCategory
 
collectDB(FileCollector, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
collectFileList(FileCollector, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
collectFiles(String, FilenameFilter) - Static method in class net.sourceforge.pmd.util.FileUtil
Deprecated.
Collects a list of DataSources using a comma separated list of input file locations to process.
collectFiles(FileCollector, String) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
collectFiles(PMDConfiguration, Set<Language>, MessageReporter) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
collectFiles(PMDConfiguration, FileCollector) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
CollectFiles - net.sourceforge.pmd.benchmark.Benchmark
Deprecated.
 
COLLECTION_CLASSES_BY_NAMES - Static variable in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
 
COLLECTION_INTERFACES_BY_NAMES - Static variable in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
 
CollectionUtil - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
collectorToDataSource(FileCollector) - Static method in class net.sourceforge.pmd.internal.util.FileCollectionUtil
 
collectReports(List<Renderer>) - Method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
Deprecated.
 
collectReports(List<Renderer>) - Method in class net.sourceforge.pmd.processor.MonoThreadProcessor
Deprecated.
 
collectReports(List<Renderer>) - Method in class net.sourceforge.pmd.processor.MultiThreadProcessor
Deprecated.
 
COLOR - Static variable in class net.sourceforge.pmd.renderers.TextColorRenderer
 
column - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
column - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
ColumnDescriptor<T> - Class in net.sourceforge.pmd.renderers
Deprecated.
Is internal API
ColumnDescriptor(String, String, ColumnDescriptor.Accessor<T>) - Constructor for class net.sourceforge.pmd.renderers.ColumnDescriptor
Deprecated.
 
ColumnDescriptor.Accessor<T> - Interface in net.sourceforge.pmd.renderers
Deprecated.
 
columnFromOffset(int, int) - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
 
columnNumberAt(CharSequence, int) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Returns the (1-based) column number of the character at the given index.
commaSeparatedTerseNamesForLanguage(List<Language>) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
This is too specific, will be removed with 7.0.0
commaSeparatedTerseNamesForLanguageVersion(List<LanguageVersion>) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
This is too specific, will be removed with 7.0.0
commitSource(String, LanguageVersion) - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
Commits source code to the model.
compare(Object, Object) - Method in class net.sourceforge.pmd.dcd.graph.ClassNodeComparator
Deprecated.
 
compare(MemberNode, MemberNode) - Method in class net.sourceforge.pmd.dcd.graph.MemberNodeComparator
Deprecated.
 
compare(RuleViolation, RuleViolation) - Method in class net.sourceforge.pmd.RuleViolationComparator
Deprecated.
 
compareOrder(NodeInfo) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
compareOrder(NodeInfo) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
compareOrder(NodeInfo) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
compareTo(RuleDuration) - Method in class net.sourceforge.pmd.benchmark.RuleDuration
Deprecated.
 
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(ClassNode) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
compareTo(FieldNode) - Method in class net.sourceforge.pmd.dcd.graph.FieldNode
Deprecated.
 
compareTo(Language) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
compareTo(LanguageVersion) - Method in class net.sourceforge.pmd.lang.LanguageVersion
 
compareTo(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
Comparing property descriptors is not useful within PMD
compareTo(DataPoint) - Method in class net.sourceforge.pmd.stat.DataPoint
Deprecated.
Compares this data point with the given datapoint.
compareTo(S) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
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.
COMPATIBILITY - net.sourceforge.pmd.renderers.CodeClimateRule.CodeClimateCategory
Deprecated.
 
COMPILE_ACTION - Static variable in class net.sourceforge.pmd.util.viewer.gui.ActionCommands
Deprecated.
 
COMPLEXITY - net.sourceforge.pmd.renderers.CodeClimateRule.CodeClimateCategory
Deprecated.
 
CompoundIterator<T> - Class in net.sourceforge.pmd.util
Deprecated.
CompoundIterator(Iterator<T>...) - Constructor for class net.sourceforge.pmd.util.CompoundIterator
Deprecated.
 
computeAggregate(MetricKey<? super O>, Iterable<? extends O>, MetricOptions, ResultOption) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
Computes an aggregate result for a metric, identified with a ResultOption.
computeAggregate(MetricKey<? super O>, Iterable<? extends O>, ResultOption) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
 
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
Actually computes the value of a metric for an AST node.
computeForOperation(MetricKey<O>, O, boolean, MetricOptions, MetricMemoizer<O>) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsComputer
Deprecated.
 
computeForOperation(MetricKey<O>, O, boolean, MetricOptions, MetricMemoizer<O>) - Method in interface net.sourceforge.pmd.lang.metrics.MetricsComputer
Deprecated.
Computes the value of a metric for an operation and stores the result in the OperationStats object.
computeForOperation(MetricKey<O>, O, MetricOptions) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
Computes a metric identified by its key on a operation AST node.
computeForOperation(MetricKey<O>, O, MetricOptions) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
computeForType(MetricKey<T>, T, boolean, MetricOptions, MetricMemoizer<T>) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsComputer
Deprecated.
 
computeForType(MetricKey<T>, T, boolean, MetricOptions, MetricMemoizer<T>) - Method in interface net.sourceforge.pmd.lang.metrics.MetricsComputer
Deprecated.
Computes the value of a metric for a class and stores the result in the ClassStats object.
computeForType(MetricKey<T>, T, MetricOptions) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
Computes a metric identified by its code on a class AST node, possibly selecting a variant with the MetricOptions parameter.
computeForType(MetricKey<T>, T, MetricOptions) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
computeMetric(MetricKey<? super N>, 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(MetricKey<? super N>, 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(MetricKey<? super N>, 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.
computeMetricOrNaN(MetricKey<? super N>, N, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.MetricsUtil
Deprecated.
This is provided for compatibility with pre 6.21.0 behavior. Users of a metric should always check beforehand if the metric supports the argument.
computeNext() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
 
computePaths() - Method in class net.sourceforge.pmd.lang.dfa.Linker
Deprecated.
Creates all the links between the data flow nodes.
computeWithResultOption(MetricKey<O>, T, boolean, MetricOptions, ResultOption, ProjectMemoizer<T, O>) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsComputer
Deprecated.
 
computeWithResultOption(MetricKey<O>, T, boolean, MetricOptions, ResultOption, ProjectMemoizer<T, O>) - Method in interface net.sourceforge.pmd.lang.metrics.MetricsComputer
Deprecated.
Computes an aggregate result using a ResultOption.
computeWithResultOption(MetricKey<O>, T, MetricOptions, ResultOption) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
Compute the sum, average, or highest value of the operation metric on all operations of the class node.
computeWithResultOption(MetricKey<O>, T, MetricOptions, ResultOption) - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
configErrors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
Accumulated configuration errors.
configErrors() - Method in class net.sourceforge.pmd.Report
configuration - Variable in class net.sourceforge.pmd.PMD
Deprecated.
this configuration field is unused and will be removed. This class PMD should not be instantiated or subclassed. If you need a PMDConfiguration, create a PMDConfiguration instance directly.
configuration - Variable in class net.sourceforge.pmd.processor.AbstractPMDProcessor
Deprecated.
 
ConfigurationError(Rule, String) - Constructor for class net.sourceforge.pmd.Report.ConfigurationError
Creates a new configuration error for a specific rule.
connection - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
Connection management
ConsoleLogHandler - Class in net.sourceforge.pmd.util.log
Deprecated.
This class will be completely removed in 7.0.0
ConsoleLogHandler() - Constructor for class net.sourceforge.pmd.util.log.ConsoleLogHandler
Deprecated.
 
CONSTRUCTOR - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
 
ConstructorNode - Class in net.sourceforge.pmd.dcd.graph
Deprecated.
See DCD
ConstructorNode(ClassNode, String, String) - Constructor for class net.sourceforge.pmd.dcd.graph.ConstructorNode
Deprecated.
 
constructPredicate(Attribute) - Static method in class net.sourceforge.pmd.util.viewer.model.AttributeToolkit
Deprecated.
constructs a predicate from the given attribute
contains(Class<?>) - Method in class net.sourceforge.pmd.util.TypeMap
Deprecated.
Returns whether the type is known to the receiver.
contains(String) - Method in class net.sourceforge.pmd.util.TypeMap
Deprecated.
Returns whether the typeName is known to the receiver.
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
CONTINUE_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
convert(String) - Method in class net.sourceforge.pmd.cli.PMDParameters.PropertyConverter
Deprecated.
 
convert(String) - Method in class net.sourceforge.pmd.cli.PMDParameters.RulePriorityConverter
Deprecated.
 
convert(String) - Method in class net.sourceforge.pmd.cpd.CPDConfiguration.LanguageConverter
 
copy(InputStream, OutputStream) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
copy(Reader, Writer) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
copy(Receiver, int, boolean, int) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
copy(RuleSet) - Static method in class net.sourceforge.pmd.RuleSet
Creates a copy of the given ruleset.
copyPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
copyPropertyValues() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
count(Iterator<?>) - Static method in class net.sourceforge.pmd.internal.util.IteratorUtil
Counts the items in this iterator, exhausting it.
covers(T) - Method in interface net.sourceforge.pmd.lang.metrics.SigMask
Returns true if the parameter is covered by this mask.
CPD - Class in net.sourceforge.pmd.cpd
 
CPD(CPDConfiguration) - Constructor for class net.sourceforge.pmd.cpd.CPD
 
CPD.StatusCode - Enum in net.sourceforge.pmd.cpd
 
CPDCommandLineInterface - Class in net.sourceforge.pmd.cpd
Deprecated.
Internal API. Use CPD.runCpd(String...) or CPD.main(String[]) in order to execute CPD.
CPDConfiguration - Class in net.sourceforge.pmd.cpd
 
CPDConfiguration() - Constructor for class net.sourceforge.pmd.cpd.CPDConfiguration
 
CPDConfiguration.LanguageConverter - Class in net.sourceforge.pmd.cpd
 
CPDListener - Interface in net.sourceforge.pmd.cpd
 
CPDNullListener - Class in net.sourceforge.pmd.cpd
 
CPDNullListener() - Constructor for class net.sourceforge.pmd.cpd.CPDNullListener
 
CPDRenderer - Interface in net.sourceforge.pmd.cpd.renderer
Deprecated.
CPDRendererAdapter - Class in net.sourceforge.pmd.cpd.renderer
Deprecated.
This is internal API. If you want to write your own renderer, directly implement CPDReportRenderer.
CPDRendererAdapter(CPDRenderer) - Constructor for class net.sourceforge.pmd.cpd.renderer.CPDRendererAdapter
Deprecated.
 
CPDReport - Class in net.sourceforge.pmd.cpd
 
CPDReportRenderer - Interface in net.sourceforge.pmd.cpd.renderer
 
CPDTask - Class in net.sourceforge.pmd.cpd
CPDTask
CPDTask() - Constructor for class net.sourceforge.pmd.cpd.CPDTask
 
CPDTask.FormatAttribute - Class in net.sourceforge.pmd.cpd
 
create(String, String, String, Collection<Pattern>, Collection<Pattern>, Iterable<? extends Rule>) - Static method in class net.sourceforge.pmd.RuleSet
Creates a new ruleset with the given metadata such as name, description, fileName, exclude/include patterns are used.
create(PMDConfiguration) - Static method in class net.sourceforge.pmd.PmdAnalysis
Constructs a new instance from a configuration.
createAuxClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
 
createClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
 
createDataFlowNode(List<DataFlowNode>, Node) - Method in interface net.sourceforge.pmd.lang.DataFlowHandler
Deprecated.
 
createEndNode(int) - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
createFactory(ClassLoader, RulePriority, boolean, boolean) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
createFactory(PMDConfiguration) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
createFactory(PMDConfiguration, ClassLoader) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
createFactory(RulePriority, boolean, boolean) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
createFactory(RulePriority, boolean, boolean, boolean) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
createFrom(String) - Method in class net.sourceforge.pmd.properties.BooleanMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.BooleanProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.CharacterMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.CharacterProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.DoubleMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.DoubleProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.FileProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.FloatMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.FloatProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.IntegerMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.IntegerProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.LongMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.LongProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.MethodMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.MethodProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.RegexProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.StringMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.StringProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.TypeMultiProperty
Deprecated.
 
createFrom(String) - Method in class net.sourceforge.pmd.properties.TypeProperty
Deprecated.
 
createLanguage(String) - Static method in class net.sourceforge.pmd.cpd.LanguageFactory
 
createLanguage(String, Properties) - Static method in class net.sourceforge.pmd.cpd.LanguageFactory
 
createNewNode(Node) - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
This class encapsulates the access to the DataFlowNode class.
createNewRuleSet(String, String, String, Collection<String>, Collection<String>, Collection<Rule>) - Method in class net.sourceforge.pmd.RuleSetFactory
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.
createReport(RuleContext, String) - Static method in class net.sourceforge.pmd.Report
Deprecated.
Is internal API
createRuleSet(String) - Method in class net.sourceforge.pmd.RuleSetFactory
Deprecated.
Use RuleSetLoader.loadFromResource(String) and discard the rest of the list.
createRuleSet(RuleSetReferenceId) - Method in class net.sourceforge.pmd.RuleSetFactory
Deprecated.
Will not be replaced
createRuleSetCopy(RuleSet) - Method in class net.sourceforge.pmd.RuleSetFactory
Deprecated.
createRuleSets(String) - Method in class net.sourceforge.pmd.RuleSetFactory
Deprecated.
Use RuleSetLoader.loadFromResource(String), but note that that method does not split on commas
createRuleSets(List<RuleSetReferenceId>) - Method in class net.sourceforge.pmd.RuleSetFactory
Deprecated.
Will not be replaced
createRuleSets(RuleSetFactory, Report) - Method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
Deprecated.
Rulesets are created upstream of the PMDProcessor now.
createRuleViolation(Rule, RuleContext, Node, String) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory
 
createRuleViolation(Rule, RuleContext, Node, String, int, int) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory
 
createSingleRuleRuleSet(Rule) - Method in class net.sourceforge.pmd.RuleSetFactory
createStartNode(int) - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
createTokenManager(Reader) - Method in class net.sourceforge.pmd.lang.AbstractParser
Deprecated.
 
createUnsupportedOperationException(String) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
Used to create a customized instance of UnsupportedOperationException.
createWriter() - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
Creates a writer that writes to stdout using the system default charset.
createWriter(String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
Creates a writer that writes to the given file or to stdout.
createWriter(Charset, String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
Creates a writer that writes to the given file or to stdout.
CreateXMLRulePanel - Class in net.sourceforge.pmd.util.designer
Deprecated.
CreateXMLRulePanel(JTextArea, CodeEditorTextPane) - Constructor for class net.sourceforge.pmd.util.designer.CreateXMLRulePanel
Deprecated.
 
CSVRenderer - Class in net.sourceforge.pmd.cpd
 
CSVRenderer - Class in net.sourceforge.pmd.renderers
Renderer the results to a comma-delimited text format.
CSVRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
 
CSVRenderer() - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
 
CSVRenderer(boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
 
CSVRenderer(char) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
 
CSVRenderer(char, boolean) - Constructor for class net.sourceforge.pmd.cpd.CSVRenderer
 
CSVRenderer(ColumnDescriptor<RuleViolation>[], String, String) - Constructor for class net.sourceforge.pmd.renderers.CSVRenderer
 
CSVWithLinecountPerFileRenderer - Class in net.sourceforge.pmd.cpd
 
CSVWithLinecountPerFileRenderer() - Constructor for class net.sourceforge.pmd.cpd.CSVWithLinecountPerFileRenderer
 
CSVWriter<T> - Class in net.sourceforge.pmd.renderers
A generic writer that formats input items into rows and columns per the provided column descriptors.
CSVWriter(List<ColumnDescriptor<T>>, String, String) - Constructor for class net.sourceforge.pmd.renderers.CSVWriter
 
currentChild - Variable in class net.sourceforge.pmd.lang.dfa.pathfinder.PathElement
Deprecated.
 
CurrentPath - Class in net.sourceforge.pmd.lang.dfa.pathfinder
Deprecated.
CurrentPath() - Constructor for class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 

D

DAAPathFinder - Class in net.sourceforge.pmd.lang.dfa.pathfinder
Deprecated.
DAAPathFinder(DataFlowNode, Executable) - Constructor for class net.sourceforge.pmd.lang.dfa.pathfinder.DAAPathFinder
Deprecated.
 
DAAPathFinder(DataFlowNode, Executable, int) - Constructor for class net.sourceforge.pmd.lang.dfa.pathfinder.DAAPathFinder
Deprecated.
 
DAAPathFinder(DataFlowNode, Executable, int, int) - Constructor for class net.sourceforge.pmd.lang.dfa.pathfinder.DAAPathFinder
Deprecated.
 
dataFlow - Variable in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
DataFlowHandler - Interface in net.sourceforge.pmd.lang
Deprecated.
DataFlowNode - Interface in net.sourceforge.pmd.lang.dfa
Deprecated.
The data flow codebase will be removed in PMD 7. The feature is unreliable, hard to use, and the implementation is unmaintainable. See https://github.com/pmd/pmd/issues/2647
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
 
DataPoint - Class in net.sourceforge.pmd.stat
Deprecated.
DataPoint() - Constructor for class net.sourceforge.pmd.stat.DataPoint
Deprecated.
Constructor for DataPoint.
DataSource - Interface in net.sourceforge.pmd.util.datasource
Represents a source file to be analyzed.
DateTimeUtil - Class in net.sourceforge.pmd.util
Deprecated.
DBMSMetadata - Class in net.sourceforge.pmd.util.database
Wrap JDBC connection for use by PMD: DBURI parameters specify the source code to be passed to PMD.
DBMSMetadata(String, String, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
Define database connection and source code to retrieve with explicit database username and password.
DBMSMetadata(Connection) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
Minimal constructor
DBMSMetadata(Properties, DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
Define database connection and source code to retrieve with database properties.
DBMSMetadata(DBURI) - Constructor for class net.sourceforge.pmd.util.database.DBMSMetadata
Define database connection and source code to retrieve.
DBType - Class in net.sourceforge.pmd.util.database
Encapsulate the settings needed to access database source code.
DBType(String) - Constructor for class net.sourceforge.pmd.util.database.DBType
 
DBType(String, String) - Constructor for class net.sourceforge.pmd.util.database.DBType
Load the most specific dbType for the protocol
DBType.Property - Enum in net.sourceforge.pmd.util.database
The names of the properties
dburi - Variable in class net.sourceforge.pmd.util.database.DBMSMetadata
DBURI
DBURI - Class in net.sourceforge.pmd.util.database
Provide a single parameter to specify database objects to process.
DBURI(String) - Constructor for class net.sourceforge.pmd.util.database.DBURI
Create DBURI from a string, combining a JDBC URL and query parameters.
DBURI(String, String, String, int, String, String, String) - Constructor for class net.sourceforge.pmd.util.database.DBURI
Create a DBURI from standard individual URI components.
DCD - Class in net.sourceforge.pmd.dcd
Deprecated.
DCD was never fully implemented, it has not been touched since the initial commit in 2008. All its codebase will be removed for PMD 7.0.0. Do not use it.
DEBUG - net.sourceforge.pmd.util.log.MessageReporter.Level
Deprecated.
 
decorateRule(Rule, RuleSetReference, Element) - Method in class net.sourceforge.pmd.rules.RuleFactory
Deprecated.
Decorates a referenced rule with the metadata that are overridden in the given rule element.
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
deepCopy() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
 
deepCopy() - Method in interface net.sourceforge.pmd.Rule
Creates a new copy of this rule.
deepCopyValuesTo(AbstractRule) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
Use AbstractRule.deepCopy() to create verbatim copies of rules.
DEFAULT_COMPARATOR - Static variable in interface net.sourceforge.pmd.RuleViolation
A comparator for rule violations.
DEFAULT_DELIMITER - Static variable in interface net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
Deprecated.
DEFAULT_INDEX - net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
Default index for enumerated properties.
DEFAULT_LANGUAGE - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
 
DEFAULT_LINECOUNTPERFILE - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
 
DEFAULT_NAME - Static variable in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
 
DEFAULT_NAME - Static variable in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
 
DEFAULT_NUMERIC_DELIMITER - Static variable in interface net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
Deprecated.
DEFAULT_RENDERER - Static variable in class net.sourceforge.pmd.cpd.CPDConfiguration
 
DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.CSVRenderer
 
DEFAULT_SEPARATOR - Static variable in class net.sourceforge.pmd.cpd.SimpleRenderer
 
DEFAULT_SKIP_BLOCKS_PATTERN - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
 
DEFAULT_SUPPRESS_MARKER - Static variable in class net.sourceforge.pmd.PMDConfiguration
The default suppress marker string.
DEFAULT_VALUE - net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
The default value.
DefaultASTXPathHandler - Class in net.sourceforge.pmd.lang.ast.xpath
Deprecated.
DefaultASTXPathHandler() - Constructor for class net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler
Deprecated.
 
DefaultDesignerBindings() - Constructor for class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
 
defaultFactory() - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
Returns a ruleset factory with default parameters.
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 - Variable in class net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder
Deprecated.
 
defaultValue() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
defaultValue(E) - Method in class net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder
Deprecated.
Specify a default value.
defaultValue(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder
Specify a default value using a string pattern.
defaultValue(String) - Method in class net.sourceforge.pmd.properties.RegexProperty.RegexPBuilder
Deprecated.
Specify a default pattern for the property.
defaultValue(String, int) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.RegexPropertyBuilder
Specify a default value using a string pattern.
defaultValue(Collection<? extends V>) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
Specify a default value.
defaultValue(T) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
Specify a default value.
defaultValues - Variable in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
Deprecated.
 
defaultValues(Collection<? extends V>) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
Deprecated.
Specify a default value.
defaultValues(V...) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
Deprecated.
Specify default values.
defaultValues(V, V...) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
Specify default values.
defaultVersion - Variable in class net.sourceforge.pmd.lang.BaseLanguageModule
 
defineClass(String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
defineConstructor(String, String) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
defineConstructor(String, String, String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
defineField(String, String) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
defineField(String, String, String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
defineMethod(String, String) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
defineMethod(String, String, String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
defineProperty(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.ParserOptions
 
defineProperty(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.rules.RuleBuilder
Deprecated.
 
defineProperty(PropertyDescriptor<T>, T) - Method in class net.sourceforge.pmd.lang.ParserOptions
 
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
definePropertyDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
definePropertyDescriptor(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource
Defines a new property.
DEFINITION - Static variable in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
delete(RegionByLine) - Method in interface net.sourceforge.pmd.document.Document
Delete a region in the document, removing all text which contains it.
delete(RegionByLine) - Method in class net.sourceforge.pmd.document.DocumentFile
 
DeleteDocumentOperation - Class in net.sourceforge.pmd.document
 
DeleteDocumentOperation(int, int, int, int) - Constructor for class net.sourceforge.pmd.document.DeleteDocumentOperation
 
delim(char) - Method in class net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
Deprecated.
Specify a delimiter character.
delim(char) - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
Deprecated.
PMD 7.0.0 will introduce a new XML syntax for multi-valued properties which will not rely on delimiters. This method is kept until this is implemented for compatibility reasons with the pre-7.0.0 framework, but it will be scrapped come 7.0.0.
DELIMITER - net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
For multi-valued properties, this defines the delimiter of the single values.
DELTA - Static variable in class net.sourceforge.pmd.lang.rule.stat.StatisticalRuleHelper
Deprecated.
 
desc - Variable in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
desc(String) - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
Deprecated.
Specify the description of the property.
desc(String) - Method in class net.sourceforge.pmd.properties.PropertyBuilder
Specify the description of the property.
description - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
description - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
Deprecated.
 
description - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
 
description - Variable in class net.sourceforge.pmd.renderers.CodeClimateIssue
 
description() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Describes the property and the role it plays within the rule it is specified for.
description() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
Returns a short description of the format of this renderer's output.
description(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
Deprecated.
 
DESCRIPTION - net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
The description of the property.
Designer - Class in net.sourceforge.pmd.util.designer
Deprecated.
Designer(String[]) - Constructor for class net.sourceforge.pmd.util.designer.Designer
Deprecated.
 
DesignerBindings - Interface in net.sourceforge.pmd.util.designerbindings
Gathers some services to customise how language implementations bind to the designer.
DesignerBindings.AdditionalInfo - Class in net.sourceforge.pmd.util.designerbindings
An entry for the "additional info" panel.
DesignerBindings.DefaultDesignerBindings - Class in net.sourceforge.pmd.util.designerbindings
A base implementation for DesignerBindings.
DesignerBindings.TreeIconId - Enum in net.sourceforge.pmd.util.designerbindings
determineFileName(String) - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
Determines the filename that should be used in the report depending on the option "shortnames".
determineFileName(List<String>, String) - Static method in class net.sourceforge.pmd.internal.util.ShortFilenameUtil
Determines the filename that should be used in the report depending on the option "shortnames".
DFA - net.sourceforge.pmd.benchmark.Benchmark
Deprecated.
 
DFA - net.sourceforge.pmd.benchmark.TimedOperationCategory
 
DFACanvas() - Constructor for class net.sourceforge.pmd.util.designer.DFAPanel.DFACanvas
Deprecated.
 
DFAGraphMethod - Interface in net.sourceforge.pmd.lang.dfa
Deprecated.
Only used by the deprecated designer
DFAGraphRule - Interface in net.sourceforge.pmd.lang.dfa
Deprecated.
Only used by the deprecated designer
DFAPanel - Class in net.sourceforge.pmd.util.designer
Deprecated.
DFAPanel() - Constructor for class net.sourceforge.pmd.util.designer.DFAPanel
Deprecated.
 
DFAPanel.DFACanvas - Class in net.sourceforge.pmd.util.designer
Deprecated.
 
DirectoryFilter - Class in net.sourceforge.pmd.util.filter
Deprecated.
See Filter
displayName() - Method in enum net.sourceforge.pmd.benchmark.TimedOperationCategory
 
DO_BEFORE_FIRST_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
DO_EXPR - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
document - Variable in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
Document - Interface in net.sourceforge.pmd.document
Represents a file which contains programming code that will be fixed.
DocumentFile - Class in net.sourceforge.pmd.document
Implementation that handles a Document as a file in the filesystem and receives operations in a sorted manner (i.e.
DocumentFile(File, Charset) - Constructor for class net.sourceforge.pmd.document.DocumentFile
 
DocumentNavigator - Class in net.sourceforge.pmd.lang.ast.xpath
Deprecated.
DocumentNavigator() - Constructor for class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
DocumentNode - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
DocumentNode(Node) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
DocumentNode(Node, NamePool) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
Construct a DocumentNode, with the given AST Node serving as the root ElementNode.
DocumentOperation - Class in net.sourceforge.pmd.document
Represents an operation in a document which will be managed by DocumentOperationsApplierForNonOverlappingRegions.
DocumentOperation(int, int, int, int) - Constructor for class net.sourceforge.pmd.document.DocumentOperation
 
DocumentOperationsApplierForNonOverlappingRegions - Class in net.sourceforge.pmd.document
 
DocumentOperationsApplierForNonOverlappingRegions(Document) - Constructor for class net.sourceforge.pmd.document.DocumentOperationsApplierForNonOverlappingRegions
 
done() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
 
Done() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.
Done() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Set buffers back to null when finished.
Done() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Reset buffer when finished.
DONE - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
 
doParse(Parser, String, Reader) - Static method in class net.sourceforge.pmd.lang.AbstractParser
Deprecated.
doPMD(PMDConfiguration) - Static method in class net.sourceforge.pmd.PMD
Deprecated.
Use PMD.runPmd(PMDConfiguration). Note that the return value of doPMD changed in PMD 6.44.0 to return -1 in case of error. Previously zero was returned in that case.
DOUBLE - net.sourceforge.pmd.properties.PropertyTypeId
 
DOUBLE_LIST - net.sourceforge.pmd.properties.PropertyTypeId
 
doubleListProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a property having as value a list of decimal numbers.
DoubleMultiProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<List<Double>> instead. A builder is available from PropertyFactory.doubleListProperty(String). This class will be removed in 7.0.0.
DoubleMultiProperty(String, String, Double, Double, Double[], float) - Constructor for class net.sourceforge.pmd.properties.DoubleMultiProperty
DoubleMultiProperty(String, String, Double, Double, List<Double>, float) - Constructor for class net.sourceforge.pmd.properties.DoubleMultiProperty
DoubleMultiProperty.DoubleMultiPBuilder - Class in net.sourceforge.pmd.properties
doubleProperty(String) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a double property.
DoubleProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<Double> instead. A builder is available from PropertyFactory.doubleProperty(String). This class will be removed in 7.0.0.
DoubleProperty(String, String, Double, Double, Double, float) - Constructor for class net.sourceforge.pmd.properties.DoubleProperty
DoubleProperty(String, String, String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.DoubleProperty
DoubleProperty.DoublePBuilder - Class in net.sourceforge.pmd.properties
driver(SarifLog.Component) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool.ToolBuilder
The analysis tool that was run.
DRIVER - net.sourceforge.pmd.util.database.DBType.Property
 
DUMMY - Static variable in interface net.sourceforge.pmd.lang.DataFlowHandler
Deprecated.
 
DUMMY - Static variable in interface net.sourceforge.pmd.lang.VisitorStarter
Deprecated.
Placeholder VisitorStarter implementation that can be used when no real implementation exists yet.
DUMMY - Static variable in interface net.sourceforge.pmd.lang.XPathHandler
Deprecated.
 
dump() - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
dump(UsageGraph, boolean) - Static method in class net.sourceforge.pmd.dcd.DCD
Deprecated.
 
DumpNodeVisitor - Class in net.sourceforge.pmd.dcd
Deprecated.
See DCD
DumpNodeVisitor() - Constructor for class net.sourceforge.pmd.dcd.DumpNodeVisitor
Deprecated.
 
DUPLICATE_CODE_FOUND - net.sourceforge.pmd.cpd.CPD.StatusCode
 
DUPLICATION - net.sourceforge.pmd.renderers.CodeClimateRule.CodeClimateCategory
Deprecated.
 
dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
dysfunctionReason() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
 
dysfunctionReason() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
dysfunctionReason() - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns a description of why the receiver may be dysfunctional.
dysfunctionReason() - Method in class net.sourceforge.pmd.renderers.CSVRenderer
We can't show any violations if we don't have any visible columns.

E

ElementNode - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
ElementNode(DocumentNode, IdGenerator, ElementNode, Node, int) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
ElementNode(DocumentNode, IdGenerator, ElementNode, Node, int, NamePool) - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
ELSE_LAST_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
EmacsRenderer - Class in net.sourceforge.pmd.renderers
Renderer to GNU Emacs parsable format.
EmacsRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmacsRenderer
 
EMPTY_CLASS_ARRAY - Static variable in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
 
emptyDefaultValue() - Method in class net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder
Specify that the default value is an empty collection.
EmptyIterator<T> - Class in net.sourceforge.pmd.util
emptyOptions() - Static method in class net.sourceforge.pmd.lang.metrics.MetricOptions
Returns an empty options bundle.
EmptyRenderer - Class in net.sourceforge.pmd.renderers
An empty renderer, for when you really don't want a report.
EmptyRenderer() - Constructor for class net.sourceforge.pmd.renderers.EmptyRenderer
 
enableCompatibility(boolean) - Method in class net.sourceforge.pmd.RuleSetLoader
Enable translating old rule references to newer ones, if they have been moved or renamed.
ENCODING - Static variable in class net.sourceforge.pmd.renderers.XMLRenderer
 
end() - Method in class net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer
Subclasses should output the AbstractAccumulatingRenderer.report.
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.SummaryHTMLRenderer
 
end() - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
 
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() - Method in class net.sourceforge.pmd.renderers.YAHTMLRenderer
 
end() - Method in class net.sourceforge.pmd.Report
Deprecated.
Not used, Report.getElapsedTimeInMillis() will be removed
end(Report) - Method in class net.sourceforge.pmd.ant.Formatter
Deprecated.
end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
end(RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
end(RuleContext) - Method in interface net.sourceforge.pmd.Rule
End processing.
end(RuleContext) - Method in class net.sourceforge.pmd.RuleSet
Deprecated.
This is internal API, removed in PMD 7. You should not use a ruleset directly.
end(RuleContext) - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Notify all rules of the end of processing.
endColumn - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
This will be removed to delegate to the tokens for nodes that are backed by tokens.
endColumn - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
endColumn(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder
The column number of the character following the end of the region.
endColumn(NodeInfo) - Static method in class net.sourceforge.pmd.lang.xpath.PMDFunctions
Deprecated.
 
endLine - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
This will be removed to delegate to the tokens for nodes that are backed by tokens.
endLine - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
endLine(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region.RegionBuilder
The line number of the last character in the region.
endLine(NodeInfo) - Static method in class net.sourceforge.pmd.lang.xpath.PMDFunctions
Deprecated.
 
endsWith - Variable in class net.sourceforge.pmd.util.filter.RegexStringFilter
Deprecated.
 
ensureClosed(List<? extends AutoCloseable>, Exception) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
Ensure that the closeables are closed.
EnumeratedMultiProperty<E> - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<List<E>> instead. A builder is available from PropertyFactory.enumListProperty(String, Map). This class will be removed in 7.0.0.
EnumeratedMultiProperty(String, String, String[], E[], int[], float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
EnumeratedMultiProperty(String, String, String[], E[], int[], Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
EnumeratedMultiProperty(String, String, Map<String, E>, List<E>, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedMultiProperty
EnumeratedMultiProperty.EnumMultiPBuilder<E> - Class in net.sourceforge.pmd.properties
EnumeratedProperty<E> - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<E> instead. A builder is available from PropertyFactory.enumProperty(String, Map). This class will be removed in 7.0.0.
EnumeratedProperty(String, String, String[], E[], int, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
EnumeratedProperty(String, String, String[], E[], int, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
EnumeratedProperty(String, String, Map<String, E>, E, Class<E>, float) - Constructor for class net.sourceforge.pmd.properties.EnumeratedProperty
EnumeratedProperty.EnumPBuilder<E> - Class in net.sourceforge.pmd.properties
EnumeratedPropertyDescriptor<E,​T> - Interface in net.sourceforge.pmd.properties
Deprecated.
Will be removed with 7.0.0. In the future this interface won't exist, but enumerated properties will still be around
EnumeratedPropertyModule<E> - Class in net.sourceforge.pmd.properties.modules
Deprecated.
EnumeratedPropertyModule(Map<String, E>, Class<E>) - Constructor for class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
enumListProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for a property having as value a list of <T>.
enumProperty(String, Map<String, T>) - Static method in class net.sourceforge.pmd.properties.PropertyFactory
Returns a builder for an enumerated property.
EOF - Static variable in class net.sourceforge.pmd.cpd.TokenEntry
 
EOL - Static variable in class net.sourceforge.pmd.PMD
Deprecated.
EOL - Static variable in class net.sourceforge.pmd.renderers.EmacsRenderer
 
equals(Object) - Method in class net.sourceforge.pmd.cpd.Mark
 
equals(Object) - Method in class net.sourceforge.pmd.cpd.TokenEntry
 
equals(Object) - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
equals(Object) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
equals(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
 
equals(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
This implementation considers to NodeInfo objects to be equal, if their underlying nodes are equal.
equals(Object) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
equals(Object) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetric
Metrics should be stateless, thus any instance of the same metric class should be equal.
equals(Object) - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
 
equals(Object) - Method in class net.sourceforge.pmd.lang.metrics.ParameterizedMetricKey
Deprecated.
 
equals(Object) - Method in class net.sourceforge.pmd.lang.ParserOptions
 
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.ImportWrapper
Deprecated.
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
 
equals(Object) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
 
equals(Object) - Method in class net.sourceforge.pmd.RuleSet
Two rulesets are equals, if they have the same name and contain the same rules.
equals(Object) - Method in class net.sourceforge.pmd.util.database.DBType
 
equals(Object) - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
 
equals(Object) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
 
equals(String, String) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
equals(S) - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
equalsNode(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
Should compare to nodes of the tree.
equalsNode(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.ClassNode
Deprecated.
 
equalsNode(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.PackageNode
Deprecated.
 
equalsNode(AbstractReportNode) - Method in class net.sourceforge.pmd.lang.dfa.report.ViolationNode
Deprecated.
 
equalsNormalizedPaths(String, String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
error(String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
 
ERROR - net.sourceforge.pmd.cpd.CPD.StatusCode
 
ERROR - net.sourceforge.pmd.PMD.StatusCode
Errors were detected, PMD may have not run to the end.
ERROR - net.sourceforge.pmd.util.log.MessageReporter.Level
Deprecated.
 
ERROR_STATUS - Static variable in class net.sourceforge.pmd.cli.PMDCommandLineInterface
Deprecated.
errorEx(String, Object[], Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
 
errorEx(String, Throwable) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
 
errorFor(E) - Method in class net.sourceforge.pmd.properties.EnumeratedProperty
Deprecated.
 
errorFor(E) - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
errorFor(List<E>) - Method in class net.sourceforge.pmd.properties.EnumeratedMultiProperty
Deprecated.
 
errorFor(T) - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
PMD 7.0.0 will change the return type to Optional<String>
errors - Variable in class net.sourceforge.pmd.renderers.AbstractIncrementingRenderer
Accumulated processing errors.
errors() - Method in class net.sourceforge.pmd.Report
escapeJava(String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
escapeWhitespace(Object) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Replace some whitespace characters so they are visually apparent.
evaluate(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.xpath.AbstractXPathRuleQuery
Deprecated.
 
evaluate(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.xpath.JaxenXPathRuleQuery
Deprecated.
 
evaluate(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
 
evaluate(Node, RuleContext) - Method in interface net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery
Deprecated.
Evaluate the XPath query against the given Node.
evaluate(Node, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.XPathRule
EVALUATE_ACTION - Static variable in class net.sourceforge.pmd.util.viewer.gui.ActionCommands
Deprecated.
 
evaluateXPathExpression(String, Object) - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
Evaluates the given XPath expression against the current tree.
EvaluationResultsPanel - Class in net.sourceforge.pmd.util.viewer.gui
Deprecated.
EvaluationResultsPanel(ViewerModel) - Constructor for class net.sourceforge.pmd.util.viewer.gui.EvaluationResultsPanel
Deprecated.
constructs the panel
exception(SarifLog.Exception) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification.ToolExecutionNotificationBuilder
A exception component to detail the tool exception
exclude(FileCollector) - Method in class net.sourceforge.pmd.lang.document.FileCollector
Remove all files collected by the given collector from this one.
Executable - Interface in net.sourceforge.pmd.lang.dfa.pathfinder
Deprecated.
execute() - Method in class net.sourceforge.pmd.ant.PMDTask
 
execute() - Method in class net.sourceforge.pmd.cpd.CPDTask
 
execute(CurrentPath) - Method in interface net.sourceforge.pmd.lang.dfa.pathfinder.Executable
Deprecated.
 
executionClassPathChecksum - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
executionSuccessful(Boolean) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation.InvocationBuilder
 
ExpandBuff(boolean) - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
ExpandBuff(boolean) - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
expandVariables(String) - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
Experimental - Annotation Type in net.sourceforge.pmd.annotation
Indicates the feature is in experimental state: its existence, signature or behavior might change without warning from one release to the next.
EXTENSION - Static variable in class net.sourceforge.pmd.cpd.LanguageFactory
 
extensions - Variable in class net.sourceforge.pmd.lang.BaseLanguageModule
 
extensions - Variable in class net.sourceforge.pmd.util.filter.FileExtensionFilter
Deprecated.
 
externalInfoUrl(String) - Method in class net.sourceforge.pmd.rules.RuleBuilder
Deprecated.
 
extractor() - Static method in class net.sourceforge.pmd.properties.TypeMultiProperty
Deprecated.
 
extractParameters(String...) - Static method in class net.sourceforge.pmd.cli.PmdParametersParseResult
Parse an array of CLI parameters and returns a result (which may be failed).
extractParameters(PMDParameters, String[], String) - Static method in class net.sourceforge.pmd.cli.PMDCommandLineInterface

F

factoryFor(String) - Static method in enum net.sourceforge.pmd.properties.PropertyTypeId
FIELD - net.sourceforge.pmd.util.designerbindings.DesignerBindings.TreeIconId
 
FieldNode - Class in net.sourceforge.pmd.dcd.graph
Deprecated.
See DCD
FieldNode(ClassNode, String, String) - Constructor for class net.sourceforge.pmd.dcd.graph.FieldNode
Deprecated.
 
FILE_NAME - Static variable in class net.sourceforge.pmd.renderers.IDEAJRenderer
 
FILE_PROCESSING - net.sourceforge.pmd.benchmark.TimedOperationCategory
 
FileAnalysisCache - Class in net.sourceforge.pmd.cache
Deprecated.
This is internal API, will be hidden with 7.0.0
FileAnalysisCache(File) - Constructor for class net.sourceforge.pmd.cache.FileAnalysisCache
Deprecated.
Creates a new cache backed by the given file.
FileCodeLoader(File, String) - Constructor for class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
 
FileCollectionUtil - Class in net.sourceforge.pmd.internal.util
 
FileCollector - Class in net.sourceforge.pmd.lang.document
Collects files to analyse before a PMD run.
FileDataSource - Class in net.sourceforge.pmd.util.datasource
DataSource implementation to read data from a file.
FileDataSource(File) - Constructor for class net.sourceforge.pmd.util.datasource.FileDataSource
 
FileExtensionFilter - Class in net.sourceforge.pmd.util.filter
Deprecated.
See Filter
FileExtensionFilter(boolean, String...) - Constructor for class net.sourceforge.pmd.util.filter.FileExtensionFilter
Deprecated.
Matches any files with the given extensions, optionally ignoring case.
FileExtensionFilter(String...) - Constructor for class net.sourceforge.pmd.util.filter.FileExtensionFilter
Deprecated.
Matches any files with the given extensions, ignoring case
FileFinder - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
FileFinder() - Constructor for class net.sourceforge.pmd.util.FileFinder
Deprecated.
 
FileIterable - Class in net.sourceforge.pmd.util
Deprecated.
Just use Files.readAllLines(Path, Charset) or lines on Java 8
FileIterable(File) - Constructor for class net.sourceforge.pmd.util.FileIterable
Deprecated.
 
filename - Variable in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
fileName(XPathContext) - Static method in class net.sourceforge.pmd.lang.xpath.PMDFunctions
Deprecated.
 
filenameFilter() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
filenameFrom(DataSource) - Method in class net.sourceforge.pmd.processor.AbstractPMDProcessor
Deprecated.
this method will be removed. It was once used to determine a short filename for the file being analyzed, so that shortnames can be reported. But the logic has been moved to the renderers.
FileProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Will be removed with 7.0.0 with no scheduled replacement
FileProperty(String, String, File, float) - Constructor for class net.sourceforge.pmd.properties.FileProperty
Deprecated.
Constructor for file property.
FileProperty.FilePBuilder - Class in net.sourceforge.pmd.properties
Deprecated.
 
FileReporter - Class in net.sourceforge.pmd.cpd
Deprecated.
CPDRenderer directly renders to a Writer
FileReporter(File) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
Deprecated.
 
FileReporter(File, String) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
Deprecated.
 
FileReporter(String) - Constructor for class net.sourceforge.pmd.cpd.FileReporter
Deprecated.
 
fileResultsCache - Variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
files() - Method in class net.sourceforge.pmd.PmdAnalysis
Returns the file collector for the analysed sources.
FileUtil - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
FillBuff() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
FillBuff() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
filter - Variable in class net.sourceforge.pmd.util.filter.AbstractDelegateFilter
Deprecated.
 
filter(File) - Method in class net.sourceforge.pmd.util.filter.DirectoryFilter
Deprecated.
 
filter(File) - Method in class net.sourceforge.pmd.util.filter.FileExtensionFilter
Deprecated.
 
filter(String) - Method in class net.sourceforge.pmd.util.filter.RegexStringFilter
Deprecated.
 
filter(AxisIterator, NodeTest) - Static method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
filter(Filter<T>, Collection<T>) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Filter a given Collection.
filter(T) - Method in class net.sourceforge.pmd.util.filter.AbstractDelegateFilter
Deprecated.
 
filter(T) - Method in class net.sourceforge.pmd.util.filter.AndFilter
Deprecated.
 
filter(T) - Method in interface net.sourceforge.pmd.util.filter.Filter
Deprecated.
 
filter(T) - Method in class net.sourceforge.pmd.util.filter.NotFilter
Deprecated.
 
filter(T) - Method in class net.sourceforge.pmd.util.filter.OrFilter
Deprecated.
 
Filter<T> - Interface in net.sourceforge.pmd.util.filter
Deprecated.
Will be replaced with standard java.util.function.Predicate with 7.0.0
filterAbovePriority(RulePriority) - Method in class net.sourceforge.pmd.RuleSetLoader
Filter loaded rules to only those that match or are above the given priority.
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.
filterRuleSetFile(InputStream) - Method in class net.sourceforge.pmd.RuleSetFactoryCompatibility
Deprecated.
Applies all configured filters against the given input stream.
filters - Variable in class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
Filters - Class in net.sourceforge.pmd.util.filter
Deprecated.
Internal API, see Filter
filterViolations(Predicate<RuleViolation>) - Method in class net.sourceforge.pmd.Report
Creates a new report taking all the information from this report, but filtering the violations.
finalize() - Method in class net.sourceforge.pmd.util.FileIterable
Deprecated.
 
findAllVersions() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
This is not useful, will be removed with 7.0.0
findByExtension(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Returns all languages that support the given extension.
findById(String) - Static method in class net.sourceforge.pmd.util.treeexport.TreeRenderers
Returns the renderer descriptor registered by the given ID.
findChildNodesWithXPath(String) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
findChildNodesWithXPath(String) - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
This is very inefficient and should not be used in new code. PMD 7.0.0 will remove support for this method.
findChildrenOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
findChildrenOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses the children to find all the instances of type childType or one of its subclasses.
findDescendantsOfType(Class<? extends T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
findDescendantsOfType(Class<? extends T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses down the tree to find all the descendant instances of type descendantType without crossing find boundaries.
findDescendantsOfType(Class<T>, boolean) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
findDescendantsOfType(Class<T>, boolean) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses down the tree to find all the descendant instances of type descendantType.
findDescendantsOfType(Class<T>, List<T>, boolean) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
Use AbstractNode.findDescendantsOfType(Class, boolean) instead, which returns a result list.
findDescendantsOfType(Class<T>, List<T>, boolean) - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
Use Node.findDescendantsOfType(Class, boolean) instead, which returns a result list.
findFilesFrom(File, FilenameFilter, boolean) - Method in class net.sourceforge.pmd.util.FileFinder
Deprecated.
Searches for files in a given directory.
findLanguageByTerseName(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Returns a language from its terse name (eg "java").
findLanguageVersionByTerseName(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
This is not useful, will be removed with 7.0.0
findMatches() - Method in class net.sourceforge.pmd.cpd.MatchAlgorithm
 
findOperations(T) - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsComputer
Deprecated.
Finds the declaration nodes of all methods or constructors that are declared inside a class.
findPatternInFile(File, String) - Static method in class net.sourceforge.pmd.util.FileUtil
Deprecated.
Handy method to find a certain pattern into a file.
findWithRuleSupport() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
This method will be removed with PMD 7.0.0. Use LanguageRegistry.getLanguages() instead.
FINGERPRINTER - Static variable in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
finishThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
Finishes tracking a thread.
fireTreeModelEvent(TreeModelEvent) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
fireViewerModelEvent(ViewerModelEvent) - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
 
firstToken - Variable in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
FLOAT - net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
FLOAT_LIST - net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
FLOAT_ZERO - Static variable in class net.sourceforge.pmd.util.NumericConstants
Deprecated.
 
FloatMultiProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<List<Double>> instead. A builder is available from PropertyFactory.doubleListProperty(String). This class will be removed in 7.0.0.
FloatMultiProperty(String, String, Float, Float, Float[], float) - Constructor for class net.sourceforge.pmd.properties.FloatMultiProperty
FloatMultiProperty(String, String, Float, Float, List<Float>, float) - Constructor for class net.sourceforge.pmd.properties.FloatMultiProperty
FloatMultiProperty.FloatMultiPBuilder - Class in net.sourceforge.pmd.properties
FloatProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use PropertyFactory.doubleProperty(String) instead. This class will be removed with 7.0.0.
FloatProperty(String, String, Float, Float, Float, float) - Constructor for class net.sourceforge.pmd.properties.FloatProperty
Deprecated.
FloatProperty(String, String, String, String, String, float) - Constructor for class net.sourceforge.pmd.properties.FloatProperty
Deprecated.
FloatProperty.FloatPBuilder - Class in net.sourceforge.pmd.properties
Deprecated.
flush() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
 
flush() - Method in interface net.sourceforge.pmd.renderers.Renderer
 
flush() - Method in class net.sourceforge.pmd.util.log.AntLogHandler
Deprecated.
 
flush() - Method in class net.sourceforge.pmd.util.log.ConsoleLogHandler
Deprecated.
 
FOR_BEFORE_FIRST_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
FOR_END - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
FOR_EXPR - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
FOR_INIT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
FOR_UPDATE - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
format(LogRecord) - Method in class net.sourceforge.pmd.util.log.PmdLogFormatter
Deprecated.
 
FormatAttribute() - Constructor for class net.sourceforge.pmd.cpd.CPDTask.FormatAttribute
 
Formatter - Class in net.sourceforge.pmd.ant
 
Formatter() - Constructor for class net.sourceforge.pmd.ant.Formatter
 
formatValueForXPath(Attribute) - Static method in class net.sourceforge.pmd.util.viewer.model.AttributeToolkit
Deprecated.
formats a value for its usage in XPath expressions
forSingleRule(Rule) - Static method in class net.sourceforge.pmd.RuleSet
Creates a new ruleset containing a single rule.
fromInternalForm(String) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
fromPmdConfig(PMDConfiguration) - Static method in class net.sourceforge.pmd.RuleSetLoader
Configure a new ruleset factory builder according to the parameters of the given PMD configuration.
fromReader(Reader) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
fromStringFilter(Filter<String>) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Given a String Filter, expose as a Filter on another type.
fromWriter(Writer, String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
fullDescription(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
A description of the report.

G

generate(Map<String, BenchmarkResult>, PrintStream) - Method in interface net.sourceforge.pmd.benchmark.BenchmarkReport
Deprecated.
 
generate(Map<String, BenchmarkResult>, PrintStream) - Method in class net.sourceforge.pmd.benchmark.TextReport
Deprecated.
 
generate(Set<RuleDuration>, PrintStream) - Method in interface net.sourceforge.pmd.benchmark.BenchmarkReport
Deprecated.
 
generate(Set<RuleDuration>, PrintStream) - Method in class net.sourceforge.pmd.benchmark.TextReport
Deprecated.
 
generateId(FastStringBuffer) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
GenericToken - Interface in net.sourceforge.pmd.lang.ast
Represents a language-independent token such as constants, values language reserved keywords, or comments.
get(int, T, String) - Method in interface net.sourceforge.pmd.renderers.ColumnDescriptor.Accessor
Deprecated.
 
get(DataMap.DataKey<? extends K, ? extends T>) - Method in class net.sourceforge.pmd.util.DataMap
Retrieves the data currently mapped to the key.
GET_SOURCE_CODE_STATEMENT - net.sourceforge.pmd.util.database.DBType.Property
 
getAccessType() - Method in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
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.
getAllInputPaths() - Method in class net.sourceforge.pmd.PMDConfiguration
Returns an unmodifiable list.
getAllowsChildren() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
getAllRules() - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Return all rules from all rulesets.
getAllRuleSets() - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Get all the RuleSets.
getAnalysisCache() - Method in class net.sourceforge.pmd.PMDConfiguration
Retrieves the currently used analysis cache.
getAnother() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeAxisIterator
Deprecated.
 
getAntLogLevel() - Method in class net.sourceforge.pmd.util.log.AntLogHandler
Deprecated.
 
getApplicableFiles(PMDConfiguration, Set<Language>) - Static method in class net.sourceforge.pmd.PMD
Deprecated.
This may leak resources and should not be used directly. Use PmdAnalysis.
getArtifactLocation() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
The location of the artifact.
getAsDocument() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
getAsDocument() - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
Converting a tree to a DOM is not a standard use case. The implementation rethrows a ParserConfigurationException as a RuntimeException, but a caller should handle it if he really wants to do this. Another problem is that this is available on any node, yet only the root node of a tree corresponds really to a document. The conversion is easy to implement anyway, and does not have to be part of this API.
getAssociatedRule() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
An associated rule
getAtomicRepresentation(Object) - Static method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
Gets the Saxon representation of the parameter, if its type corresponds to an XPath 2.0 atomic datatype.
getAttrCtx() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
getAttribute(String) - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Stateful methods of the rule context will be removed. Their interaction with incremental analysis are unspecified.
getAttributeAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getAttributeIterator() - Method in interface net.sourceforge.pmd.lang.ast.xpath.AttributeNode
Deprecated.
 
getAttributeName(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getAttributeNamespaceUri(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getAttributeQName(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getAttributeStringValue(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getAttributeValue(int) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getAuxclasspath() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getAuxClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getAvailableOperationMetrics() - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
Returns a list of all supported operation metric keys for the language.
getAvailableTypeMetrics() - Method in interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider
Returns a list of all supported type metric keys for the language.
getAverage() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getBaseURI() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getBeginColumn() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getBeginColumn() - Method in class net.sourceforge.pmd.cpd.Mark
The column number where this duplication begins.
getBeginColumn() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getBeginColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
The column number where this token begins.
getBeginColumn() - Method in interface net.sourceforge.pmd.document.RegionByLine
 
getBeginColumn() - Method in class net.sourceforge.pmd.document.RegionByLineImp
 
getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets the column offset from the start of the begin line where the token's region begins
getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
getBeginColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
 
getBeginColumn() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get token beginning column number.
getBeginColumn() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getBeginColumn() - Method in interface net.sourceforge.pmd.RuleViolation
Get the column number of the begin line in the source file in which this violation was identified.
getBeginLine() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getBeginLine() - Method in class net.sourceforge.pmd.cpd.Mark
 
getBeginLine() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getBeginLine() - Method in class net.sourceforge.pmd.cpd.TokenEntry
 
getBeginLine() - Method in interface net.sourceforge.pmd.document.RegionByLine
 
getBeginLine() - Method in class net.sourceforge.pmd.document.RegionByLineImp
 
getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets the line where the token's region begins
getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
getBeginLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
 
getBeginLine() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get token beginning line number.
getBeginLine() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getBeginLine() - Method in interface net.sourceforge.pmd.RuleViolation
Get the begin line number in the source file in which this violation was identified.
getBeginTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
 
getBomCharsetName() - Method in class net.sourceforge.pmd.util.IOUtil.BomAwareInputStream
Deprecated.
 
getBraceStack() - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
getCachedViolations(File) - Method in class net.sourceforge.pmd.cache.AbstractAnalysisCache
Deprecated.
 
getCachedViolations(File) - Method in interface net.sourceforge.pmd.cache.AnalysisCache
Deprecated.
Retrieves cached violations for the given file.
getCachedViolations(File) - Method in class net.sourceforge.pmd.cache.NoopAnalysisCache
Deprecated.
 
getCacheLocation() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getCalculator() - Method in interface net.sourceforge.pmd.lang.metrics.MetricKey
Returns the object used to calculate the metric.
getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBType
 
getCharacterSet() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getCharStreamFromSourceCode(SourceCode) - Static method in class net.sourceforge.pmd.cpd.AntlrTokenizer
Deprecated.
 
getChecksum() - Method in interface net.sourceforge.pmd.cache.ChecksumAware
Deprecated.
Retrieves the current instance checksum
getChecksum() - Method in class net.sourceforge.pmd.RuleSet
 
getChecksum() - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Retrieves a checksum of the rulesets being used.
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getChild(int) - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
 
getChild(int) - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns the child of this node at the given index.
getChild(Object, int) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
getChildAt(int) - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
getChildAt(int) - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
getChildAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get an iterator over all of this node's children.
getChildCount() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
getChildCount() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
getChildCount(Object) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
getChildren() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getChildren() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getChoicesByLabel() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
getClass(String) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getClassLoader() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the ClassLoader being used by PMD when processing Rules.
getClassMemoizer(QualifiedName) - Method in class net.sourceforge.pmd.lang.metrics.BasicProjectMemoizer
Deprecated.
 
getClassMemoizer(QualifiedName) - Method in interface net.sourceforge.pmd.lang.metrics.ProjectMemoizer
Deprecated.
Gets the class metric memoizer corresponding to the qualified name.
getClassName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getClassName() - Method in interface net.sourceforge.pmd.lang.ast.QualifiedName
Deprecated.
Returns the qualified name of the class the resource is located in.
getClassName() - Method in class net.sourceforge.pmd.lang.dfa.report.ClassNode
Deprecated.
 
getClassName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getClassName() - Method in interface net.sourceforge.pmd.RuleViolation
Get the name of the Class in which this violation was identified.
getClassNode() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getClasspath() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getClassShortNames() - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
 
getCode() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
 
getCode() - Method in class net.sourceforge.pmd.cpd.SourceCode
 
getCodeBuffer() - Method in class net.sourceforge.pmd.cpd.SourceCode
Newlines are normalized to \n.
getCodeSlice(int, int) - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
Loads a range of lines.
getCollectedFiles() - Method in class net.sourceforge.pmd.lang.document.FileCollector
Returns an unmodifiable list of all files that have been collected.
getCollectionTypeFor(String) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Returns the collection type if we recognize it by its short name.
getColumn() - Method in exception net.sourceforge.pmd.lang.antlr.AntlrTokenManager.ANTLRSyntaxError
Deprecated.
 
getColumn() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
getColumn() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
getColumn() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
getColumn() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
 
getColumnNumber() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getColumnNumber() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getCommentStringValue(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getConfiguration() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getConfiguration() - Method in class net.sourceforge.pmd.PMD
Deprecated.
Don't create a PMD instance just to create a PMDConfiguration
getConfigurationErrors() - Method in class net.sourceforge.pmd.Report
Returns an unmodifiable list of configuration errors that have been recorded until now.
getConnection() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
Return JDBC Connection for direct JDBC access to the specified database.
getConstant(String) - Static method in enum net.sourceforge.pmd.properties.PropertyDescriptorField
Deprecated.
 
getConstraintDescription() - Method in interface net.sourceforge.pmd.properties.constraints.PropertyConstraint
Returns a description of the constraint imposed by this validator on the values.
getConstructor(Class<?>, String, Class<?>...) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getConstructorNodes() - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
getContinueBreakReturnStack() - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
getCount() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getCountSummary() - Method in class net.sourceforge.pmd.Report
Deprecated.
This is too specific. Not every violation has a qualified name.
getCPDRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
Deprecated.
Internal API.
getCPDRendererFromString(String, String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
Deprecated.
Internal API
getCurrentRule() - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Internal API.
getDataFlowFacade() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getDataFlowFacade() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getDataFlowHandler() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getDataFlowHandler() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
This is internal API
getDataFlowNode() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getDataFlowNode() - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
This is Java-specific and will be removed from this interface
getDataFlowNode() - Method in class net.sourceforge.pmd.lang.dfa.StackObject
Deprecated.
 
getDataSourceName() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
 
getDbType() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getDecl() - Method in class net.sourceforge.pmd.lang.symboltable.ImageFinderFunction
 
getDeclarations() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
getDeclarations() - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
Gets all the declaration with the occurrences in this scope.
getDeclarations(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
getDeclarations(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
Helper method to get only a specific type of name declarations.
getDeclaredNamespaces(int[]) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getDefaultLanguage() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Returns a "default language" known to the service loader.
getDefaultLanguageVersion(Language) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
Get the current default LanguageVersion for the given Language.
getDefaultLanguageVersionForFile(File) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
Get the default LanguageVersion for the first Language of a given source file.
getDefaultLanguageVersionForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
Get the LanguageVersion for the first Language of a source file with the given name.
getDefaultParserOptions() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getDefaultParserOptions() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Get the default ParserOptions.
getDefaultVersion() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getDefaultVersion() - Method in interface net.sourceforge.pmd.lang.Language
Returns the default language version for this language.
getDeprecatedOptionsUsed() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
Returns a map of deprecated CLI options used by the command that created this instance.
getDesc() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getDescription() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getDescription() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getDescription() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getDescription() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getDescription() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
 
getDescription() - Method in interface net.sourceforge.pmd.renderers.Renderer
Get the description of the Renderer.
getDescription() - Method in interface net.sourceforge.pmd.Rule
Get the description of this Rule.
getDescription() - Method in class net.sourceforge.pmd.RuleSet
 
getDescription() - Method in interface net.sourceforge.pmd.RuleViolation
Get the description of this violation.
getDescription() - Method in enum net.sourceforge.pmd.util.database.DBType.Property
 
getDesignerBindings() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getDesignerBindings() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Returns the designer bindings for this language version.
getDetail() - Method in class net.sourceforge.pmd.Report.ProcessingError
 
getDFAGraphRule() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getDFAGraphRule() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
This is internal API
getDirectoryFilter() - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Get a File Filter for directories.
getDisplayName() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getDisplayName() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getDisplayName() - Method in interface net.sourceforge.pmd.lang.document.TextFile
Returns a display name for the file.
getDisplayString() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
Returns the string displayed to the user.
getDoBranchNodeFromFirstDoStatement() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
getDocumentNode(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getDocumentNumber() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
This implementation always returns 0.
getDocumentRoot() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getDocumentRoot() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
getDocumentRoot() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getDriver() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
The analysis tool that was run.
getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBType
 
getDriverClass() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getDumpFacade(Writer, String, boolean) - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
Deprecated.
getDumpFacade(Writer, String, boolean) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
The dump façade is not that useful and will be completely scrapped with PMD 7.0.0
getElapsedTimeInMillis() - Method in class net.sourceforge.pmd.Report
Deprecated.
Unused
getElementName(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getElementNamespaceUri(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getElementQName(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getElementStringValue(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getEmptyStrings() - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Returns an empty array of string
getEnclosingScope(Class<T>) - Method in class net.sourceforge.pmd.lang.symboltable.AbstractScope
 
getEnclosingScope(Class<T>) - Method in interface net.sourceforge.pmd.lang.symboltable.Scope
Helper method that goes up the parent scopes to find a scope of the specified type
getEncoding() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getEncoding() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getEncoding() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getEncoding() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
 
getEncoding() - Method in class net.sourceforge.pmd.cpd.XMLRenderer
 
getEndColumn() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getEndColumn() - Method in class net.sourceforge.pmd.cpd.Mark
The column number where this duplication ends.
getEndColumn() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getEndColumn() - Method in class net.sourceforge.pmd.cpd.TokenEntry
The column number where this token ends.
getEndColumn() - Method in interface net.sourceforge.pmd.document.RegionByLine
 
getEndColumn() - Method in class net.sourceforge.pmd.document.RegionByLineImp
 
getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets the column offset from the start of the end line where the token's region ends
getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Get end column.
getEndColumn() - Method in interface net.sourceforge.pmd.lang.ast.Node
 
getEndColumn() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get token end column number.
getEndColumn() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getEndColumn() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
The column number of the character following the end of the region.
getEndColumn() - Method in interface net.sourceforge.pmd.RuleViolation
Get the column number of the end line in the source file in which this violation was identified.
getEndIndex() - Method in class net.sourceforge.pmd.cpd.Match
 
getEndLine() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getEndLine() - Method in class net.sourceforge.pmd.cpd.Mark
 
getEndLine() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getEndLine() - Method in interface net.sourceforge.pmd.document.RegionByLine
 
getEndLine() - Method in class net.sourceforge.pmd.document.RegionByLineImp
 
getEndLine() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets the line where the token's region ends
getEndLine() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
Get end line.
getEndLine() - Method in interface net.sourceforge.pmd.lang.ast.Node
 
getEndLine() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get token end line number.
getEndLine() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getEndLine() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
The line number of the last character in the region.
getEndLine() - Method in interface net.sourceforge.pmd.RuleViolation
Get the end line number in the source file in which this violation was identified.
getEndsWith() - Method in class net.sourceforge.pmd.util.filter.RegexStringFilter
Deprecated.
 
getEndToken(TokenEntry, Match) - Method in class net.sourceforge.pmd.cpd.Tokens
 
getEndTokenIndex() - Method in class net.sourceforge.pmd.cpd.Mark
 
getEOF() - Static method in class net.sourceforge.pmd.cpd.TokenEntry
 
getError() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
Returns the error if parsing failed.
getError() - Method in class net.sourceforge.pmd.Report.ProcessingError
 
getExamples() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getExamples() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getExamples() - Method in interface net.sourceforge.pmd.Rule
Get the list of examples for this Rule.
getException() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
A exception component to detail the tool exception
getExcludePatterns() - Method in class net.sourceforge.pmd.RuleSet
getExcludes() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getExcludes() - Method in class net.sourceforge.pmd.RuleSetReference
Deprecated.
 
getExecutionSuccessful() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
getExtensions() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
 
getExtensions() - Method in interface net.sourceforge.pmd.cpd.Language
 
getExtensions() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getExtensions() - Method in interface net.sourceforge.pmd.lang.Language
Returns the list of file extensions associated with this language.
getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getExternalInfoUrl() - Method in interface net.sourceforge.pmd.Rule
Get a URL for external information about this Rule.
getFactory() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
getFailuresPropertyName() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getField(Class<?>, String) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getFieldNodes() - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
getFieldType() - Method in class net.sourceforge.pmd.dcd.asm.TypeSignatureVisitor
Deprecated.
 
getFile() - Method in class net.sourceforge.pmd.ant.RuleSetWrapper
 
getFile() - Method in class net.sourceforge.pmd.Report.ProcessingError
 
getFileChecksum() - Method in class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
getFileExclusions() - Method in class net.sourceforge.pmd.RuleSet
Returns the file exclusion patterns as an unmodifiable list.
getFileExtensionFilter(String...) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Get a File Filter for files with the given extensions, ignoring case.
getFileExtensionOrDirectoryFilter(String...) - Static method in class net.sourceforge.pmd.util.filter.Filters
Deprecated.
Get a File Filter for directories or for files with the given extensions, ignoring case.
getFileFilter() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
 
getFileFilter() - Method in interface net.sourceforge.pmd.cpd.Language
 
getFileInclusions() - Method in class net.sourceforge.pmd.RuleSet
Returns the file inclusion patterns as an unmodifiable list.
getFileListPath() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getFileListPath() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getFilename() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getFilename() - Method in class net.sourceforge.pmd.cpd.Mark
 
getFilename() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
 
getFilename() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getFilename() - Method in interface net.sourceforge.pmd.RuleViolation
Get the source file name in which this violation was identified.
getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
 
getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
 
getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode
 
getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
 
getFileName() - Method in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
 
getFileName() - Method in class net.sourceforge.pmd.lang.antlr.AntlrTokenManager
 
getFileName() - Static method in class net.sourceforge.pmd.lang.ast.AbstractTokenManager
Deprecated.
For removal in 7.0.0
getFileName() - Method in class net.sourceforge.pmd.RuleSet
 
getFilenameBase(String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
getFilenameExtension(String) - Static method in class net.sourceforge.pmd.util.IOUtil
Deprecated.
 
getFileNameWithoutExtension(String) - Static method in class net.sourceforge.pmd.util.FileUtil
Deprecated.
Helper method to get a filename without its extension
getFiles() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getFilesets() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getFilter() - Method in class net.sourceforge.pmd.util.filter.AbstractDelegateFilter
Deprecated.
 
getFilters() - Method in class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
getFingerprint() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getFirst() - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
getFirstChild() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
getFirstChild(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getFirstChildOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getFirstChildOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses the children to find the first instance of type childType.
getFirstDescendantOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getFirstDescendantOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses down the tree to find the first descendant instance of type descendantType without crossing find boundaries.
getFirstIndex() - Method in class net.sourceforge.pmd.lang.dfa.SequenceChecker
Deprecated.
 
getFirstMark() - Method in class net.sourceforge.pmd.cpd.Match
 
getFirstNode(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getFirstParentOfAnyType(Class<? extends T>...) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
getFirstParentOfAnyType(Class<? extends T>...) - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
This method causes an unchecked warning at call sites. PMD 7 will provide a way to do the same thing without the warning.
getFirstParentOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getFirstParentOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses up the tree to find the first parent instance of type parentType or one of its subclasses.
getFlow() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getFlow() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getFollowingAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get an iterator over all following nodes, depth-first.
getFollowingSiblingAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get an iterator over all following siblings.
getForcedVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
 
getForceLanguage() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getForceLanguageVersion() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the LanguageVersion specified by the force-language parameter.
getFormat() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getFormatters() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getFullDescription() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A description of the report.
getFullName() - Method in class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
getHelp() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
Provides the primary documentation for the report, useful when there is no online documentation.
getHelpUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A URI where the primary documentation for the report can be found.
getHighlightedNodesWhenSelecting(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.RelatedNodesSelector
Returns a list of nodes that should be highlighted when selecting the given node.
getHighValue() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getIcon(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
 
getIcon(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
Returns a constant describing an icon that the node should bear in the treeview and other relevant places.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
The stable, unique identifier of the rule, if any, to which this result is relevant.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
Value that distinguishes this location from all other locations within a single result object.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
The identifier for this message.
getId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A stable, opaque identifier for the report.
getIdentifier() - Method in class net.sourceforge.pmd.cpd.TokenEntry
 
getIgnoreFilePath() - Method in class net.sourceforge.pmd.PMDConfiguration
 
getIgnoreListPath() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getImage() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getImage() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getImage() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets the token's text.
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() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns a string made up of characters from the marked token beginning to the current buffer position.
GetImage() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
GetImage() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get token literal value.
getIncludePatterns() - Method in class net.sourceforge.pmd.RuleSet
getIndex() - Method in class net.sourceforge.pmd.cpd.TokenEntry
 
getIndex() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getIndex() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getIndex() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
The index within the run artifacts array of the artifact object associated with the artifact location.
getIndex(TreeNode) - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
getIndexInParent() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getIndexInParent() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns the index of this node in its parent's children.
getIndexOfChild(Object, Object) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
getInformationUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
The absolute URI at which information about this version of the tool component can be found.
getInputFilePath() - Method in class net.sourceforge.pmd.PMDConfiguration
 
getInputPaths() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getInputPaths() - Method in class net.sourceforge.pmd.PMDConfiguration
getInputStream() - Method in interface net.sourceforge.pmd.util.datasource.DataSource
Get an InputStream on the source file.
getInputStream() - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
 
getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
Convert the Reader into an InputStream.
getInputStream() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
 
getInputStream(ResourceLoader) - Method in class net.sourceforge.pmd.RuleSetReferenceId
Deprecated.
Try to load the RuleSet resource with the specified ResourceLoader.
getInputUri() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the input URI to process for source code objects.
getInstance() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Deprecated.
Use the static methods instead, will be made private
getInstance() - Static method in class net.sourceforge.pmd.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.
getInstance(MetricKey<N>, MetricOptions) - Static method in class net.sourceforge.pmd.lang.metrics.ParameterizedMetricKey
Deprecated.
Builds a parameterized metric key.
getInvocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
getKind() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
getKind() - Method in interface net.sourceforge.pmd.lang.ast.GenericToken
Gets a unique integer representing the kind of token this is.
getLabel() - Method in class net.sourceforge.pmd.cpd.Match
 
getLabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
 
getLabelsByChoice() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
getLabelStatementNodeClass() - Method in interface net.sourceforge.pmd.lang.DataFlowHandler
Deprecated.
 
getLanguage() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getLanguage() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getLanguage() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Returns the language that owns this version.
getLanguage() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getLanguage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getLanguage() - Method in interface net.sourceforge.pmd.Rule
Get the Language of this Rule.
getLanguage(String) - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Returns a language from its full name (eg "Java").
getLanguageFromString(String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getLanguageMetricsProvider() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getLanguageMetricsProvider() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Returns the metrics provider for this language version, or null if it has none.
getLanguages() - Static method in class net.sourceforge.pmd.lang.LanguageRegistry
Returns a collection of all the known languages.
getLanguages() - Method in class net.sourceforge.pmd.util.database.DBType
 
getLanguagesForFile(File) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
Get the Languages of a given source file.
getLanguagesForFile(String) - Method in class net.sourceforge.pmd.lang.LanguageVersionDiscoverer
Get the Languages of a given source file.
getLanguagesList() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getLanguageSpecificComputer() - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
getLanguageSpecificProjectMemoizer() - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade
Deprecated.
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.RuleContext
Deprecated.
Will be removed in PMD 7, as the nodes have access to their language version. In PMD 6, this is still the only way to access the language version within a rule, and cannot be replaced. The deprecation warning hints that the method should be replaced in PMD 7.
getLanguageVersionDiscoverer() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.
getLanguageVersionHandler() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Returns the LanguageVersionHandler, which provides access to version-specific services, like the parser.
getLanguageVersionOfFile(String) - Method in class net.sourceforge.pmd.PMDConfiguration
Get the LanguageVersion of the source file with given name.
getLast() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
getLast() - Method in class net.sourceforge.pmd.lang.dfa.Structure
Deprecated.
 
getLastChild(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getLastEvaluationResults() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
Retrieves the results of last evaluation.
getLastIndex() - Method in class net.sourceforge.pmd.lang.dfa.SequenceChecker
Deprecated.
 
getLastLine() - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
 
getLastLineColumn() - Method in class net.sourceforge.pmd.lang.ast.SourceCodePositioner
 
getLength() - Method in interface net.sourceforge.pmd.document.RegionByOffset
 
getLength() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
 
getLength() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
getLexerForSource(SourceCode) - Method in class net.sourceforge.pmd.cpd.AntlrTokenizer
Deprecated.
 
getLine() - Method in exception net.sourceforge.pmd.lang.antlr.AntlrTokenManager.ANTLRSyntaxError
Deprecated.
 
getLine() - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
getLine() - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
getLine() - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
getLine() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
 
getLine() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getLine() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getLine(int) - Method in class net.sourceforge.pmd.util.designer.CodeEditorTextPane
Deprecated.
 
getLine(int) - Method in interface net.sourceforge.pmd.util.designer.LineGetter
Deprecated.
 
getLineCount() - Method in class net.sourceforge.pmd.cpd.Mark
 
getLineCount() - Method in class net.sourceforge.pmd.cpd.Match
 
getLineCount(TokenEntry, Match) - Method in class net.sourceforge.pmd.cpd.Tokens
 
getLineNumber() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getLineNumber() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getListeners() - Method in class net.sourceforge.pmd.Report
Deprecated.
getLocalPart() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getLocalPart() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
getLocalPart() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getLocation() - Method in interface net.sourceforge.pmd.lang.symboltable.NameOccurrence
Gets the location where the usage occurred.
getLocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
The set of locations where the result was detected.
getLocations() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
A list of related locations to the error
getLowerLimit() - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
Deprecated.
 
getLowValue() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getMainAttribute(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
 
getMainAttribute(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
Returns the "main" attribute of the given node.
getMarkCount() - Method in class net.sourceforge.pmd.cpd.Match
 
getMarkdown() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
A Markdown message string.
getMarkdown() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
A Markdown message string or format string.
getMarkSet() - Method in class net.sourceforge.pmd.cpd.Match
 
getMatches() - Method in class net.sourceforge.pmd.cpd.CPD
 
getMatches() - Method in class net.sourceforge.pmd.cpd.CPDReport
 
getMatches() - Method in class net.sourceforge.pmd.cpd.MatchCollector
 
getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getMaximumLanguageVersion() - Method in interface net.sourceforge.pmd.Rule
Get the maximum LanguageVersion to which this Rule applies.
getMaxRuleViolations() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getMember() - Method in class net.sourceforge.pmd.dcd.graph.ConstructorNode
Deprecated.
 
getMember() - Method in class net.sourceforge.pmd.dcd.graph.FieldNode
Deprecated.
 
getMember() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getMember() - Method in class net.sourceforge.pmd.dcd.graph.MethodNode
Deprecated.
 
getMemberParameterTypes() - Method in class net.sourceforge.pmd.dcd.graph.ConstructorNode
Deprecated.
 
getMemberParameterTypes() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getMemberParameterTypes() - Method in class net.sourceforge.pmd.dcd.graph.MethodNode
Deprecated.
 
getMemo(ParameterizedMetricKey<N>) - Method in class net.sourceforge.pmd.lang.metrics.BasicMetricMemoizer
Deprecated.
 
getMemo(ParameterizedMetricKey<N>) - Method in interface net.sourceforge.pmd.lang.metrics.MetricMemoizer
Deprecated.
Fetch a memoized result for a metric and options.
getMessage() - Method in exception net.sourceforge.pmd.lang.ast.TokenMgrError
 
getMessage() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getMessage() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
A plain text message string or format string.
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
A message that describes the result.
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
A message component to detail the configuration error
getMessage() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
A message component to detail the runtime error
getMessage() - Method in interface net.sourceforge.pmd.Rule
Get the message to show when this Rule identifies a violation.
getMessage() - Method in class net.sourceforge.pmd.stat.DataPoint
Deprecated.
 
getMessageStrings() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A set of name/value pairs with arbitrary names.
getMethod(Class<?>, String, Class<?>...) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getMethodName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getMethodName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getMethodName() - Method in interface net.sourceforge.pmd.RuleViolation
Get the method name in which this violation was identified.
getMethodNodes() - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
getMethodParameterTypes() - Method in class net.sourceforge.pmd.dcd.asm.TypeSignatureVisitor
Deprecated.
 
getMethodReturnType() - Method in class net.sourceforge.pmd.dcd.asm.TypeSignatureVisitor
Deprecated.
 
getMethods() - Method in interface net.sourceforge.pmd.lang.dfa.DFAGraphRule
Deprecated.
 
getMethodSignature(String, Class<?>...) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getMetricName() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getMinimumLanguageVersion() - Method in interface net.sourceforge.pmd.Rule
Get the minimum LanguageVersion to which this Rule applies.
getMinimumPriority() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getMinimumPriority() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getMinimumPriority() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the minimum priority threshold when loading Rules from RuleSets.
getMinimumTileSize() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getMinimumTileSize() - Method in class net.sourceforge.pmd.cpd.MatchAlgorithm
 
getMsg() - Method in class net.sourceforge.pmd.Report.ProcessingError
 
getMultifileFacade() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getMultifileFacade() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getName() - Method in class net.sourceforge.pmd.ant.SourceLanguage
 
getName() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
 
getName() - Method in interface net.sourceforge.pmd.cpd.Language
 
getName() - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
getName() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getName() - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
 
getName() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getName() - Method in interface net.sourceforge.pmd.lang.dfa.DFAGraphMethod
Deprecated.
 
getName() - Method in interface net.sourceforge.pmd.lang.Language
Returns the full name of this Language.
getName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Returns the name of this language version.
getName() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getName() - Method in class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
getName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getName() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
 
getName() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration
Gets the name of the declaration, such as the variable name.
getName() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
Deprecated.
Returns the name of the property to be built.
getName() - Method in class net.sourceforge.pmd.properties.PropertyBuilder
Returns the name of the property to be built.
getName() - Method in interface net.sourceforge.pmd.properties.PropertySource
Gets the name of this property source.
getName() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
 
getName() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
The name of the tool component.
getName() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A report identifier that is understandable to an end user.
getName() - Method in interface net.sourceforge.pmd.renderers.Renderer
Get the name of the Renderer.
getName() - Method in interface net.sourceforge.pmd.Rule
Get the name of this Rule.
getName() - Method in enum net.sourceforge.pmd.RulePriority
Get the descriptive name of this priority.
getName() - Method in class net.sourceforge.pmd.RuleSet
 
getName() - Method in class net.sourceforge.pmd.util.database.SourceObject
 
getNameCode() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getNamePool() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getNamePool() - Static method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
 
getNamespacePrefix(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getNamespaceStringValue(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getNavigator() - Method in class net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler
Deprecated.
 
getNavigator() - Method in interface net.sourceforge.pmd.lang.XPathHandler
Deprecated.
Support for Jaxen will be removed come 7.0.0. This isn't used anymore
getNestedRules() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getNewMethodVisitor(PrintVisitor, MemberNode) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraphBuilder
Deprecated.
 
getNext() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
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.
getNextId() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.IdGenerator
Deprecated.
 
getNextMajorRelease() - Static method in class net.sourceforge.pmd.PMDVersion
Retrieves the next major release to be expected.
getNextNode(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getNextSibling() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
getNextSibling(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getNextToken() - Method in interface net.sourceforge.pmd.cpd.token.TokenFilter
Retrieves the next token to pass the filter
getNextToken() - Method in class net.sourceforge.pmd.lang.antlr.AntlrTokenManager
 
getNextToken() - Method in interface net.sourceforge.pmd.lang.TokenManager
 
getNiceFileName(boolean, String) - Method in interface net.sourceforge.pmd.util.datasource.DataSource
Return a nice version of the filename.
getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
 
getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ReaderDataSource
Return the dataSourceName via the DataSource Interface method.
getNiceFileName(boolean, String) - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
 
getNode() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getNode() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getNode() - Method in class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
getNode() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
 
getNode() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration
Gets the node which manifests the declaration.
getNode() - Method in class net.sourceforge.pmd.stat.DataPoint
Deprecated.
 
getNodeKind() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getNthParent(int) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getNthParent(int) - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns the n-th parent or null if there are less than n ancestors.
getNumberOfTokensPerFile() - Method in class net.sourceforge.pmd.cpd.CPDReport
 
getNumberOfViolations() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
getNumChildren() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getNumChildren() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns the number of children of this node.
getOffset() - Method in interface net.sourceforge.pmd.document.RegionByOffset
 
getOffset() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
 
getOffsetAfterEnding() - Method in interface net.sourceforge.pmd.document.RegionByOffset
 
getOffsetAfterEnding() - Method in class net.sourceforge.pmd.document.RegionByOffsetImp
 
getOperationMemoizer(QualifiedName) - Method in class net.sourceforge.pmd.lang.metrics.BasicProjectMemoizer
Deprecated.
 
getOperationMemoizer(QualifiedName) - Method in interface net.sourceforge.pmd.lang.metrics.ProjectMemoizer
Deprecated.
Gets the operation metric memoizer corresponding to the qualified name.
getOperator() - Method in class net.sourceforge.pmd.util.filter.AbstractCompoundFilter
Deprecated.
 
getOperator() - Method in class net.sourceforge.pmd.util.filter.AndFilter
Deprecated.
 
getOperator() - Method in class net.sourceforge.pmd.util.filter.OrFilter
Deprecated.
 
getOptions() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
Returns an immutable set of options.
getOriginalName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenDescription() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenExamples() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenExternalInfoUrl() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenLanguage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
Deprecated.
overriding the language of a rule is not supported.
getOverriddenMaximumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenMessage() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenMinimumLanguageVersion() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenName() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenPriority() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getOverriddenPropertiesByPropertyDescriptor() - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns a modifiable map of the property descriptors that don't use default values, to their overridden value.
getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getOverriddenPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getOverriddenPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns a modifiable list of the property descriptors that don't use default values.
getPackageName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getPackageName() - Method in class net.sourceforge.pmd.lang.dfa.report.PackageNode
Deprecated.
 
getPackageName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getPackageName() - Method in interface net.sourceforge.pmd.RuleViolation
Get the package name of the Class in which this violation was identified.
getParameter() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModelEvent
Deprecated.
 
getParameters() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getParameterTypes(String...) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
getParent() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getParent() - Method in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode
 
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.ast.xpath.Attribute
 
getParent() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getParent() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
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
getParent() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
getParentAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get a (single-member) iterator over this node's parent.
getParentNode(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getParents() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getParents() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getParentsOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getParentsOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Traverses up the tree to find all of the parent instances of type parentType or one of its subclasses.
getParser(ParserOptions) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Get the Parser.
getParserOptions() - Method in class net.sourceforge.pmd.lang.AbstractParser
Deprecated.
 
getParserOptions() - Method in interface net.sourceforge.pmd.lang.Parser
Deprecated.
Parser options should be a parameter to Parser.parse(String, Reader)
getParserOptions() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getParserOptions() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
Deprecated.
getParserOptions() - Method in interface net.sourceforge.pmd.Rule
Deprecated.
This was never implemented and will never be. PMD cannot parse files once per rule. Let this method assume its default by not overriding it.
getPathId() - Method in interface net.sourceforge.pmd.lang.document.TextFile
Returns an identifier for the path of this file.
getPhaseText(int) - Method in class net.sourceforge.pmd.cpd.GUI
 
getPhysicalLocation() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
Identifies the artifact and region.
getPrecedingAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get an iterator over all preceding nodes, depth-first.
getPrecedingSiblingAxisIterator(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
Get an iterator over all preceding siblings.
getPrefix() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getPreviousComment() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
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).
getPreviousSibling(Node) - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
getPrimitiveTypeFor(String) - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
Returns the type(class) for the name specified or null if not found.
getPriority() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getPriority() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getPriority() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
The pmd priority of the rule.
getPriority() - Method in interface net.sourceforge.pmd.Rule
Get the priority of this Rule.
getPriority() - Method in enum net.sourceforge.pmd.RulePriority
Get the priority value as a number.
getProcessingErrors() - Method in class net.sourceforge.pmd.Report
Returns an unmodifiable list of processing errors that have been recorded until now.
getProperties() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getProperties() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
Key/value pairs that provide additional information about the report.
getProperties() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
Key/value pairs that provide additional information about the address.
getProperties() - Method in class net.sourceforge.pmd.util.database.DBType
 
getPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getPropertiesByPropertyDescriptor() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getPropertiesByPropertyDescriptor() - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns an unmodifiable map of descriptors to property values for the current receiver.
getPropertiesSource() - Method in class net.sourceforge.pmd.util.database.DBType
 
getProperty(PropertyDescriptor<T>) - Method in class net.sourceforge.pmd.lang.ParserOptions
 
getProperty(PropertyDescriptor<T>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getProperty(PropertyDescriptor<T>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getProperty(PropertyDescriptor<T>) - Method in interface net.sourceforge.pmd.properties.PropertySource
Get the typed value for the given property.
getPropertyDescriptor(String) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getPropertyDescriptor(String) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getPropertyDescriptor(String) - Method in interface net.sourceforge.pmd.properties.PropertySource
Get the PropertyDescriptor for the given property name.
getPropertyDescriptors() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getPropertyDescriptors() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getPropertyDescriptors() - Method in interface net.sourceforge.pmd.properties.PropertySource
Get the descriptors of all defined properties.
getPropertyName() - Method in enum net.sourceforge.pmd.util.database.DBType.Property
 
getPropertySourceType() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getPropertySourceType() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
getPropertySourceType() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
 
getPseudoFileName() - Method in class net.sourceforge.pmd.util.database.SourceObject
Gets the data source as a pseudo file name (faux-file).
getQualifiedName() - Method in interface net.sourceforge.pmd.lang.ast.QualifiableNode
Deprecated.
Returns a qualified name for this node.
getQualifiedNameResolutionFacade(ClassLoader) - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getQualifiedNameResolutionFacade(ClassLoader) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.CodeLoader
 
getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.FileCodeLoader
 
getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.ReaderCodeLoader
 
getReader() - Method in class net.sourceforge.pmd.cpd.SourceCode.StringCodeLoader
 
getReader(String) - Method in class net.sourceforge.pmd.renderers.TextColorRenderer
 
getReason() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModelEvent
Deprecated.
 
getRegex() - Method in class net.sourceforge.pmd.util.filter.RegexStringFilter
Deprecated.
 
getRegion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
Specifies a portion of the artifact.
getRegionByLine() - Method in class net.sourceforge.pmd.document.DocumentOperation
 
getRegisteredRuleSets() - Method in class net.sourceforge.pmd.RuleSetFactory
getRelatedNodesSelector() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
 
getRelatedNodesSelector() - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
Returns an instance of RelatedNodesSelector, or null if it should be defaulted to using the old symbol table (ScopedNode).
getRenderer() - Method in class net.sourceforge.pmd.ant.Formatter
Deprecated.
getRenderer() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
Deprecated.
Internal API.
getRendererFromString(String, String) - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
Deprecated.
Internal API
getRendererName() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getRenderers() - Static method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getReport() - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Internal API, removed in PMD 7
getReporter() - Method in class net.sourceforge.pmd.lang.document.FileCollector
Returns the reporter for the file collection phase.
getReporter() - Method in class net.sourceforge.pmd.PmdAnalysis
 
getReportfile() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getReportFile() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the file to which the report should render.
getReportFormat() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the report format.
getReportProperties() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the Report properties.
getRepresentation(PropertyDescriptor<?>, Object) - Static method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
Internal: this has been moved in PMD 7.
getResourceBundleAsProperties(ResourceBundle) - Static method in class net.sourceforge.pmd.util.database.DBType
Convert resourceBundle to usable Properties.
getResourceStream(String) - Method in class net.sourceforge.pmd.util.database.ResourceLoader
 
getResults() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
The set of results contained in an SARIF log.
getRevision() - Method in class net.sourceforge.pmd.util.database.SourceObject
 
getRoot() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getRoot() - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
getRootNode() - Method in class net.sourceforge.pmd.lang.dfa.report.ReportTree
Deprecated.
 
getRootNode() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
 
getRule() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getRule() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getRule() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getRule() - Method in interface net.sourceforge.pmd.RuleViolation
Get the Rule which identified this violation.
getRuleByName(String) - Method in class net.sourceforge.pmd.RuleSet
Returns the first Rule found with the given name (case-sensitive).
getRuleByName(String) - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
Returns the first Rule found with the given name.
getRuleChainVisitorClass() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getRuleChainVisitorClass() - Method in interface net.sourceforge.pmd.lang.Language
Deprecated.
Will be removed in PMD 7, avoid using this
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.xpath.AbstractXPathRuleQuery
Deprecated.
 
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.xpath.JaxenXPathRuleQuery
Deprecated.
 
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
 
getRuleChainVisits() - Method in interface net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery
Deprecated.
Indicates which AST Nodes (if any) should be used with the RuleChain.
getRuleChainVisits() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
 
getRuleChainVisits() - Method in interface net.sourceforge.pmd.Rule
Gets the collection of AST node names visited by the Rule on the RuleChain.
getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getRuleClass() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getRuleClass() - Method in interface net.sourceforge.pmd.Rule
Get the implementation class of this Rule.
getRuleForClass(String, String, String) - Method in class net.sourceforge.pmd.cache.CachedRuleMapper
Deprecated.
Finds a rule instance for the given rule class name, name and target language
getRuleId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
The stable, unique identifier of the rule, if any, to which this result is relevant.
getRuleIndex() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
The index link the rule, if any, to which this result is relevant.
getRuleName() - Method in class net.sourceforge.pmd.RuleSetReferenceId
Deprecated.
Get the Rule name.
getRules() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
getRules() - Method in class net.sourceforge.pmd.RuleSet
Returns the actual Collection of rules in this ruleset
getRuleset() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
The name of the rule set.
getRulesetFactory(PMDConfiguration, ResourceLoader) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
getRuleSetFileName() - Method in class net.sourceforge.pmd.RuleSetReference
Deprecated.
 
getRuleSetFileName() - Method in class net.sourceforge.pmd.RuleSetReferenceId
Deprecated.
Get the RuleSet file name.
getRulesetFiles() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getRuleSetName() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getRuleSetName() - Method in interface net.sourceforge.pmd.Rule
Get the name of the RuleSet containing this Rule.
getRuleSetPaths() - Method in class net.sourceforge.pmd.PMDConfiguration
Returns the list of ruleset URIs.
getRuleSetReference() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
getRulesetRefs() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getRulesets() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
getRulesets() - Method in class net.sourceforge.pmd.PmdAnalysis
 
getRuleSets() - Method in class net.sourceforge.pmd.PMDConfiguration
getRuleSets(String, RuleSetFactory) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
Internal API
getRuleSetsIterator() - Method in class net.sourceforge.pmd.RuleSets
Deprecated.
 
getRuleSetsWithBenchmark(String, RuleSetFactory) - Static method in class net.sourceforge.pmd.RulesetsFactoryUtils
Deprecated.
Is internal API
getRuleViolation() - Method in class net.sourceforge.pmd.lang.dfa.report.ViolationNode
Deprecated.
 
getRuleViolation() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
 
getRuleViolationFactory() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Get the RuleViolationFactory.
getRuns() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
The set of runs contained in this log file.
getSchema() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
The URI of the JSON schema corresponding to the version.
getSchema() - Method in class net.sourceforge.pmd.util.database.SourceObject
 
getSchemasList() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getScope() - Method in class net.sourceforge.pmd.lang.symboltable.AbstractNameDeclaration
 
getScope() - Method in interface net.sourceforge.pmd.lang.symboltable.NameDeclaration
Gets the scope in which this name has been declared.
getScope() - Method in interface net.sourceforge.pmd.lang.symboltable.ScopedNode
 
getScore() - Method in class net.sourceforge.pmd.stat.DataPoint
Deprecated.
 
getSecondMark() - Method in class net.sourceforge.pmd.cpd.Match
 
getSequenceRepresentation(List<?>) - Static method in class net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery
Deprecated.
 
getSeverity() - Method in exception net.sourceforge.pmd.PMDException
Deprecated.
 
getShortDescription() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
A concise description of the report.
getShortName() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getShortName() - Method in interface net.sourceforge.pmd.lang.Language
Returns the short name of this language.
getShortName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Get the short name of this LanguageVersion.
getSiblingPosition() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getSiblingPosition() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getSignature() - Method in interface net.sourceforge.pmd.lang.ast.SignedNode
Gets the signature of this node.
getSimpleNode() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
retrieves the underlying node
getSince() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
getSince() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
getSince() - Method in interface net.sourceforge.pmd.Rule
Get the version of PMD in which this Rule was added.
getSkipBlocksPattern() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getSlice(int, int) - Method in class net.sourceforge.pmd.cpd.SourceCode
Loads a range of lines.
getSortKey() - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.AdditionalInfo
Returns the string used to sort the additional info.
getSource() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModelEvent
Deprecated.
 
getSourceCode() - Method in class net.sourceforge.pmd.util.viewer.gui.SourceCodePanel
Deprecated.
retrieves the string representation of the source code
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.
getSourceCodeFile() - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Internal API, removed in PMD 7
getSourceCodeFilename() - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Internal API, removed in PMD 7
getSourceCodeNamesList() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getSourceCodeProcessor() - Method in class net.sourceforge.pmd.PMD
Deprecated.
Source code processor is internal
getSourceCodeReturnType() - Method in class net.sourceforge.pmd.util.database.DBType
 
getSourceCodeSlice() - Method in class net.sourceforge.pmd.cpd.Mark
Newlines are normalized to \n.
getSourceCodeSlice() - Method in class net.sourceforge.pmd.cpd.Match
Newlines are normalized to \n.
getSourceCodeType() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getSourceCodeTypes() - Method in class net.sourceforge.pmd.util.database.DBType
 
getSourceCodeTypesList() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getSourceDir() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
getSourceEncoding() - Method in class net.sourceforge.pmd.AbstractConfiguration
Get the character encoding of source files.
getSourceLanguage() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getSourceObjectList() - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
Return all source code objects associated with any associated DBURI.
getSourceObjectList(List<String>, List<String>, List<String>, List<String>) - Method in class net.sourceforge.pmd.util.database.DBMSMetadata
Return all source code objects associated with the specified languages, schemas, source code types and source code names.
getSourcePaths() - Method in class net.sourceforge.pmd.cpd.CPD
List names/paths of each source to be processed.
getSources() - Method in class net.sourceforge.pmd.cpd.CPD
Get each Source to be processed.
getStandardDeviation() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getStandardRuleSets() - Method in class net.sourceforge.pmd.RuleSetLoader
Returns an Iterator of RuleSet objects loaded from descriptions from the "categories.properties" resource for each language.
getStartColumn() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
The column number of the first character in the region.
getStartLine() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
The line number of the first character in the region.
getStringId() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
Gets the value of the type attribute represented by this constant.
getStringValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
 
getStringValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getStringValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getStringValueCS() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getStringValueCS() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
getStringValueCS() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getSubnamePrefix() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getSubprotocol() - Method in class net.sourceforge.pmd.util.database.DBURI
 
GetSuffix(int) - Method in interface net.sourceforge.pmd.lang.ast.CharStream
Deprecated.
Returns an array of characters that make up the suffix of length 'len' for the currently matched token.
GetSuffix(int) - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
GetSuffix(int) - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
Get the suffix.
getSuffixFromType() - Method in class net.sourceforge.pmd.util.database.SourceObject
Map the type to a file suffix associated with a Language
getSummary() - Method in class net.sourceforge.pmd.Report
Deprecated.
This is too specific, only used by one renderer.
getSuppressedRuleViolations() - Method in class net.sourceforge.pmd.Report
Deprecated.
Use Report.getSuppressedViolations() (be aware, that that method returns an unmodifiable list)
getSuppressedViolations() - Method in class net.sourceforge.pmd.Report
Returns an unmodifiable list of violations that were suppressed.
getSuppressMap() - Method in class net.sourceforge.pmd.lang.ast.AbstractTokenManager
 
getSuppressMap() - Method in interface net.sourceforge.pmd.lang.Parser
Deprecated.
With 7.0.0, this method will be removed. To support suppressing with suppress markers, this method is still needed in PMD 6.
getSuppressmarker() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getSuppressMarker() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getSuppressMarker() - Method in class net.sourceforge.pmd.lang.ParserOptions
 
getSuppressMarker() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the suppress marker.
getSymbolFacade() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getSymbolFacade() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getSymbolFacade(ClassLoader) - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getSymbolFacade(ClassLoader) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getSystemId() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getTabSize(int) - Method in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
getTabSize(int) - Method in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
getTags() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
A set of distinct strings that provide additional information.
getTerseName() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
 
getTerseName() - Method in interface net.sourceforge.pmd.cpd.Language
 
getTerseName() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getTerseName() - Method in interface net.sourceforge.pmd.lang.Language
Returns the terse name of this language.
getTerseName() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Get the terse name of this LanguageVersion.
getText() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
A plain text message string.
getText() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
A plain text message string or format string.
getTextStringValue(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
getThreads() - Method in class net.sourceforge.pmd.ant.PMDTask
 
getThreads() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getThreads() - Method in class net.sourceforge.pmd.PMDConfiguration
Get the number of threads to use when processing Rules.
getTime() - Method in class net.sourceforge.pmd.Report.ReadableDuration
Deprecated.
Gets a human readable representation of the duration, such as "1h 3m 5s".
getToken() - Method in class net.sourceforge.pmd.cpd.Mark
 
getTokenCount() - Method in class net.sourceforge.pmd.cpd.Match
 
getTokenFilter(AntlrTokenManager) - Method in class net.sourceforge.pmd.cpd.AntlrTokenizer
Deprecated.
 
getTokenizer() - Method in class net.sourceforge.pmd.cpd.AbstractLanguage
 
getTokenizer() - Method in interface net.sourceforge.pmd.cpd.Language
 
getTokenManager(String, Reader) - Method in class net.sourceforge.pmd.lang.AbstractParser
Deprecated.
 
getTokenManager(String, Reader) - Method in interface net.sourceforge.pmd.lang.Parser
Deprecated.
For removal in 7.0.0
getTokens() - Method in class net.sourceforge.pmd.cpd.Tokens
 
getTokenSrcID() - Method in class net.sourceforge.pmd.cpd.TokenEntry
 
getTool() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
Information about the tool or tool pipeline that generated the results in this run.
getToolConfigurationNotifications() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
getToolExecutionNotifications() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
getTotal() - Method in class net.sourceforge.pmd.stat.Metric
Deprecated.
 
getType() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
Deprecated.
getType() - Method in class net.sourceforge.pmd.dcd.graph.ClassNode
Deprecated.
 
getType() - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
Returns the most general type that the value may be.
getType() - Method in class net.sourceforge.pmd.lang.dfa.StackObject
Deprecated.
 
getType() - Method in class net.sourceforge.pmd.util.database.SourceObject
 
getTypeAnnotation() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getTypedValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getTypedValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
getTypedValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getTypeFor(String) - Static method in class net.sourceforge.pmd.util.ClassUtil
Deprecated.
Attempt to determine the actual class given the short name.
getTypeResolutionFacade(ClassLoader) - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getTypeResolutionFacade(ClassLoader) - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Deprecated.
see note in the class description
getUnderlyingNode() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getUnderlyingNode() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
getUnderlyingNode() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
getUnlabeledMeasurements(TimedOperationCategory) - Method in class net.sourceforge.pmd.benchmark.TimingReport
 
getUnparsedEntity(String) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
getUnparsedEntityNames() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
getUpperLimit() - Method in class net.sourceforge.pmd.properties.modules.NumericPropertyModule
Deprecated.
 
getUri() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getUri() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
A string containing a valid relative or absolute URI.
getUri() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getURI() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
getURI() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
getUriBaseId() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.
getURIDataSources(String) - Static method in class net.sourceforge.pmd.PMD
Deprecated.
Will be hidden as part of the parsing of PMD.getApplicableFiles(PMDConfiguration, Set)
getURL() - Method in class net.sourceforge.pmd.util.database.DBURI
 
getUsageGraph() - Method in class net.sourceforge.pmd.dcd.graph.UsageGraphBuilder
Deprecated.
 
getUserData() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
getUserData() - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
getUserMap() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getUserMap() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns a data map used to store additional information on this node.
getUserMessage() - Method in class net.sourceforge.pmd.Report.SuppressedViolation
 
getUsers() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getUses() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
getValue() - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
 
getValueParser() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
getValues() - Method in class net.sourceforge.pmd.cpd.CPDTask.FormatAttribute
 
getValueType() - Method in class net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
Deprecated.
 
getVariableAccess() - Method in class net.sourceforge.pmd.lang.dfa.AbstractDataFlowNode
Deprecated.
 
getVariableAccess() - Method in interface net.sourceforge.pmd.lang.dfa.DataFlowNode
Deprecated.
 
getVariableName() - Method in class net.sourceforge.pmd.cache.CachedRuleViolation
Deprecated.
 
getVariableName() - Method in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
getVariableName() - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getVariableName() - Method in interface net.sourceforge.pmd.RuleViolation
Get the variable name on which this violation was identified.
getVariableValue(String) - Method in class net.sourceforge.pmd.lang.rule.ParametricRuleViolation
Deprecated.
 
getVersion() - Method in class net.sourceforge.pmd.ant.SourceLanguage
 
getVersion() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
getVersion() - Method in class net.sourceforge.pmd.lang.LanguageVersion
Returns the version string.
getVersion() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
Returns the version for this rule.
getVersion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
The tool component version, in whatever format the component natively provides.
getVersion() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
The SARIF format version of this log file.
getVersion(String) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getVersion(String) - Method in interface net.sourceforge.pmd.lang.Language
Returns the language version with the given version string.
getVersions() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
getVersions() - Method in interface net.sourceforge.pmd.lang.Language
Returns an ordered list of supported versions for this language.
getViolationParameters(DataPoint) - Method in interface net.sourceforge.pmd.lang.rule.stat.StatisticalRule
Deprecated.
 
getViolations() - Method in class net.sourceforge.pmd.cache.AnalysisResult
Deprecated.
 
getViolations() - Method in class net.sourceforge.pmd.Report
Returns an unmodifiable list of violations that have been recorded until now.
getViolationTree() - Method in class net.sourceforge.pmd.Report
Deprecated.
The ReportTree is deprecated
getWallClockMillis() - Method in class net.sourceforge.pmd.benchmark.TimingReport
 
getWriter() - Method in class net.sourceforge.pmd.renderers.AbstractRenderer
 
getWriter() - Method in interface net.sourceforge.pmd.renderers.Renderer
Get the Writer for the Renderer.
getXmlName() - Method in enum net.sourceforge.pmd.lang.rule.xpath.XPathVersion
Returns the string used to represent the version in the XML.
getXPathAttributesIterator() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
getXPathAttributesIterator() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns an iterator enumerating all the attributes that are available from XPath for this node.
getXPathExpression() - Method in class net.sourceforge.pmd.lang.rule.XPathRule
Returns the XPath expression that implements this rule.
getXPathExpression() - Method in class net.sourceforge.pmd.util.viewer.gui.XPathPanel
Deprecated.
 
getXPathHandler() - Method in class net.sourceforge.pmd.lang.AbstractLanguageVersionHandler
 
getXPathHandler() - Method in interface net.sourceforge.pmd.lang.LanguageVersionHandler
Get the XPathHandler.
getXPathNodeName() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Gets the name of the node that is used to match it with XPath queries.
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
 
go() - Method in class net.sourceforge.pmd.cpd.CPD
 
GridBagHelper - Class in net.sourceforge.pmd.cpd
Deprecated.
Is internal API
GridBagHelper(Container, double[]) - Constructor for class net.sourceforge.pmd.cpd.GridBagHelper
Deprecated.
 
GROUPING - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
 
GUI - Class in net.sourceforge.pmd.cpd
 
GUI() - Constructor for class net.sourceforge.pmd.cpd.GUI
 

H

handleAttributeFetchException(Attribute, Exception) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
Handle an exception that occurred while fetching the value of an attribute.
hasBom() - Method in class net.sourceforge.pmd.util.IOUtil.BomAwareInputStream
Deprecated.
 
hasChildNodes() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
hasChildNodes() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode
Deprecated.
 
hasChildNodes() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
hasCompiledTree() - Method in class net.sourceforge.pmd.util.viewer.model.ViewerModel
Deprecated.
Determines whether the model has a compiled tree at it's disposal.
hasConfigErrors() - Method in class net.sourceforge.pmd.Report
Deprecated.
hasDecendantOfAnyType(Class<?>...) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
hasDescendantMatchingXPath(String) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
hasDescendantMatchingXPath(String) - Method in interface net.sourceforge.pmd.lang.ast.Node
Deprecated.
This is very inefficient and should not be used in new code. PMD 7.0.0 will remove support for this method.
hasDescendantOfAnyType(Class<?>...) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
Deprecated.
This is implemented inefficiently, with PMD 7 Node streams will provide a better alternative. We cannot ensure binary compatibility because the methods on 7.0 expect at least one class type, by requiring one Class parameter before the varargs (Effective Java 2nd ed., Item 42).
hasDescendantOfType(Class<T>) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
hasDescendantOfType(Class<T>) - Method in interface net.sourceforge.pmd.lang.ast.Node
Finds if this node contains a descendant of the given type without crossing find boundaries.
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
hasDescriptor(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
hasDescriptor(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns whether the specified property is defined on this property source, in which case it can be set or retrieved with PropertySource.getProperty(PropertyDescriptor) and PropertySource.setProperty(PropertyDescriptor, Object).
hasErrors() - Method in class net.sourceforge.pmd.Report
Deprecated.
hasExtension(String) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
hasExtension(String) - Method in interface net.sourceforge.pmd.lang.Language
Returns whether this language handles the given file extension.
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.dcd.graph.ClassNode
Deprecated.
 
hashCode() - Method in class net.sourceforge.pmd.dcd.graph.MemberNode
Deprecated.
 
hashCode() - Method in class net.sourceforge.pmd.lang.ast.xpath.Attribute
 
hashCode() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
hashCode() - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
hashCode() - Method in class net.sourceforge.pmd.lang.metrics.AbstractMetric
 
hashCode() - Method in class net.sourceforge.pmd.lang.metrics.MetricOptions
 
hashCode() - Method in class net.sourceforge.pmd.lang.metrics.ParameterizedMetricKey
Deprecated.
 
hashCode() - Method in class net.sourceforge.pmd.lang.ParserOptions
 
hashCode() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
hashCode() - Method in class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification
 
hashCode() - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification
 
hashCode() - Method in class net.sourceforge.pmd.RuleSet
 
hashCode() - Method in class net.sourceforge.pmd.util.database.DBType
 
hashCode() - Method in class net.sourceforge.pmd.util.datasource.FileDataSource
 
hashCode() - Method in class net.sourceforge.pmd.util.datasource.ZipDataSource
 
hasImageEqualTo(String) - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
hasImageEqualTo(String) - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns true if this node's image is equal to the given string.
hasMetrics() - Method in class net.sourceforge.pmd.Report
Deprecated.
hasNext() - Method in class net.sourceforge.pmd.internal.util.IteratorUtil.AbstractIterator
 
hasNext() - Method in class net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator
Deprecated.
 
hasNext() - Method in class net.sourceforge.pmd.lang.ast.xpath.NodeIterator
Deprecated.
 
hasNext() - Method in class net.sourceforge.pmd.util.CompoundIterator
Deprecated.
 
hasNext() - Method in class net.sourceforge.pmd.util.EmptyIterator
Deprecated.
 
hasOverriddenAttributes() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
Checks whether this rule reference explicitly overrides any of the possible attributes of the referenced rule.
hasOverriddenProperty(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
hasVersion(String) - Method in class net.sourceforge.pmd.lang.BaseLanguageModule
 
hasVersion(String) - Method in interface net.sourceforge.pmd.lang.Language
Returns true if a language version with the given version string is registered.
help(SarifLog.MultiformatMessage) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
Provides the primary documentation for the report, useful when there is no online documentation.
helpUri(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
A URI where the primary documentation for the report can be found.
HIGH - net.sourceforge.pmd.RulePriority
High: Change absolutely required.
HIGHEST - net.sourceforge.pmd.lang.metrics.ResultOption
Compute the highest value among all operations.
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.AbstractNode
Deprecated.
Use AbstractNode.jjtGetId() if you are a jjtree node.
id - Variable in class net.sourceforge.pmd.lang.ast.xpath.saxon.AttributeNode
Deprecated.
 
id - Variable in class net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode
Deprecated.
 
id - Variable in class net.sourceforge.pmd.renderers.ColumnDescriptor
Deprecated.
 
id() - Method in interface net.sourceforge.pmd.util.treeexport.TreeRendererDescriptor
Returns the ID of this renderer, used to select it.
id(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location.LocationBuilder
Value that distinguishes this location from all other locations within a single result object.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule.AssociatedRuleBuilder
The stable, unique identifier of the rule, if any, to which this result is relevant.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message.MessageBuilder
The identifier for this message.
id(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
A stable, opaque identifier for the report.
IDEAJRenderer - Class in net.sourceforge.pmd.renderers
Renderer for IntelliJ IDEA integration.
IDEAJRenderer() - Constructor for class net.sourceforge.pmd.renderers.IDEAJRenderer
 
IdGenerator - Class in net.sourceforge.pmd.lang.ast.xpath.saxon
Deprecated.
IdGenerator() - Constructor for class net.sourceforge.pmd.lang.ast.xpath.saxon.IdGenerator
Deprecated.
 
IF_EXPR - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
IF_LAST_STATEMENT - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
IF_LAST_STATEMENT_WITHOUT_ELSE - net.sourceforge.pmd.lang.dfa.NodeType
Deprecated.
 
ignorableCharacter - Variable in class net.sourceforge.pmd.cpd.AbstractTokenizer
Deprecated.
 
ignorableStmt - Variable in class net.sourceforge.pmd.cpd.AbstractTokenizer
Deprecated.
 
IGNORE_ANNOTATIONS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
 
IGNORE_IDENTIFIERS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
 
IGNORE_LITERALS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
 
IGNORE_USINGS - Static variable in interface net.sourceforge.pmd.cpd.Tokenizer
Ignore using directives in C#.
ignoreCase - Variable in class net.sourceforge.pmd.util.filter.FileExtensionFilter
Deprecated.
 
ignoredProperties() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
ignoredProperties() - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
Deprecated.
ignoredProperties() - Method in interface net.sourceforge.pmd.properties.PropertySource
Deprecated.
Has no real utility, will be removed by 7.0.0
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
 
ImmutableLanguage - Interface in net.sourceforge.pmd.lang.rule
Deprecated.
No rule supports a change to their language. This will be made the default behaviour with PMD 7.0.0.
ImportWrapper - Class in net.sourceforge.pmd.lang.rule
Deprecated.
This class is only useful for Java rules and should not have been added to pmd-core. It will be removed with PMD 7.
ImportWrapper(String, String) - Constructor for class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
ImportWrapper(String, String, Node) - Constructor for class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
ImportWrapper(String, String, Node, boolean) - Constructor for class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
ImportWrapper(String, String, Node, Class<?>, boolean) - Constructor for class net.sourceforge.pmd.lang.rule.ImportWrapper
Deprecated.
 
inBuf - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
inBuf - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
includeDeprecatedRuleReferences(boolean) - Method in class net.sourceforge.pmd.RuleSetLoader
Follow deprecated rule references.
indentWith(String) - Method in class net.sourceforge.pmd.util.treeexport.XmlTreeRenderer.XmlRenderingConfig
Sets the string that should be used to indent children elements.
index - Variable in enum net.sourceforge.pmd.benchmark.Benchmark
Deprecated.
 
index(Integer) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation.ArtifactLocationBuilder
The index within the run artifacts array of the artifact object associated with the artifact location.
index(String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraphBuilder
Deprecated.
 
indexNode(Node) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
Index a single node for visitation by rules.
indexNodes(List<Node>, RuleContext) - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
Index all nodes for visitation by rules.
info(String, Object...) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
 
INFO - net.sourceforge.pmd.util.log.MessageReporter.Level
Deprecated.
 
informationUri(String) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component.ComponentBuilder
The absolute URI at which information about this version of the tool component can be found.
init() - Method in class net.sourceforge.pmd.dcd.asm.TypeSignatureVisitor
Deprecated.
 
INIT - Static variable in interface net.sourceforge.pmd.cpd.CPDListener
 
INIT - Static variable in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
initialize() - Method in class net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler
Deprecated.
 
initialize() - Method in class net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler
Deprecated.
 
initialize() - Method in class net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor
Deprecated.
Initialize the RuleChainVisitor to be ready to perform visitations.
initialize() - Static method in class net.sourceforge.pmd.lang.xpath.Initializer
Deprecated.
Perform all initialization.
initialize() - Method in interface net.sourceforge.pmd.lang.XPathHandler
Deprecated.
Initialize.
initialize(IndependentContext) - Method in class net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler
Deprecated.
 
initialize(IndependentContext) - Method in class net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler
Deprecated.
 
initialize(IndependentContext) - Static method in class net.sourceforge.pmd.lang.xpath.Initializer
Deprecated.
Perform all initialization.
initialize(IndependentContext) - Method in interface net.sourceforge.pmd.lang.XPathHandler
Deprecated.
Initialize.
initialize(IndependentContext, Language, Class<?>) - Method in class net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler
Deprecated.
 
initialize(RuleSets) - Method in class net.sourceforge.pmd.cache.CachedRuleMapper
Deprecated.
Initialize the mapper with the given rulesets.
Initializer - Class in net.sourceforge.pmd.lang.xpath
Deprecated.
Is internal API
initThread() - Static method in class net.sourceforge.pmd.benchmark.TimeTracker
Initialize a thread, starting to track it's own time.
inputPathPrefixes - Variable in class net.sourceforge.pmd.renderers.AbstractRenderer
 
inputStream - Variable in class net.sourceforge.pmd.lang.ast.JavaCharStream
Deprecated.
 
inputStream - Variable in class net.sourceforge.pmd.lang.ast.SimpleCharStream
Deprecated.
 
inRange(N, N) - Static method in class net.sourceforge.pmd.properties.constraints.NumericConstraints
Requires the number to be inside a range.
insert(int, int, String) - Method in interface net.sourceforge.pmd.document.Document
Insert a text at a line at the position/column specified.
insert(int, int, String) - Method in class net.sourceforge.pmd.document.DocumentFile
 
InsertDocumentOperation - Class in net.sourceforge.pmd.document
Represents an insert operation in a Document.
InsertDocumentOperation(int, int, String) - Constructor for class net.sourceforge.pmd.document.InsertDocumentOperation
 
instance() - Static method in class net.sourceforge.pmd.util.EmptyIterator
Deprecated.
 
INSTANCE - Static variable in class net.sourceforge.pmd.dcd.graph.ClassNodeComparator
Deprecated.
 
INSTANCE - Static variable in class net.sourceforge.pmd.dcd.graph.MemberNodeComparator
Deprecated.
 
INSTANCE - Static variable in class net.sourceforge.pmd.RuleViolationComparator
Deprecated.
 
INSTANCE - Static variable in class net.sourceforge.pmd.util.EmptyIterator
Deprecated.
 
INSTANCE - Static variable in class net.sourceforge.pmd.util.filter.DirectoryFilter
Deprecated.
 
INTEGER - net.sourceforge.pmd.properties.PropertyTypeId
 
INTEGER_LIST - net.sourceforge.pmd.properties.PropertyTypeId
 
IntegerMultiProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<List<Integer>> instead. A builder is available from PropertyFactory.intListProperty(String). This class will be removed in 7.0.0.
IntegerMultiProperty(String, String, Integer, Integer, Integer[], float) - Constructor for class net.sourceforge.pmd.properties.IntegerMultiProperty
IntegerMultiProperty(String, String, Integer, Integer, List<Integer>, float) - Constructor for class net.sourceforge.pmd.properties.IntegerMultiProperty
IntegerMultiProperty.IntegerMultiPBuilder - Class in net.sourceforge.pmd.properties
IntegerProperty - Class in net.sourceforge.pmd.properties
Deprecated.
Use a PropertyDescriptor<Integer> instead. A builder is available from PropertyFactory.intProperty(String). This class will be removed in 7.0.0.
IntegerProperty(String, String, Integer, Integer, Integer, float) - Constructor for class net.sourceforge.pmd.properties.IntegerProperty
IntegerProperty.IntegerPBuilder - Class in net.sourceforge.pmd.properties
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.
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.
INVALID_LEXICAL_STATE - Static variable in exception net.sourceforge.pmd.lang.ast.TokenMgrError
Deprecated.
invertedMapFrom(Map<K, V>) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Returns a map based on the source but with the key & values swapped.
invocations(List<SarifLog.Invocation>) - Method in class net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run.RunBuilder
The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
IOUtil - Class in net.sourceforge.pmd.util
Deprecated.
Is internal API
IOUtil.BomAwareInputStream - Class in net.sourceforge.pmd.util
Deprecated.
Input stream that skips an optional byte order mark at the beginning of the stream.
isAllRules() - Method in class net.sourceforge.pmd.RuleSetReference
Deprecated.
 
isAllRules() - Method in class net.sourceforge.pmd.RuleSetReferenceId
Deprecated.
Is this a reference to all Rules in a RuleSet, or a single Rule?
isAnyOf(String, String...) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Returns whether the non-null text arg matches any of the test values.
isAttribute(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isAttributeAccessor(Method) - Method in class net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator
Deprecated.
Returns whether the given method is an attribute accessor, in which case a corresponding Attribute will be added to the iterator.
isBenchmark() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
isBenchmark() - Method in class net.sourceforge.pmd.PMDConfiguration
Return the benchmark indicator.
isBranch() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
isClass() - Method in interface net.sourceforge.pmd.lang.ast.QualifiedName
Deprecated.
Returns true if the resource addressed by this qualified name is a class.
isClass(String) - Method in class net.sourceforge.pmd.dcd.graph.UsageGraph
Deprecated.
 
isCollectionType(Class<?>, boolean) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Return whether we can identify the typeName as a java.util collection class or interface as specified.
isCollectionType(String, boolean) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Return whether we can identify the typeName as a java.util collection class or interface as specified.
isComment(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isDebug() - Method in class net.sourceforge.pmd.AbstractConfiguration
Return the debug indicator.
isDebug() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
isDebug() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isDefault() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
isDefinedExternally - Variable in class net.sourceforge.pmd.properties.PropertyBuilder
 
isDefinedExternally() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
May be removed with 7.0.0
isDefinedInXML - Variable in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
Deprecated.
 
isDefinition() - Method in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
isDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
isDeprecated() - Method in interface net.sourceforge.pmd.Rule
Gets whether this Rule is deprecated.
isDfa() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
isDfa() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
isDfa() - Method in interface net.sourceforge.pmd.Rule
Deprecated.
Optional AST processing stages will be reified in 7.0.0 to factorise common logic. This method and the similar methods will be removed.
isDoBranchNode() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
isDocument(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isElement(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isEmpty() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
isEmpty() - Method in class net.sourceforge.pmd.Report
isEmpty(Object[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Returns whether the items array is null or has zero length.
isEmpty(String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
StringUtils.isBlank(CharSequence)
isEndNode() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
isError() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
Returns true if parsing failed.
isExpandedByDefaultInTree(Node) - Method in class net.sourceforge.pmd.util.designerbindings.DesignerBindings.DefaultDesignerBindings
 
isExpandedByDefaultInTree(Node) - Method in interface net.sourceforge.pmd.util.designerbindings.DesignerBindings
Returns true if the children of this node should be displayed in the treeview by default.
isExternal() - Method in class net.sourceforge.pmd.RuleSetReferenceId
Deprecated.
Is this an external RuleSet reference?
isFailOnError() - Method in class net.sourceforge.pmd.ant.PMDTask
 
isFailOnRuleViolation() - Method in class net.sourceforge.pmd.ant.PMDTask
 
isFailOnViolation() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
isFailOnViolation() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isFailOnViolation() - Method in class net.sourceforge.pmd.PMDConfiguration
Whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
isFindBoundary() - Method in class net.sourceforge.pmd.lang.ast.AbstractNode
 
isFindBoundary() - Method in interface net.sourceforge.pmd.lang.ast.Node
Returns true if this node is considered a boundary by traversal methods.
isFirstDoStatement() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.CurrentPath
Deprecated.
 
isForceLanguageVersion() - Method in class net.sourceforge.pmd.PMDConfiguration
Is the force-language parameter set to anything?
isHelp() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
isHelp() - Method in class net.sourceforge.pmd.cli.PmdParametersParseResult
Returns whether parsing just requested the --help text.
isHelp() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isHidden() - Method in class net.sourceforge.pmd.cpd.token.AntlrToken
 
isId() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
isIdref() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
isIgnoreAnnotations() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isIgnoreClassAnonymous() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreConstructorAllPrivate() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreConstructorSinglePrivateNoArg() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreConstructorStaticInitializer() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreExceptions() - Method in class net.sourceforge.pmd.RuleContext
Deprecated.
Internal API, removed in PMD 7
isIgnoreFieldInlinable() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreIdentifiers() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isIgnoreIncrementalAnalysis() - Method in class net.sourceforge.pmd.cli.PMDParameters
Deprecated.
 
isIgnoreIncrementalAnalysis() - Method in class net.sourceforge.pmd.PMDConfiguration
Returns whether incremental analysis was explicitly disabled by the user or not.
isIgnoreLiterals() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isIgnoreLiteralSequences() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isIgnoreMethodAllOverride() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreMethodJavaLangObjectOverride() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreMethodMain() - Method in class net.sourceforge.pmd.dcd.UsageNodeVisitor.Options
Deprecated.
 
isIgnoreUsings() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isInstanceInitializer() - Method in class net.sourceforge.pmd.dcd.graph.ConstructorNode
Deprecated.
 
isJavaBinaryName(CharSequence) - Static method in class net.sourceforge.pmd.internal.util.AssertionUtil
 
isLeaf() - Method in class net.sourceforge.pmd.lang.dfa.report.AbstractReportNode
Deprecated.
 
isLeaf() - Method in class net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter
Deprecated.
 
isLeaf(Object) - Method in class net.sourceforge.pmd.util.viewer.model.ASTModel
Deprecated.
 
isLoggable(MessageReporter.Level) - Method in interface net.sourceforge.pmd.util.log.MessageReporter
 
isMissing(String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
StringUtils.isEmpty(CharSequence)
isMultifile() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
isMultifile() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
isMultifile() - Method in interface net.sourceforge.pmd.Rule
Deprecated.
Logic for multifile analysis is not implemented yet and probably won't be implemented this way. Will be removed in 7.0.0.
isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
Deprecated.
 
isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.MultiValue
Deprecated.
 
isMultiValue() - Method in class net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue
Deprecated.
 
isMultiValue() - Method in interface net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder
Deprecated.
Whether this descriptor is multi-valued.
isMultiValue() - Method in interface net.sourceforge.pmd.properties.PropertyDescriptor
Deprecated.
The hard divide between multi- and single-value properties will be removed with 7.0.0
isNamespace(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isNilled() - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
 
isNoCache() - Method in class net.sourceforge.pmd.ant.PMDTask
 
isNonRecursive() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isNoOutputSupplied() - Method in class net.sourceforge.pmd.ant.Formatter
Deprecated.
isNoRuleSetCompatibility() - Method in class net.sourceforge.pmd.ant.PMDTask
 
isNoSkipBlocks() - Method in class net.sourceforge.pmd.cpd.CPDConfiguration
 
isNotEmpty(Object[]) - Static method in class net.sourceforge.pmd.util.CollectionUtil
Deprecated.
Returns whether the items array is non-null and has at least one entry.
isNotEmpty(String) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
StringUtils.isNotBlank(CharSequence)
isOperation() - Method in interface net.sourceforge.pmd.lang.ast.QualifiedName
Deprecated.
Returns true if the resource addressed by this qualified name is an operation.
isOverriddenDeprecated() - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
isOverriddenMethod(Class<?>, Method, boolean) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
 
isOverridenMethod(Class<?>, Method, boolean) - Static method in class net.sourceforge.pmd.dcd.ClassLoaderUtil
Deprecated.
isProcessingInstruction(Object) - Method in class net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator
Deprecated.
 
isPropertyMultivalue() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
isPropertyNumeric() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.lang.rule.RuleReference
 
isPropertyOverridden(PropertyDescriptor<?>) - Method in class net.sourceforge.pmd.properties.AbstractPropertySource
 
isPropertyOverridden(PropertyDescriptor<?>) - Method in interface net.sourceforge.pmd.properties.PropertySource
Returns true if the given property has been set to a value somewhere in the XML.
isPropertyPackaged() - Method in enum net.sourceforge.pmd.properties.PropertyTypeId
Deprecated.
isPseudoPathElement() - Method in class net.sourceforge.pmd.lang.dfa.pathfinder.PathElement
Deprecated.
 
isReference() - Method in class net.sourceforge.pmd.lang.dfa.VariableAccess
Deprecated.
 
isReportShortNames() - Method in class net.sourceforge.pmd.PMDConfiguration
Get whether to use File short names in Reports.
isRuleChain() - Method in class net.sourceforge.pmd.lang.rule.AbstractDelegateRule
Deprecated.
 
isRuleChain() - Method in class net.sourceforge.pmd.lang.rule.AbstractRule
 
isRuleChain() - Method in interface net.sourceforge.pmd.Rule
Gets whether this Rule uses the RuleChain.
isRuleSetFactoryCompatibilityEnabled() - Method in class net.sourceforge.pmd.PMDConfiguration
Checks if the rule set factory compatibility feature is enabled.
isSame(String, String, boolean, boolean, boolean) - Static method in class net.sourceforge.pmd.util.StringUtil
Deprecated.
Are the two String values the same.
isSameNodeInfo(NodeInfo) - Method in class net.sourceforge.pmd.lang.ast.xpath.saxon.AbstractNodeInfo
Deprecated.
This implementation delegates to AbstractNodeInfo.equals(Object), per the Saxon documentation's description of this method's behavior.
isSet(DataMap.DataKey<? extends K, ?>) - Method in class net.sourceforge.pmd.util.DataMap
Returns true if the given key has a non-null value in the map.
isShortFilenames() - Method in class net.sourceforge.pmd.ant.PMDTask