net.adamcin.oakpal.api

Class Rule

java.lang.Object

net.adamcin.oakpal.api.Rule

All Implemented Interfaces:

JsonObjectConvertible

@ProviderType
public class Rule
extends Object
implements JsonObjectConvertible

Standard Rule tuple capturing a rule type (include/exclude or allow/deny) and a regex pattern.

config options:

type

The RuleType of the rule: include or exclude (or allow or deny). The meaning of this value is usually dependent on context.

pattern

A regular expression pattern matched against the full context value (start [^] and end [$] are assumed).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Rule.JsonKeys

Constructor Summary

Constructors

Constructor and Description
Rule(RuleType type, Pattern pattern) Create a new rule.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Pattern	getPattern()
RuleType	getType()
int	hashCode()
boolean	isAllow() Readability alias for isInclude() when the rule is used in the more abstract context of scope definition.
boolean	isDeny() Readability alias for isExclude() when the rule is used in the more literal context of acceptable vs unacceptable values.
boolean	isExclude() Readability alias for isDeny() when the rule is used in the more abstract context of scope definition.
boolean	isInclude() Readability alias for isAllow() when the rule is used in the more abstract context of scope definition.
static @NotNull Rule.JsonKeys	keys()
boolean	matches(String value) Conventional usage of the rule's Pattern to match the entirety of the provided string value.
javax.json.JsonObject	toJson() Serializes the rule to a JsonObject.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule(RuleType type,
            Pattern pattern)

Create a new rule.

Parameters:

type - RuleType.INCLUDE or RuleType.EXCLUDE (or RuleType.ALLOW or RuleType.DENY)

pattern - a compiled regular expression pattern

Method Detail

keys

@NotNull
public static @NotNull Rule.JsonKeys keys()

getType

public RuleType getType()

getPattern

public Pattern getPattern()

isInclude

public boolean isInclude()

Readability alias for isAllow() when the rule is used in the more abstract context of scope definition.

Returns:

true if the matched value should be included.

isExclude

public boolean isExclude()

Readability alias for isDeny() when the rule is used in the more abstract context of scope definition.

Returns:

true if the matched value should be excluded.

isAllow

public boolean isAllow()

Readability alias for isInclude() when the rule is used in the more abstract context of scope definition.

Returns:

true if the matched value should be allowed.

isDeny

public boolean isDeny()

Readability alias for isExclude() when the rule is used in the more literal context of acceptable vs unacceptable values.

Returns:

true if the matched value should be denied.

matches

public boolean matches(String value)

Conventional usage of the rule's Pattern to match the entirety of the provided string value. The nature of the value is not considered.

Parameters:

value - a string value

Returns:

true if the pattern matches

toJson

public javax.json.JsonObject toJson()

Serializes the rule to a JsonObject.

Specified by:

toJson in interface JsonObjectConvertible

Returns:

a JsonObject

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object