Deprecated API

Contents

• Packages
• Interfaces
• Classes
• Fields
• Methods
• Constructors
• Enum Constants

Packages

Package	Description
net.sourceforge.pmd.cache

Interfaces

Interface	Description
net.sourceforge.pmd.cache.AnalysisCache	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.ChecksumAware	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.util.datasource.DataSource	Use TextFile

Classes

Class	Description
net.sourceforge.pmd.cache.AbstractAnalysisCache	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.AnalysisCacheListener
net.sourceforge.pmd.cache.AnalysisResult	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.CachedRuleMapper	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.CachedRuleViolation	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.FileAnalysisCache	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.cache.NoopAnalysisCache	This is internal API, will be hidden with 7.0.0
net.sourceforge.pmd.lang.rule.AbstractDelegateRule	This is only relevant to RuleReference, but prevents sharing the implementation of AbstractPropertySource. Will be removed in 7.0.0
net.sourceforge.pmd.lang.rule.ParametricRuleViolation	This is internal. Clients should exclusively use RuleViolation.
net.sourceforge.pmd.rules.RuleFactory
net.sourceforge.pmd.RuleSetReference	This is part of the internals of the RuleSetLoader.
net.sourceforge.pmd.RuleSetReferenceId	This is part of the internals of the RuleSetLoader.
net.sourceforge.pmd.RuleSets	Internal API
net.sourceforge.pmd.util.datasource.FileDataSource
net.sourceforge.pmd.util.datasource.ReaderDataSource
net.sourceforge.pmd.util.datasource.ZipDataSource
net.sourceforge.pmd.util.ResourceLoader	Is internal API

Fields

Field	Description
net.sourceforge.pmd.cpd.CpdLanguageProperties.DEFAULT_SKIP_BLOCKS_PATTERN
net.sourceforge.pmd.lang.rule.XPathRule.VERSION_DESCRIPTOR	Use XPathRule(XPathVersion, String)
net.sourceforge.pmd.lang.rule.XPathRule.XPATH_DESCRIPTOR	Use XPathRule(XPathVersion, String)
net.sourceforge.pmd.properties.AbstractPropertySource.propertyDescriptors	Will be made private final
net.sourceforge.pmd.properties.AbstractPropertySource.propertyValuesByDescriptor	Will be made private final

Methods

Method	Description
net.sourceforge.pmd.AbstractConfiguration.setIgnoreFilePath(String)	Use AbstractConfiguration.setIgnoreFilePath(Path)
net.sourceforge.pmd.AbstractConfiguration.setInputFilePath(String)	Use AbstractConfiguration.setInputFilePath(Path)
net.sourceforge.pmd.AbstractConfiguration.setInputPaths(String)	Use AbstractConfiguration.setInputPathList(List) or AbstractConfiguration.addInputPath(Path)
net.sourceforge.pmd.AbstractConfiguration.setInputUri(String)	Use AbstractConfiguration.setInputUri(URI)
net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode.joinTokenText()	Some rules depend on it and have not been rewritten
net.sourceforge.pmd.lang.ast.Node.findChildNodesWithXPath(String)	This is very inefficient and should not be used in new code. PMD 7.0.0 will remove support for this method.
net.sourceforge.pmd.lang.ast.Node.findChildrenOfType(Class<? extends T>)	Use node stream methods: node.children(childType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
net.sourceforge.pmd.lang.ast.Node.findDescendantsOfType(Class<? extends T>)	Use node stream methods: node.descendants(targetType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
net.sourceforge.pmd.lang.ast.Node.getFirstChildOfType(Class<? extends T>)	Use Node.firstChild(Class)
net.sourceforge.pmd.lang.ast.Node.getFirstDescendantOfType(Class<? extends T>)	Use node stream methods: node.descendants(targetType).first().
net.sourceforge.pmd.lang.ast.Node.getFirstParentOfType(Class<? extends T>)	Use node stream methods: node.ancestors(parentType).first()
net.sourceforge.pmd.lang.ast.Node.getImage()	Should be replaced with methods that have more specific names in node classes.
net.sourceforge.pmd.lang.ast.Node.getNthParent(int)	Use node stream methods: node.ancestors().get(n-1)
net.sourceforge.pmd.lang.ast.Node.getParentsOfType(Class<? extends T>)	Use node stream methods: node.ancestors(parentType).toList(). Most usages don't really need a list though, eg you can iterate the node stream instead
net.sourceforge.pmd.lang.ast.Node.hasDescendantOfType(Class<? extends T>)	Use node stream methods: node.descendants(targetType).nonEmpty().
net.sourceforge.pmd.lang.ast.Node.hasImageEqualTo(String)	See Node.getImage()
net.sourceforge.pmd.lang.document.FileCollector.addZipFile(Path)	Use FileCollector.addZipFileWithContent(Path) instead.
net.sourceforge.pmd.lang.document.FileId.toString()	Do not use this method, use one of the other getters
net.sourceforge.pmd.lang.document.TextDocument.readOnlyString(CharSequence, String, LanguageVersion)
net.sourceforge.pmd.lang.document.TextFile.dataSourceCompat(DataSource, PMDConfiguration)	This is deprecated until PMD 7 is out, after which DataSource will be removed.
net.sourceforge.pmd.lang.Language.getTerseName()	Use Language.getId()
net.sourceforge.pmd.lang.LanguageRegistry.findByExtension(String)	Not replaced, extension will be extended to match full name in PMD 7.
net.sourceforge.pmd.lang.LanguageRegistry.findLanguageByTerseName(String)	Use LanguageRegistry.PMD.getLanguageById.
net.sourceforge.pmd.lang.LanguageRegistry.getLanguage(String)	Use LanguageRegistry.PMD.getLanguageByFullName
net.sourceforge.pmd.lang.LanguageVersionDiscoverer.getLanguagesForFile(File)	PMD 7 avoids using File.
net.sourceforge.pmd.lang.rule.AbstractDelegateRule.setRule(Rule)	This will be removed in 7.0.0 I mark it specially deprecated because it's inherited by rule reference, even though a RuleReference has no business setting its rule after construction
net.sourceforge.pmd.lang.rule.AbstractRule.addRuleChainVisit(Class<? extends Node>)	Override AbstractRule.buildTargetSelector(), this is provided for legacy compatibility
net.sourceforge.pmd.lang.rule.AbstractRule.addViolation(Object, Node)	Replace with asCtx(data).addViolation(node).
net.sourceforge.pmd.lang.rule.AbstractRule.addViolationWithMessage(Object, Node, String)	Replace with asCtx(data).addViolationWithMessage(node, message).
net.sourceforge.pmd.lang.rule.AbstractRule.deepCopyValuesTo(AbstractRule)	Use AbstractRule.deepCopy() to create verbatim copies of rules.
net.sourceforge.pmd.lang.rule.RuleReference.hasOverriddenProperty(PropertyDescriptor<?>)	Use RuleReference.isPropertyOverridden(PropertyDescriptor) instead
net.sourceforge.pmd.lang.rule.RuleReference.setRuleSetReference(RuleSetReference)	There's no use in setting the ruleset reference after construction
net.sourceforge.pmd.PMDConfiguration.getReportFile()	Use PMDConfiguration.getReportFilePath()
net.sourceforge.pmd.PMDConfiguration.getRuleSets()	Use PMDConfiguration.getRuleSetPaths()
net.sourceforge.pmd.PMDConfiguration.prependClasspath(String)	Use PMDConfiguration.prependAuxClasspath(String), which doesn't throw a checked IOException
net.sourceforge.pmd.PMDConfiguration.setReportFile(String)	Use PMDConfiguration.setReportFile(Path)
net.sourceforge.pmd.PMDConfiguration.setRuleSets(String)	Use PMDConfiguration.setRuleSets(List) or PMDConfiguration.addRuleSet(String).
net.sourceforge.pmd.properties.AbstractPropertySource.copyPropertyDescriptors()	Just use AbstractPropertySource.getPropertyDescriptors()
net.sourceforge.pmd.properties.AbstractPropertySource.copyPropertyValues()	Just use AbstractPropertySource.getPropertiesByPropertyDescriptor() or AbstractPropertySource.getOverriddenPropertiesByPropertyDescriptor()
net.sourceforge.pmd.properties.PropertySource.dysfunctionReason()	PMD 7 will introduce another mechanism to report dysfunctional rules better.
net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer.renderFileReport(Report)	This is internal API. Do not override when extending AbstractAccumulatingRenderer. In PMD7 this method will be made final.
net.sourceforge.pmd.Report.addConfigError(Report.ConfigurationError)	PMD's way of creating a report is internal and may be changed in pmd 7.
net.sourceforge.pmd.Report.addError(Report.ProcessingError)	PMD's way of creating a report is internal and may be changed in pmd 7.
net.sourceforge.pmd.Report.addRuleViolation(RuleViolation)	PMD's way of creating a report is internal and may be changed in pmd 7.
net.sourceforge.pmd.Report.merge(Report)	Convert Renderer to use the reports.
net.sourceforge.pmd.reporting.Reportable.getBeginColumn()	Use Reportable.getReportLocation()
net.sourceforge.pmd.reporting.Reportable.getBeginLine()	Use Reportable.getReportLocation()
net.sourceforge.pmd.reporting.Reportable.getEndColumn()	Use Reportable.getReportLocation()
net.sourceforge.pmd.reporting.Reportable.getEndLine()	Use Reportable.getReportLocation()
net.sourceforge.pmd.RuleContext.getRule()	Used in AbstractRule.asCtx(Object), when that is gone, will be removed.
net.sourceforge.pmd.RuleSet.applies(Rule, LanguageVersion)	This is internal API, removed in PMD 7. You should not use a ruleset directly.
net.sourceforge.pmd.RuleSet.removeDysfunctionalRules(Collection<Rule>)	This is internal API, removed in PMD 7. You should not use a ruleset directly.
net.sourceforge.pmd.RuleSetLoader.toFactory()	RuleSetFactory is deprecated, replace its usages with usages of this class, or of static factory methods of RuleSet
net.sourceforge.pmd.RuleSetReferenceId.toString()	Do not rely on the format of this method, it may be changed in PMD 7.
net.sourceforge.pmd.RuleViolation.getClassName()	Use RuleViolation.CLASS_NAME
net.sourceforge.pmd.RuleViolation.getMethodName()	Use RuleViolation.METHOD_NAME
net.sourceforge.pmd.RuleViolation.getPackageName()	Use RuleViolation.PACKAGE_NAME
net.sourceforge.pmd.RuleViolation.getVariableName()	Use RuleViolation.VARIABLE_NAME
net.sourceforge.pmd.util.CollectionUtil.invertedMapFrom(Map<K, V>)	Used by deprecated property types
net.sourceforge.pmd.util.CollectionUtil.mapFrom(K[], V[])	Used by deprecated property types
net.sourceforge.pmd.util.IteratorUtil.AbstractIterator.remove()
net.sourceforge.pmd.util.treeexport.TreeExportConfiguration.getReportFile()	Use TreeExportConfiguration.getReportFilePath()
net.sourceforge.pmd.util.treeexport.TreeExportConfiguration.setReportFile(String)	Use TreeExportConfiguration.setReportFile(Path)

Constructors

Constructor	Description
net.sourceforge.pmd.cpd.Tokens()
net.sourceforge.pmd.lang.rule.ParametricRuleViolation(Rule, Reportable, String)	Update tests that use this not to call the ctor directly.
net.sourceforge.pmd.lang.rule.XPathRule()	This is now only used by the ruleset loader. When we have syntactic sugar for XPath rules in the XML, we won't need this anymore.

Enum Constants

Enum Constant	Description
net.sourceforge.pmd.lang.rule.xpath.XPathVersion.XPATH_1_0	not supported anymore
net.sourceforge.pmd.lang.rule.xpath.XPathVersion.XPATH_1_0_COMPATIBILITY	Not supported any more.
net.sourceforge.pmd.lang.rule.xpath.XPathVersion.XPATH_2_0	Technically still supported, use 3.1 instead. There are no known incompatibilities.