Module org.basinmc.lavatory

Package org.basinmc.lavatory.rule

Class Rule

java.lang.Object

org.basinmc.lavatory.rule.Rule

public class Rule
extends Object

Represents a rule which evaluates whether or not to include a certain value within the final result based on a set of special conditions.

Author:

Johannes Donath

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Rule.Action	Provides a list of valid rule return values.
static class	Rule.Deserializer	Provides a custom de-serialization implementation for rules which permits the dynamic application of various types of conditions within the object body.

Constructor Summary

Constructors

Constructor	Description
Rule(Rule.Action action, Set<RuleCondition> conditions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Rule.Action	evaluate(ResolverContext ctx)	Evaluates the result of this rule and thus whether or not the respective value it is attached to is to be included.
Rule.Action	getAction()
Set<RuleCondition>	getConditions()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(@NonNull
            Rule.Action action,
            @NonNull
            Set<RuleCondition> conditions)

Method Detail

evaluate

public Rule.Action evaluate(@NonNull
                            ResolverContext ctx)

Evaluates the result of this rule and thus whether or not the respective value it is attached to is to be included.

Parameters:

ctx - a context.

Returns:

Rule.Action.ALLOW when inclusion is expected, Rule.Action.DISALLOW otherwise.

getAction

@NonNull
public Rule.Action getAction()

getConditions

@NonNull
public Set<RuleCondition> getConditions()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object