Package net.sourceforge.pmd.lang.java.rule.documentation

Class CommentContentRule

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

net.sourceforge.pmd.lang.java.rule.documentation.CommentContentRule

All Implemented Interfaces:

JavaParserVisitor, net.sourceforge.pmd.lang.rule.ImmutableLanguage, net.sourceforge.pmd.properties.PropertySource, net.sourceforge.pmd.Rule

public class CommentContentRule
extends AbstractCommentRule

A rule that checks for illegal words in the comment text. TODO implement regex option

Author:

Brian Remedios

Field Summary

Fields

Modifier and Type	Field	Description
static net.sourceforge.pmd.properties.PropertyDescriptor<java.lang.Boolean>	CASE_SENSITIVE_DESCRIPTOR
static net.sourceforge.pmd.properties.PropertyDescriptor<java.util.List<java.lang.String>>	DISSALLOWED_TERMS_DESCRIPTOR

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
CommentContentRule()

Method Summary

Modifier and Type	Method	Description
java.lang.String	dysfunctionReason()
void	end(net.sourceforge.pmd.RuleContext ctx)	.
boolean	hasDissallowedTerms()
void	start(net.sourceforge.pmd.RuleContext ctx)	Capture values and perform all the case-conversions once per run
java.lang.Object	visit(ASTCompilationUnit cUnit, java.lang.Object data)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.documentation.AbstractCommentRule

assignCommentsToDeclarations, filteredCommentIn, orderedCommentsAndDeclarations, tagsIndicesIn

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, visitAll

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopy, deepCopyValuesTo, 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, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, 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, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Field Detail

CASE_SENSITIVE_DESCRIPTOR

public static final net.sourceforge.pmd.properties.PropertyDescriptor<java.lang.Boolean> CASE_SENSITIVE_DESCRIPTOR

DISSALLOWED_TERMS_DESCRIPTOR

public static final net.sourceforge.pmd.properties.PropertyDescriptor<java.util.List<java.lang.String>> DISSALLOWED_TERMS_DESCRIPTOR

Constructor Detail

CommentContentRule

public CommentContentRule()

Method Detail

start

public void start(net.sourceforge.pmd.RuleContext ctx)

Capture values and perform all the case-conversions once per run

Specified by:

start in interface net.sourceforge.pmd.Rule

Overrides:

start in class net.sourceforge.pmd.lang.rule.AbstractRule

end

public void end(net.sourceforge.pmd.RuleContext ctx)

.

Specified by:

end in interface net.sourceforge.pmd.Rule

Overrides:

end in class net.sourceforge.pmd.lang.rule.AbstractRule

See Also:

Rule.end(RuleContext)

visit

public java.lang.Object visit(ASTCompilationUnit cUnit,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

hasDissallowedTerms

public boolean hasDissallowedTerms()

dysfunctionReason

public java.lang.String dysfunctionReason()

Specified by:

dysfunctionReason in interface net.sourceforge.pmd.properties.PropertySource

Overrides:

dysfunctionReason in class net.sourceforge.pmd.properties.AbstractPropertySource

See Also:

PropertySource.dysfunctionReason()