com.deliveredtechnologies.rulebook

Interface Rule<T>

All Known Subinterfaces:

Decision<T,U>

All Known Implementing Classes:

RuleAdapter, StandardDecision, StandardRule

public interface Rule<T>

A Rule is an interface that uses the following format: rule.given(facts).when(some condition given facts).then(do something)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getThen() Method getThen() gets an instance of a functional interface responsbile for the action to be performed by the Rule.
java.util.function.Predicate<FactMap<T>>	getWhen() Method getWhen() gets the Predicate that evaluates the condition of the Rule.
Rule<T>	given(Fact<T>... facts) The given() method sets the Facts to be used by the Rule.
Rule<T>	given(FactMap<T> facts) The given() method sets the Facts to be used by the Rule.
Rule<T>	given(java.util.List<Fact<T>> facts) The given() method sets the Facts to be used by the Rule.
void	run() The run() method evaluates the Rule.
void	setNextRule(Rule<T> rule) The setNextRule method adds the next Rule to the chain.
Rule<T>	then(java.util.function.Function<FactMap<T>,RuleState> action) The then() method performs some action based on facts and returns a RuleState of either NEXT or BREAK.
Rule<T>	when(java.util.function.Predicate<FactMap<T>> test) The when() method takes in a Predicate that evaluates the facts against a condition.

Method Detail

run

void run()

The run() method evaluates the Rule.

given

Rule<T> given(Fact<T>... facts)

The given() method sets the Facts to be used by the Rule.

Parameters:

facts - Facts to be used by the Rule

Returns:

the current Rule object

given

Rule<T> given(java.util.List<Fact<T>> facts)

The given() method sets the Facts to be used by the Rule.

Parameters:

facts - a List of Facts to be used by the Rule

Returns:

the current Rule object

given

Rule<T> given(FactMap<T> facts)

The given() method sets the Facts to be used by the Rule.

Parameters:

facts - a FactMap

Returns:

the current Rule object

getWhen

java.util.function.Predicate<FactMap<T>> getWhen()

Method getWhen() gets the Predicate that evaluates the condition of the Rule.

Returns:

a Predicate object

when

Rule<T> when(java.util.function.Predicate<FactMap<T>> test)

The when() method takes in a Predicate that evaluates the facts against a condition.

Parameters:

test - the condition(s) to be evaluated against the Facts

Returns:

the current Rule object

getThen

java.lang.Object getThen()

Method getThen() gets an instance of a functional interface responsbile for the action to be performed by the Rule.

Returns:

a functional interface Object

then

Rule<T> then(java.util.function.Function<FactMap<T>,RuleState> action)

The then() method performs some action based on facts and returns a RuleState of either NEXT or BREAK. If NEXT is returned then the next rule in the chain is executed. If BREAK is returned then the chain is broken and no more rules are executed in the chain.

Parameters:

action - the action to be performed

Returns:

the current Rule object

setNextRule

void setNextRule(Rule<T> rule)

The setNextRule method adds the next Rule to the chain.

Parameters:

rule - the next Rule to add to the chain