|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codenarc.ruleset.FilteredRuleSet
class FilteredRuleSet
A RuleSet
implementation that is a Decorator for another RuleSet, but provides
the ability to filter included and excluded rules within that RuleSet.
If a Rule matches both an include and an exclude, then the exclude takes precedence, i.e. the
Rule is NOT includes in the result from getRules()
.
Constructor Summary | |
FilteredRuleSet(RuleSet ruleSet)
Construct a new instance on the specified RuleSet |
Method Summary | |
---|---|
void
|
addExclude(String exclude)
Add an exclude criteria. |
void
|
addInclude(String include)
Add an include criteria. |
List
|
getRules()
Return the List of Rules that match the include(s) (if specified) AND DO NOT match any exlcude(s) specified. |
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Constructor Detail |
---|
FilteredRuleSet(RuleSet ruleSet)
ruleset
- - the RuleSet to be filtered (decorated); must not be null.
Method Detail |
---|
void addExclude(String exclude)
exclude
- - the exclude specification, which is compared against the ids of all of the Rules
within the underlying RuleSet. Any matching Rules are excluded in the result from getRules()
.
The exclude
value must not be null or empty.
void addInclude(String include)
include
- - the include specification, which is compared against the ids of all of the Rules
within the underlying RuleSet. Only matching Rules are included in the result from getRules()
.
The include
value must not be null or empty.
List getRules()
Groovy Documentation