com.deliveredtechnologies.rulebook

Class RuleBook<T>

java.lang.Object

com.deliveredtechnologies.rulebook.RuleBook<T>

Direct Known Subclasses:

DecisionBook

public abstract class RuleBook<T>
extends java.lang.Object

RuleBook is an abstract class that follows the Template Method design pattern, leaving the defineRules() method implementation for subclasses. This class facilitates the aggregation and chaining together of Rules.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Fact<T>>	_facts
protected java.util.Optional<Rule<T>>	_headRule
protected Rule<T>	_tailRule

Constructor Summary

Constructors

Constructor and Description
RuleBook()

Method Summary

Modifier and Type	Method and Description
void	addRule(Rule<T> rule) The addRule() method adds a rule to the end of the Rules chain.
protected abstract void	defineRules() this is where the rules can be specified in the subclass; it will be executed by run().
RuleBook<T>	given(Fact<T>... facts) The given() method accepts the Facts for this RuleBook.
void	run() The run() method adds the rules [via defineRules()] and runs the rules as long as at least one rule was added.

Methods inherited from class java.lang.Object

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

Field Detail

_headRule

protected java.util.Optional<Rule<T>> _headRule

_tailRule

protected Rule<T> _tailRule

_facts

protected java.util.List<Fact<T>> _facts

Constructor Detail

RuleBook

public RuleBook()

Method Detail

run

public final void run()

The run() method adds the rules [via defineRules()] and runs the rules as long as at least one rule was added.

given

@SafeVarargs
public final RuleBook<T> given(Fact<T>... facts)

The given() method accepts the Facts for this RuleBook. The facts passed in will also be applied to all rules added to this RuleBook.

Parameters:

facts - Facts to be added to the RuleBook and applied to all the Rules in the RuleBook

Returns:

the current RuleBook object

addRule

public void addRule(Rule<T> rule)

The addRule() method adds a rule to the end of the Rules chain.

Parameters:

rule - the Rule to be added

defineRules

protected abstract void defineRules()

this is where the rules can be specified in the subclass; it will be executed by run().