Index (rulebook-core 0.4 API)

A C D E F G I K P R S T U 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.
ArrayUtils - Class in com.deliveredtechnologies.rulebook.util: ArrayUtils is a utility class for arrays.

C

clear() - Method in class com.deliveredtechnologies.rulebook.FactMap
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
combine(T[], T[]) - Static method in class com.deliveredtechnologies.rulebook.util.ArrayUtils: The combine() static method combines the contents of two arrays into a single array of the same type.
combine(T[], T[], int) - Static method in class com.deliveredtechnologies.rulebook.util.ArrayUtils: The combine() static method combines the contents of two arrays into a single array of the same type that contains no more than the maxElements number of elements.
containsKey(Object) - Method in class com.deliveredtechnologies.rulebook.FactMap
containsValue(Object) - Method in class com.deliveredtechnologies.rulebook.FactMap
create(Class<T>, Class) - 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

E

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

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(Map<String, Fact<T>>) - Constructor for class com.deliveredtechnologies.rulebook.FactMap
FactMap() - Constructor for class com.deliveredtechnologies.rulebook.FactMap

G

get(Object) - Method in class com.deliveredtechnologies.rulebook.FactMap
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.
The List is in order of closest parent => current obj methods, parent obj methods, etc.
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.
getDblVal(String) - Method in class com.deliveredtechnologies.rulebook.FactMap: Method getDblVal() gets the Double value of a Fact in the FactMap.
getFactMap() - Method in interface com.deliveredtechnologies.rulebook.Rule: The getFactMap() method gets the FactMap used for the current Rule.
getFactMap() - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
getFactMap() - Method in class com.deliveredtechnologies.rulebook.StandardDecision
getFactMap() - Method in class com.deliveredtechnologies.rulebook.StandardRule
getIntVal(String) - Method in class com.deliveredtechnologies.rulebook.FactMap: Method getIntVal() gets the Integer value of a Fact in the FactMap.
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.runner.RuleAdapter
getResult() - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The getResult() method gets the stored Result value from the execution of the StandardDecision.
getStrVal(String) - Method in class com.deliveredtechnologies.rulebook.FactMap: Method getStrVal() gets the String value of a Fact in the FactMap.
getThen() - Method in interface com.deliveredtechnologies.rulebook.Rule: Method getThen() gets the instance(s) of the functional interface(s) responsible for the action to be performed by the Rule.
getThen() - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
getThen() - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The getThen() method returns a List of Consumer objects that combined together in sequence represent the then() action(s).
getThen() - Method in class com.deliveredtechnologies.rulebook.StandardRule: The getThen() method returns a List of Consumer objects that combined together in sequence represent the then() action(s).
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: The getWhen() method returns the Predicate to be used for the condition of the Rule.
getWhen() - Method in class com.deliveredtechnologies.rulebook.StandardRule: The getWhen() method returns the Predicate to be used for the condition of the Rule.
Given - Annotation Type in com.deliveredtechnologies.rulebook.annotation: Given defines a field that is hydrated from a Fact.
given(String, T) - Method in interface com.deliveredtechnologies.rulebook.Decision
given(Fact<T>...) - Method in interface com.deliveredtechnologies.rulebook.Decision
given(List<Fact<T>>) - Method in interface com.deliveredtechnologies.rulebook.Decision
given(FactMap<T>) - Method in interface com.deliveredtechnologies.rulebook.Decision
given(String, 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 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(String, T) - Method in class com.deliveredtechnologies.rulebook.RuleBook: The given() method accepts a key/value pair as a Fact 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(String, Object) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
given(String, T) - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The given() method accepts a name/value pair to be used as a Fact.
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(String, T) - Method in class com.deliveredtechnologies.rulebook.StandardRule: The given() method accepts a name/value pair to be used as a Fact.
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.
givenUnTyped(FactMap) - Method in interface com.deliveredtechnologies.rulebook.Decision
givenUnTyped(FactMap) - Method in interface com.deliveredtechnologies.rulebook.Rule: The givenUnTyped method sets an untyped FactMap.
givenUnTyped(FactMap) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
givenUnTyped(FactMap) - Method in class com.deliveredtechnologies.rulebook.StandardDecision
givenUnTyped(FactMap) - Method in class com.deliveredtechnologies.rulebook.StandardRule

I

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

K

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

P

put(Fact<T>) - Method in class com.deliveredtechnologies.rulebook.FactMap: This put() method is a convenience method for adding a Fact to a FactMap.
It uses the name of the Fact as the key and the Fact as the value.
put(String, Fact<T>) - Method in class com.deliveredtechnologies.rulebook.FactMap
putAll(Map<? extends String, ? extends Fact<T>>) - Method in class com.deliveredtechnologies.rulebook.FactMap

R

remove(Object) - Method in class com.deliveredtechnologies.rulebook.FactMap
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
Result(T) - 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: 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, Rule) - Constructor for class com.deliveredtechnologies.rulebook.runner.RuleAdapter: RuleAdapter accepts a Rule annotated POJO and adapts it to a Rule or Decision.
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(Object...) - Method in interface com.deliveredtechnologies.rulebook.Rule: This run() method allows for arguments in addition to the FactMap to be passed to the action(s).
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(Object...) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
run(Object...) - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The run() method runs the Predicate supplied by the when() method.
If it evaluates to true then the BiConsumer(s) and Consumer(s) supplied by the then() method(s) are executed.
If the stop() method was invoked then no further rules are evaluated.
Otherwise, the next rule in the chain is evaluated.
run(Object...) - Method in class com.deliveredtechnologies.rulebook.StandardRule: The run(Object[]) 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) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
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) - Method in interface com.deliveredtechnologies.rulebook.Decision: The setResult() method initializes the stored result; useful for aggregation/chaining of a result.
setResult(Result) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
setResult(Result) - 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(String, T) - Method in class com.deliveredtechnologies.rulebook.FactMap: The method setValue sets the value of the Fact but its name.
If no Fact exists with the associated name, a new fact is created with the specified name and value.
setValue(T) - Method in class com.deliveredtechnologies.rulebook.Result: The method setValue() sets the object to be contained in the Result object.
size() - Method in class com.deliveredtechnologies.rulebook.FactMap
StandardDecision<T,U> - Class in com.deliveredtechnologies.rulebook: StandardDecision is the standard implementation of Decision.
StandardDecision(Class<T>, Class) - 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
StandardRule(Class<T>) - Constructor for class com.deliveredtechnologies.rulebook.StandardRule
stop() - Method in interface com.deliveredtechnologies.rulebook.Decision
stop() - Method in interface com.deliveredtechnologies.rulebook.Rule: Stops the rule chain after the then() method executes.
Note: this will only happen if the when() condition evaluates to true.
stop() - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
stop() - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The stop() method causes the rule chain to stop if the when() condition true and only after the then() actions have been executed.
stop() - Method in class com.deliveredtechnologies.rulebook.StandardRule: The stop() method causes the rule chain to stop if the when() condition true and only after the then() actions have been executed.

T

Then - Annotation Type in com.deliveredtechnologies.rulebook.annotation: Then marks a method as an action.
then(Consumer<FactMap<T>>) - Method in interface com.deliveredtechnologies.rulebook.Decision
then(BiConsumer<FactMap<T>, Result>) - Method in interface com.deliveredtechnologies.rulebook.Decision: The then method specifies the action taken if when() evaluates to true.
then(Consumer<FactMap<T>>) - Method in interface com.deliveredtechnologies.rulebook.Rule: The then() method performs some action based on facts.
This then() method does not imply a return value, only that the next chained then() is executed.
then(Consumer) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
then(BiConsumer) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
then(BiConsumer<FactMap<T>, Result>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The then() method accepts a BiConsumer that performs an action based on Facts.
The arguments of the BiConsumer are a FactMap and a Result, respectively.
then(Consumer<FactMap<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The then() method accepts a Consumer that performs an action based on Facts.
then(Consumer<FactMap<T>>) - Method in class com.deliveredtechnologies.rulebook.StandardRule: The then() method accepts a Consumer that performs an action based on Facts.
toString() - Method in class com.deliveredtechnologies.rulebook.Fact: The toString() method returns the toString of the object contained in the Fact.
toString() - Method in class com.deliveredtechnologies.rulebook.FactMap: The toString() method gets the FactMap converted a string.
If there is only one Fact, the String value is the String value of the Fact.
Otherwise, the String value is the value of the parent HashMap.

U

using(String...) - Method in interface com.deliveredtechnologies.rulebook.Decision
using(String...) - Method in interface com.deliveredtechnologies.rulebook.Rule: The using() method reduces the Facts used by the then() method to only the value of the Fact specified by the factName.
using(String...) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
using(String...) - Method in class com.deliveredtechnologies.rulebook.StandardDecision: The using() method reduces the facts to those specifically named here.
using(String...) - Method in class com.deliveredtechnologies.rulebook.StandardRule: The using() method reduces the facts to those specifically named here.

V

valueOf(String) - Static method in enum com.deliveredtechnologies.rulebook.RuleState: Returns the enum constant of this type with the specified name.
values() - Method in class com.deliveredtechnologies.rulebook.FactMap
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.Decision
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) - Method in class com.deliveredtechnologies.rulebook.runner.RuleAdapter
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 E F G I K P R S T U V W _