public class CommentContentRule extends AbstractCommentRule
Modifier and Type | Field and Description |
---|---|
static BooleanProperty |
CASE_SENSITIVE_DESCRIPTOR |
static StringMultiProperty |
DISSALLOWED_TERMS_DESCRIPTOR |
static BooleanProperty |
WORDS_ARE_REGEX_DESCRIPTOR |
propertyDescriptors, propertyValuesByDescriptor
VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR
Constructor and Description |
---|
CommentContentRule() |
Modifier and Type | Method and Description |
---|---|
String |
dysfunctionReason()
Returns a description of why the receiver may be dysfunctional.
|
void |
end(RuleContext ctx)
End processing.
|
boolean |
hasDissallowedTerms() |
Set<PropertyDescriptor<?>> |
ignoredProperties()
Return the properties that are effectively ignored due to the
configuration of the rule and values held by other properties.
|
void |
start(RuleContext ctx)
Capture values and perform all the case-conversions once per run
|
Object |
visit(ASTCompilationUnit cUnit,
Object data) |
assignCommentsToDeclarations, filteredCommentIn, orderedCommentsAndDeclarations, tagsIndicesIn
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, visitAll
addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopyValuesTo, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, usesDFA, usesRuleChain, usesTypeResolution
copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, setProperty, useDefaultValueFor, usesDefaultValues
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, setProperty, useDefaultValueFor, usesDefaultValues
public static final BooleanProperty WORDS_ARE_REGEX_DESCRIPTOR
public static final BooleanProperty CASE_SENSITIVE_DESCRIPTOR
public static final StringMultiProperty DISSALLOWED_TERMS_DESCRIPTOR
public void start(RuleContext ctx)
start
in interface Rule
start
in class AbstractRule
ctx
- the rule contextRule.start(RuleContext)
public Set<PropertyDescriptor<?>> ignoredProperties()
AbstractPropertySource
ignoredProperties
in interface PropertySource
ignoredProperties
in class AbstractPropertySource
public void end(RuleContext ctx)
Rule
end
in interface Rule
end
in class AbstractRule
ctx
- the rule contextRule.end(RuleContext)
public Object visit(ASTCompilationUnit cUnit, Object data)
visit
in interface JavaParserVisitor
visit
in class AbstractJavaRule
public boolean hasDissallowedTerms()
public String dysfunctionReason()
AbstractPropertySource
dysfunctionReason
in interface PropertySource
dysfunctionReason
in class AbstractPropertySource
PropertySource.dysfunctionReason()
Copyright © 2002–2014 InfoEther. All rights reserved.