InExRules (Jodd API Documentation)

java.lang.Object
- jodd.inex.InExRules<V,D,R>

All Implemented Interfaces:

InExRuleMatcher<V,R>
```
public class InExRules<V,D,R>
extends java.lang.Object
implements InExRuleMatcher<V,R>
```
A single-class rule engine for includes/excludes filtering logic. It can be used when set of objects has to filtered using includes and excludes rules. For example, when filtering files by file name etc.
Rule engine works in one of two modes:
- blacklist - when any input is allowed by default and when you specify explicit excludes.
- whitelist - when any input is disabled by default and when you specify explicit includes.
The logic of this rule engine depends on the current mode. In both cases, always the inverse rules are considered first. For example, for blacklist mode, engine first examine excludes, and then includes. This way you can set any filter combination.
All Jodd classes that filters something uses this class to unify the behavior across the Jodd library.
About generics: rule engine examine Values (V). Rules are defined as Definitions (D). They are stored internally as R, that is used with Values.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InExRules.Rule<R>
Rule definition.

Nested Classes
Modifier and Type	Class and Description
`static class`	`InExRules.Rule<R>` Rule definition.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`blacklist`
`protected int`	`excludesCount`
`protected int`	`includesCount`
`protected InExRuleMatcher<V,R>`	`inExRuleMatcher`
`protected java.util.List<InExRules.Rule<R>>`	`rules`

Fields inherited from interface jodd.inex.InExRuleMatcher
WILDCARD_PATH_RULE_MATCHER, WILDCARD_RULE_MATCHER

Constructor Summary

Constructors
Constructor and Description

InExRules()
Creates default instance.

InExRules(InExRuleMatcher<V,R> inExRuleMatcher)
Creates instance that uses provided matcher.

Constructors
Constructor and Description
`InExRules()` Creates default instance.
`InExRules(InExRuleMatcher<V,R> inExRuleMatcher)` Creates instance that uses provided matcher.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(V value, R rule, boolean include)` Matches value against single rule.
`protected void`	`addRule(D ruleDefinition, boolean include)` Adds a rule.
`boolean`	`apply(V value, boolean flag)` Applies rules on given flag using current black/white list mode.
`boolean`	`apply(V value, boolean blacklist, boolean flag)` Applies rules on given flag.
`void`	`blacklist()` Enables blacklist mode - everything is included by default, and user sets explicit excludes.
`InExRules<java.lang.String,java.lang.String,java.lang.String>`	`create()`
`void`	`detectMode()` Sets blacklist or whitelist mode depending on rules.
`void`	`exclude(D rule)` Adds exclude rule.
`R`	`getRule(int index)` Returns rule's value on given index.
`boolean`	`hasRules()` Returns `true` if rule engine has at least one rule set.
`void`	`include(D rule)` Adds include rule.
`boolean`	`isBlacklist()` Returns `true` if blacklist mode is set.
`boolean`	`isWhitelist()` Returns `true` if whitelist mode is set.
`protected R`	`makeRule(D rule)`
`boolean`	`match(V value)` Matches value against the set of rules using current white/black list mode.
`boolean`	`match(V value, boolean blacklist)` Matches value against the set of rules using provided white/black list mode.
`protected boolean`	`processExcludes(V value, boolean include)` Process excludes rules.
`protected boolean`	`processIncludes(V value, boolean include)` Process includes rules.
`void`	`reset()` Resets all the rules in this rule engine.
`int`	`totalExcludeRules()` Returns total number of exclude rules.
`int`	`totalIncludeRules()` Returns total number of include rules.
`int`	`totalRules()` Returns total number of all rules.
`void`	`whitelist()` Enables whitelist mode - everything is excluded by default, and user set explicit includes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rules
```
protected java.util.List<InExRules.Rule<R>> rules
```
  - inExRuleMatcher
```
protected final InExRuleMatcher<V,R> inExRuleMatcher
```
  - includesCount
```
protected int includesCount
```
  - excludesCount
```
protected int excludesCount
```
  - blacklist
```
protected boolean blacklist
```
- Constructor Detail
  - InExRules
```
public InExRules()
```
    Creates default instance.
  - InExRules
```
public InExRules(InExRuleMatcher<V,R> inExRuleMatcher)
```
    Creates instance that uses provided matcher.
- Method Detail
  - create
```
public InExRules<java.lang.String,java.lang.String,java.lang.String> create()
```
  - totalRules
```
public int totalRules()
```
    Returns total number of all rules.
  - totalIncludeRules
```
public int totalIncludeRules()
```
    Returns total number of include rules.
  - totalExcludeRules
```
public int totalExcludeRules()
```
    Returns total number of exclude rules.
  - hasRules
```
public boolean hasRules()
```
    Returns true if rule engine has at least one rule set.
  - getRule
```
public R getRule(int index)
```
    Returns rule's value on given index.
  - reset
```
public void reset()
```
    Resets all the rules in this rule engine.
  - blacklist
```
public void blacklist()
```
    Enables blacklist mode - everything is included by default, and user sets explicit excludes.
  - isBlacklist
```
public boolean isBlacklist()
```
    Returns true if blacklist mode is set.
  - whitelist
```
public void whitelist()
```
    Enables whitelist mode - everything is excluded by default, and user set explicit includes.
  - isWhitelist
```
public boolean isWhitelist()
```
    Returns true if whitelist mode is set.
  - detectMode
```
public void detectMode()
```
    Sets blacklist or whitelist mode depending on rules. Smart mode determines the following:
    - If there are only include rules, then the whitelist mode is set.
    - If there are only excluded rules, then the blacklist mode is set.
    - In any other case (both type of rules exist or no rules are set), then mode is not changed.
    Should be called after all the rules are set, before matching starts.
  - include
```
public void include(D rule)
```
    Adds include rule.
  - exclude
```
public void exclude(D rule)
```
    Adds exclude rule.
  - addRule
```
protected void addRule(D ruleDefinition,
                       boolean include)
```
    Adds a rule. Duplicates are not allowed and will be ignored.
  - makeRule
```
protected R makeRule(D rule)
```
  - match
```
public boolean match(V value)
```
    Matches value against the set of rules using current white/black list mode.
  - match
```
public boolean match(V value,
                     boolean blacklist)
```
    Matches value against the set of rules using provided white/black list mode.
  - apply
```
public boolean apply(V value,
                     boolean flag)
```
    Applies rules on given flag using current black/white list mode.
    
    See Also:
    
    apply(Object, boolean, boolean)
  - apply
```
public boolean apply(V value,
                     boolean blacklist,
                     boolean flag)
```
    Applies rules on given flag. Flag is only changed if at least one rule matched. Otherwise, the same value is returned. This way you can chain several rules and have the rule engine change the flag only when a rule is matched.
  - processIncludes
```
protected boolean processIncludes(V value,
                                  boolean include)
```
    Process includes rules.
  - processExcludes
```
protected boolean processExcludes(V value,
                                  boolean include)
```
    Process excludes rules.
  - accept
```
public boolean accept(V value,
                      R rule,
                      boolean include)
```
    Matches value against single rule. By default performs equals on value against the rule.
    
    Specified by:
    
    accept in interface InExRuleMatcher<V,R>

Class InExRules<V,D,R>

Nested Class Summary

Field Summary

Fields inherited from interface jodd.inex.InExRuleMatcher

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rules

inExRuleMatcher

includesCount

excludesCount

blacklist

Constructor Detail

InExRules

InExRules

Method Detail

create

totalRules

totalIncludeRules

totalExcludeRules

hasRules

getRule

reset

blacklist

isBlacklist

whitelist

isWhitelist

detectMode

include

exclude

addRule

makeRule

match

match

apply

apply

processIncludes

processExcludes

accept