public interface Rule extends PropertySource
Modifier and Type | Field and Description |
---|---|
static StringProperty |
VIOLATION_SUPPRESS_REGEX_DESCRIPTOR
The property descriptor to universally suppress violations with messages matching a regular expression.
|
static StringProperty |
VIOLATION_SUPPRESS_XPATH_DESCRIPTOR
Name of the property to universally suppress violations on nodes which match a given relative XPath expression.
|
Modifier and Type | Method and Description |
---|---|
void |
addExample(String example)
Add a single example for this Rule.
|
void |
addRuleChainVisit(Class<? extends Node> nodeClass)
Adds an AST node by class to be visited by the Rule on the RuleChain.
|
void |
addRuleChainVisit(String astNodeName)
Adds an AST node by name to be visited by the Rule on the RuleChain.
|
void |
apply(List<? extends Node> nodes,
RuleContext ctx)
Apply this rule to the given collection of nodes, using the
given context.
|
void |
end(RuleContext ctx)
End processing.
|
String |
getDescription()
Get the description of this Rule.
|
List<String> |
getExamples()
Get the list of examples for this Rule.
|
String |
getExternalInfoUrl()
Get a URL for external information about this Rule.
|
Language |
getLanguage()
Get the Language of this Rule.
|
LanguageVersion |
getMaximumLanguageVersion()
Get the maximum LanguageVersion to which this Rule applies.
|
String |
getMessage()
Get the message to show when this Rule identifies a violation.
|
LanguageVersion |
getMinimumLanguageVersion()
Get the minimum LanguageVersion to which this Rule applies.
|
String |
getName()
Get the name of this Rule.
|
ParserOptions |
getParserOptions()
Get the parser options for this Rule.
|
RulePriority |
getPriority()
Get the priority of this Rule.
|
List<String> |
getRuleChainVisits()
Gets the collection of AST node names visited by the Rule on the
RuleChain.
|
String |
getRuleClass()
Get the class of this Rule.
|
String |
getRuleSetName()
Get the name of the RuleSet containing this Rule.
|
String |
getSince()
Get the version of PMD in which this Rule was added.
|
boolean |
isDeprecated()
Gets whether this Rule is deprecated.
|
void |
setDeprecated(boolean deprecated)
Sets whether this Rule is deprecated.
|
void |
setDescription(String description)
Set the description of this Rule.
|
void |
setExternalInfoUrl(String externalInfoUrl)
Set a URL for external information about this Rule.
|
void |
setLanguage(Language language)
Set the Language of this Rule.
|
void |
setMaximumLanguageVersion(LanguageVersion maximumLanguageVersion)
Set the maximum LanguageVersion to which this Rule applies.
|
void |
setMessage(String message)
Set the message to show when this Rule identifies a violation.
|
void |
setMinimumLanguageVersion(LanguageVersion minimumLanguageVersion)
Set the minimum LanguageVersion to which this Rule applies.
|
void |
setName(String name)
Set the name of this Rule.
|
void |
setPriority(RulePriority priority)
Set the priority of this Rule.
|
void |
setRuleClass(String ruleClass)
Set the class of this Rule.
|
void |
setRuleSetName(String name)
Set the name of the RuleSet containing this Rule.
|
void |
setSince(String since)
Set the version of PMD in which this Rule was added.
|
void |
setUsesDFA()
Sets whether this Rule uses Data Flow Analysis.
|
void |
setUsesTypeResolution()
Sets whether this Rule uses Type Resolution.
|
void |
start(RuleContext ctx)
Start processing.
|
boolean |
usesDFA()
Gets whether this Rule uses Data Flow Analysis.
|
boolean |
usesRuleChain()
Gets whether this Rule uses the RuleChain.
|
boolean |
usesTypeResolution()
Gets whether this Rule uses Type Resolution.
|
definePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues
static final StringProperty VIOLATION_SUPPRESS_REGEX_DESCRIPTOR
static final StringProperty VIOLATION_SUPPRESS_XPATH_DESCRIPTOR
Language getLanguage()
void setLanguage(Language language)
LanguageVersion getMinimumLanguageVersion()
null
it indicates there is no minimum bound.void setMinimumLanguageVersion(LanguageVersion minimumLanguageVersion)
LanguageVersion getMaximumLanguageVersion()
null
it indicates there is no maximum bound.void setMaximumLanguageVersion(LanguageVersion maximumLanguageVersion)
boolean isDeprecated()
void setDeprecated(boolean deprecated)
String getName()
void setName(String name)
String getSince()
null
if not applicable.void setSince(String since)
String getRuleClass()
void setRuleClass(String ruleClass)
String getRuleSetName()
RuleSet
void setRuleSetName(String name)
RuleSet
String getMessage()
void setMessage(String message)
String getDescription()
void setDescription(String description)
void addExample(String example)
String getExternalInfoUrl()
void setExternalInfoUrl(String externalInfoUrl)
RulePriority getPriority()
void setPriority(RulePriority priority)
ParserOptions getParserOptions()
Parser
to create an AST in the form the Rule
is expecting. Because ParserOptions are mutable, a Rule should
return a new instance on each call.void setUsesDFA()
boolean usesDFA()
void setUsesTypeResolution()
boolean usesTypeResolution()
boolean usesRuleChain()
List<String> getRuleChainVisits()
void addRuleChainVisit(Class<? extends Node> nodeClass)
void addRuleChainVisit(String astNodeName)
void start(RuleContext ctx)
void apply(List<? extends Node> nodes, RuleContext ctx)
void end(RuleContext ctx)
Copyright © 2002–2013 InfoEther. All rights reserved.