AbstractCommentRule (PMD Java 6.25.0 API)

java.lang.Object
- net.sourceforge.pmd.properties.AbstractPropertySource
- - net.sourceforge.pmd.lang.rule.AbstractRule
  - - net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
    - - net.sourceforge.pmd.lang.java.rule.documentation.AbstractCommentRule

All Implemented Interfaces:

JavaParserVisitor, ImmutableLanguage, PropertySource, Rule

Direct Known Subclasses:

CodeInCommentsRule, CommentContentRule, CommentRequiredRule, CommentSizeRule, HeaderCommentsRule, JavadocRule
```
@Deprecated
@InternalApi
public abstract class AbstractCommentRule
extends AbstractJavaRule
```
Deprecated.
Internal API

Author:

Brian Remedios

Field Summary
- Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource
  propertyDescriptors, propertyValuesByDescriptor
- Fields inherited from interface net.sourceforge.pmd.Rule
  VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors
Constructor Description

AbstractCommentRule()
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected void`	`assignCommentsToDeclarations(ASTCompilationUnit cUnit)`	Deprecated.
`protected String`	`filteredCommentIn(Comment comment)`	Deprecated.
`protected SortedMap<Integer,Node>`	`orderedCommentsAndDeclarations(ASTCompilationUnit cUnit)`	Deprecated.
`protected List<Integer>`	`tagsIndicesIn(String comments)`	Deprecated. This method is deprecated and will be removed with PMD 7.0.0.

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
apply, getDeclaringType, importsPackage, isQualifiedName, isSuppressed, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitAll

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule
addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopy, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getPropertySourceType, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource
copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource
definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

- Constructor Detail
  - AbstractCommentRule
```
public AbstractCommentRule()
```
    Deprecated.
- Method Detail
  - tagsIndicesIn
```
@Deprecated
protected List<Integer> tagsIndicesIn(String comments)
```
    Deprecated.
    This method is deprecated and will be removed with PMD 7.0.0. It is not very useful, since it doesn't extract the information in a useful way. You would still need check, which tags have been found, and with which data they might be accompanied. A more useful solution will be added around the AST node FormalComment, which contains as children JavadocElement nodes, which in turn provide access to the JavadocTag.
    
    Returns a list of indices of javadoc tag occurrences in the comment.
    Note: if the same tag occurs multiple times, only the last occurrence is returned.
    
    Parameters:
    
    comments - the complete comment text
    
    Returns:
    
    list of indices.
  - filteredCommentIn
```
protected String filteredCommentIn(Comment comment)
```
    Deprecated.
  - assignCommentsToDeclarations
```
protected void assignCommentsToDeclarations(ASTCompilationUnit cUnit)
```
    Deprecated.
  - orderedCommentsAndDeclarations
```
protected SortedMap<Integer,Node> orderedCommentsAndDeclarations(ASTCompilationUnit cUnit)
```
    Deprecated.