A C D F G R S T V W _

A

addRule(Decision<T, U>) - Method in class com.deliveredtechnologies.rulebook.DecisionBook

The addRule() method allows a rule to be added to the DecisionBook in the abstract defineRules method.

addRule(Rule<T>) - Method in class com.deliveredtechnologies.rulebook.RuleBook

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

AnnotationUtils - Class in com.deliveredtechnologies.rulebook.util

AnnotationUtils is a utility class for annotations.

C

com.deliveredtechnologies.rulebook - package com.deliveredtechnologies.rulebook

com.deliveredtechnologies.rulebook.annotation - package com.deliveredtechnologies.rulebook.annotation

com.deliveredtechnologies.rulebook.runner - package com.deliveredtechnologies.rulebook.runner

com.deliveredtechnologies.rulebook.util - package com.deliveredtechnologies.rulebook.util

create(Class<T>, Class<U>) - Static method in class com.deliveredtechnologies.rulebook.StandardDecision

This create() method is a convenience method to avoid using new and generic syntax.

create() - Static method in class com.deliveredtechnologies.rulebook.StandardDecision

This create() method is another convenience method to create a non-type specific StandardDecision.

create(Class<T>) - Static method in class com.deliveredtechnologies.rulebook.StandardRule

This create() method is a convenience method to avoid using new and generic syntax.

create() - Static method in class com.deliveredtechnologies.rulebook.StandardRule

This create() method is a convenience method to create a non-type specific StandardRule.

D

Decision<T,U> - Interface in com.deliveredtechnologies.rulebook

A special type of rule that has a return type, which may be different from the type of input (Facts).

DecisionBook<T,U> - Class in com.deliveredtechnologies.rulebook

DecisionBook is a type of RuleBook that stores a return type linked to all the rules in the DecisionBook.

DecisionBook() - Constructor for class com.deliveredtechnologies.rulebook.DecisionBook

defineRules() - Method in class com.deliveredtechnologies.rulebook.RuleBook

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

defineRules() - Method in class com.deliveredtechnologies.rulebook.runner.RuleBookRunner

F

Fact<T> - Class in com.deliveredtechnologies.rulebook

A Fact is a single piece of data that can be supplied to a Rule.

Fact(String, T) - Constructor for class com.deliveredtechnologies.rulebook.Fact

Fact(T) - Constructor for class com.deliveredtechnologies.rulebook.Fact

FactMap<T> - Class in com.deliveredtechnologies.rulebook

A FactMap is an extension of HashMap; it stores facts by their name and provides convenience methods for accessing Fact objects.

FactMap() - Constructor for class com.deliveredtechnologies.rulebook.FactMap

G

getAnnotatedField(Class, Class) - Static method in class com.deliveredtechnologies.rulebook.util.AnnotationUtils

Method getAnnotatedField gets the first annotated field of the type of annotation specified.

getAnnotatedFields(Class, Class) - Static method in class com.deliveredtechnologies.rulebook.util.AnnotationUtils

Method getAnnotatedFields gets the fields annotated of a specific type from the class and its parent classes.

getAnnotatedMethod(Class, Class) - Static method in class com.deliveredtechnologies.rulebook.util.AnnotationUtils

Method getAnnotatedMethod the first annotated method of the type of annotation specified.

getAnnotatedMethods(Class, Class) - Static method in class com.deliveredtechnologies.rulebook.util.AnnotationUtils

Method getAnnotatedMethods gets the methods annotated of a specific type from the class and its parent classes.

getAnnotation(Class<A>, Class<?>) - Static method in class com.deliveredtechnologies.rulebook.util.AnnotationUtils

Method getAnnotation returns the annotation on a class or its parent annotation.

getFactMap() - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The getFactMap() method gets the factMap of stored facts.

getName() - Method in class com.deliveredtechnologies.rulebook.Fact

The method getName() gets the name of the Fact.

getOne() - Method in class com.deliveredtechnologies.rulebook.FactMap

The method getOne() gets the value of the single Fact in the FactMap.

getResult() - Method in interface com.deliveredtechnologies.rulebook.Decision

The getResult() method returns the stored result from the Decision The value may be null.

getResult() - Method in class com.deliveredtechnologies.rulebook.DecisionBook

The getResult() method allows the result of the DecisionBook rules execution to be retrieved.

getResult() - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The getResult() method gets the stored Result value from the execution of the StandardDecision.

getThen() - Method in interface com.deliveredtechnologies.rulebook.Rule

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

getThen() - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter

Method getThen() returns the 'then' action to be used; either a Function object or a BiFunction object.

getThen() - Method in class com.deliveredtechnologies.rulebook.StandardDecision

getThen() - Method in class com.deliveredtechnologies.rulebook.StandardRule

getValue() - Method in class com.deliveredtechnologies.rulebook.Fact

The method getValue() gets the value of the Fact.

getValue(String) - Method in class com.deliveredtechnologies.rulebook.FactMap

The method getValue() returns the value of the Fact associated with the name passed in.

getValue() - Method in class com.deliveredtechnologies.rulebook.Result

The method getValue() returns the object contained in the Result object.

getWhen() - Method in interface com.deliveredtechnologies.rulebook.Rule

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

getWhen() - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter

getWhen() - Method in class com.deliveredtechnologies.rulebook.StandardDecision

getWhen() - Method in class com.deliveredtechnologies.rulebook.StandardRule

Given - Annotation Type in com.deliveredtechnologies.rulebook.annotation

Given defines a field that is hydrated from a Fact.

given(Fact<T>...) - Method in interface com.deliveredtechnologies.rulebook.Rule

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

given(List<Fact<T>>) - Method in interface com.deliveredtechnologies.rulebook.Rule

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

given(FactMap<T>) - Method in interface com.deliveredtechnologies.rulebook.Rule

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

given(Fact<T>...) - Method in class com.deliveredtechnologies.rulebook.RuleBook

The given() method accepts the Facts for this RuleBook.

given(Fact...) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter

given(List) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter

given(FactMap) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter

given(Fact<T>...) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The given() method accepts Facts for the StandardDecision.

given(List<Fact<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The given() method accepts Facts for the StandardDecision.

given(FactMap<T>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The given() method accepts Facts for the StandardDecision.

given(Fact<T>...) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The given() method accepts Facts to be evaluated in the Rule.

given(List<Fact<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The given() method accepts Facts to be evaluated in the Rule.

given(FactMap<T>) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The given() method accepts Facts to be evaluated in the Rule.

R

Result - Annotation Type in com.deliveredtechnologies.rulebook.annotation

Result is used to map a single field to a Result in a Decision.

Result<T> - Class in com.deliveredtechnologies.rulebook

This is a wrapper class for the actual result.

Result() - Constructor for class com.deliveredtechnologies.rulebook.Result

Rule - Annotation Type in com.deliveredtechnologies.rulebook.annotation

Rule defines a class to be injected into a Decision.

Rule<T> - Interface in com.deliveredtechnologies.rulebook

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

RuleAdapter - Class in com.deliveredtechnologies.rulebook.runner

RuleAdapter accepts a POJO annotated Rule class and adapts it to an actual Rule class.

RuleAdapter(Object) - Constructor for class com.deliveredtechnologies.rulebook.runner.RuleAdapter

RuleAdapter accepts a Rule annotated POJO and adapts it to a Rule or Decision.

RuleBook<T> - Class in com.deliveredtechnologies.rulebook

RuleBook is an abstract class that follows the Template Method design pattern, leaving the defineRules() method implementation for subclasses.

RuleBook() - Constructor for class com.deliveredtechnologies.rulebook.RuleBook

RuleBookRunner - Class in com.deliveredtechnologies.rulebook.runner

RuleBookRunner creates a RuleBook from a package containing Rule annotated POJOs.

RuleBookRunner(String) - Constructor for class com.deliveredtechnologies.rulebook.runner.RuleBookRunner

RuleState - Enum in com.deliveredtechnologies.rulebook

Enumeration for whether the continue the rule chain or break it.

run() - Method in interface com.deliveredtechnologies.rulebook.Rule

The run() method evaluates the Rule.

run() - Method in class com.deliveredtechnologies.rulebook.RuleBook

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

run() - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The run() method runs the Predicate supplied by the when() method.

run() - Method in class com.deliveredtechnologies.rulebook.StandardRule

The run() method runs the Predicate supplied by the when() method.

S

setName(String) - Method in class com.deliveredtechnologies.rulebook.Fact

The method setName() sets the name of the Fact.

setNextRule(Rule<T>) - Method in interface com.deliveredtechnologies.rulebook.Rule

The setNextRule method adds the next Rule to the chain.

setNextRule(Rule<T>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The setNextRule() method sets the next rule in the chain.

setNextRule(Rule<T>) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The setNextRule() method sets the next Rule in the chain.

setResult(Result<U>) - Method in interface com.deliveredtechnologies.rulebook.Decision

The setResult() method initializes the stored result; useful for aggregation/chaining of a result.

setResult(Result<U>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The setResult() method sets the stored Result.

setValue(T) - Method in class com.deliveredtechnologies.rulebook.Fact

The method setValue() sets the value of the Fact.

setValue(T) - Method in class com.deliveredtechnologies.rulebook.Result

The method setValue() sets the object to be contained in the Result object.

StandardDecision<T,U> - Class in com.deliveredtechnologies.rulebook

StandardDecision is the standard implementation of Decision.

StandardDecision() - Constructor for class com.deliveredtechnologies.rulebook.StandardDecision

StandardRule<T> - Class in com.deliveredtechnologies.rulebook

StandardRule is a standard rule implementation that can be used with a RuleBook.

StandardRule() - Constructor for class com.deliveredtechnologies.rulebook.StandardRule

T

Then - Annotation Type in com.deliveredtechnologies.rulebook.annotation

Then marks a method as an action.

then(BiFunction<FactMap<T>, Result<U>, RuleState>) - Method in interface com.deliveredtechnologies.rulebook.Decision

The then method specifies the action taken if when() evaluates to true.

then(Function<FactMap<T>, RuleState>) - Method in interface com.deliveredtechnologies.rulebook.Rule

The then() method performs some action based on facts and returns a RuleState of either NEXT or BREAK.

then(Function<FactMap<T>, RuleState>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The then() method accepts a Function that performs an action based on Facts and then returns a RuleState of either NEXT or BREAK.

then(BiFunction<FactMap<T>, Result<U>, RuleState>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The then() method accepts a Function that performs an action based on Facts, optionally sets a Result, and then returns a RuleState of either NEXT or BREAK.

then(Function<FactMap<T>, RuleState>) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The then() method accepts a Function that performs an action based on Facts and then returns a RuleState of either NEXT or BREAK.

V

valueOf(String) - Static method in enum com.deliveredtechnologies.rulebook.RuleState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.deliveredtechnologies.rulebook.RuleState

Returns an array containing the constants of this enum type, in the order they are declared.

W

When - Annotation Type in com.deliveredtechnologies.rulebook.annotation

When marks a method as a condition.

when(Predicate<FactMap<T>>) - Method in interface com.deliveredtechnologies.rulebook.Rule

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

when(Predicate<FactMap<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision

The when() method accepts a Predicate that returns true or false based on Facts.

when(Predicate<FactMap<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardRule

The when() method accepts a Predicate that returns true or false based on Facts.

withDefaultResult(U) - Method in class com.deliveredtechnologies.rulebook.DecisionBook

The withDefaultResult method allows a default result value to be specified.

_

_facts - Variable in class com.deliveredtechnologies.rulebook.RuleBook

_headRule - Variable in class com.deliveredtechnologies.rulebook.RuleBook

_tailRule - Variable in class com.deliveredtechnologies.rulebook.RuleBook

A C D F G R S T V W _