public class RuleSet extends Object implements ChecksumAware
Rule
Modifier and Type | Method and Description |
---|---|
boolean |
applies(File file)
Check if a given source file should be checked by rules in this RuleSet.
|
static boolean |
applies(Rule rule,
LanguageVersion languageVersion)
Does the given Rule apply to the given LanguageVersion? If so, the
Language must be the same and be between the minimum and maximums
versions on the Rule.
|
void |
apply(List<? extends Node> acuList,
RuleContext ctx)
Executes the rules in this ruleset against each of the given nodes.
|
void |
end(RuleContext ctx)
Triggers the end lifecycle event on each rule in the ruleset.
|
boolean |
equals(Object o)
Two rulesets are equals, if they have the same name and contain the same
rules.
|
long |
getChecksum()
Retrieves the current instance checksum
|
String |
getDescription() |
List<String> |
getExcludePatterns() |
String |
getFileName() |
List<String> |
getIncludePatterns() |
String |
getName() |
Rule |
getRuleByName(String ruleName)
Returns the first Rule found with the given name (case-sensitive).
|
Collection<Rule> |
getRules()
Returns the actual Collection of rules in this ruleset
|
int |
hashCode() |
void |
removeDysfunctionalRules(Collection<Rule> collector)
Remove and collect any misconfigured rules.
|
int |
size()
Returns the number of rules in this ruleset
|
void |
start(RuleContext ctx)
Triggers that start lifecycle event on each rule in this ruleset.
|
boolean |
usesDFA(Language language)
Does any Rule for the given Language use the DFA layer?
|
boolean |
usesTypeResolution(Language language)
Does any Rule for the given Language use Type Resolution?
|
public int size()
public Collection<Rule> getRules()
Rule
public boolean usesDFA(Language language)
language
- The Language.true
if a Rule for the Language uses the DFA layer,
false
otherwise.public Rule getRuleByName(String ruleName)
ruleName
- the exact name of the rule to findpublic boolean applies(File file)
exclude
pattern
which matches the file, unless there is an include
pattern
which also matches the file. In other words, include
patterns override exclude
patterns.file
- the source file to checktrue
if the file should be checked,
false
otherwisepublic void start(RuleContext ctx)
ctx
- the current contextpublic void apply(List<? extends Node> acuList, RuleContext ctx)
acuList
- the node list, usually the root nodes like compilation unitsctx
- the current contextpublic static boolean applies(Rule rule, LanguageVersion languageVersion)
rule
- The rule.languageVersion
- The language version.true
if the given rule matches the given language,
which means, that the rule would be executed.public void end(RuleContext ctx)
ctx
- the current contextpublic boolean equals(Object o)
public String getFileName()
public String getName()
public String getDescription()
public boolean usesTypeResolution(Language language)
language
- The Language.true
if a Rule for the Language uses Type
Resolution, false
otherwise.public void removeDysfunctionalRules(Collection<Rule> collector)
collector
- the removed rules will be added to this collectionpublic long getChecksum()
ChecksumAware
getChecksum
in interface ChecksumAware
Copyright © 2002–2017 PMD. All rights reserved.