StandardRule (rulebook-core 0.3.2 API)

java.lang.Object
- com.deliveredtechnologies.rulebook.StandardRule<T>

All Implemented Interfaces:

Rule<T>
```
public class StandardRule<T>
extends java.lang.Object
implements Rule<T>
```
StandardRule is a standard rule implementation that can be used with a RuleBook.

Constructor Summary

Constructors
Constructor and Description

StandardRule()

Constructors
Constructor and Description
`StandardRule()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StandardRule<java.lang.Object>`	`create()` This create() method is a convenience method to create a non-type specific StandardRule.
`static <T> StandardRule<T>`	`create(java.lang.Class<T> factType)` This create() method is a convenience method to avoid using new and generic syntax.
`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 accepts Facts to be evaluated in the Rule.
`Rule<T>`	`given(FactMap<T> facts)` The given() method accepts Facts to be evaluated in the Rule.
`Rule<T>`	`given(java.util.List<Fact<T>> facts)` The given() method accepts Facts to be evaluated in the Rule.
`void`	`run()` The run() method runs the `Predicate` supplied by the when() method.
`void`	`setNextRule(Rule<T> rule)` The setNextRule() method sets the next Rule in the chain.
`Rule<T>`	`then(java.util.function.Function<FactMap<T>,RuleState> action)` The then() method accepts a `Function` that performs an action based on Facts and then returns a `RuleState` of either NEXT or BREAK.
`Rule<T>`	`when(java.util.function.Predicate<FactMap<T>> test)` The when() method accepts a `Predicate` that returns true or false based on Facts.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StandardRule
```
public StandardRule()
```
- Method Detail
  - create
```
public static <T> StandardRule<T> create(java.lang.Class<T> factType)
```
    This create() method is a convenience method to avoid using new and generic syntax.
    
    Type Parameters:
    
    T - the type of Fact
    
    Parameters:
    
    factType - the type of object stored in facts for this Rule
    
    Returns:
    
    a new instance of a StandardRule
  - create
```
public static StandardRule<java.lang.Object> create()
```
    This create() method is a convenience method to create a non-type specific StandardRule.
    
    Returns:
    
    a new instance of a StandardRule
  - run
```
public void run()
```
    The run() method runs the Predicate supplied by the when() method. If it evaluates to true then the Function supplied by the then() method is executed. If the then() method returns a BREAK RuleState then no further rules are evaluated. Otherwise, the next rule in the chain is evaluated.
    
    Specified by:
    
    run in interface Rule<T>
  - given
```
public Rule<T> given(Fact<T>... facts)
```
    The given() method accepts Facts to be evaluated in the Rule.
    
    Specified by:
    
    given in interface Rule<T>
    
    Parameters:
    
    facts - Facts to be used by the Rule
    
    Returns:
    
    the current object
  - given
```
public Rule<T> given(java.util.List<Fact<T>> facts)
```
    The given() method accepts Facts to be evaluated in the Rule.
    
    Specified by:
    
    given in interface Rule<T>
    
    Parameters:
    
    facts - a List of Facts to be used by the Rule
    
    Returns:
    
    the current object
  - given
```
public Rule<T> given(FactMap<T> facts)
```
    The given() method accepts Facts to be evaluated in the Rule.
    
    Specified by:
    
    given in interface Rule<T>
    
    Parameters:
    
    facts - a FactMap
    
    Returns:
    
    the current object
  - when
```
public Rule<T> when(java.util.function.Predicate<FactMap<T>> test)
```
    The when() method accepts a Predicate that returns true or false based on Facts.
    
    Specified by:
    
    when in interface Rule<T>
    
    Parameters:
    
    test - the condition(s) to be evaluated against the Facts
    
    Returns:
    
    the current object
  - then
```
public Rule<T> then(java.util.function.Function<FactMap<T>,RuleState> action)
```
    The then() method accepts a Function that performs an action based on Facts and then returns a RuleState of either NEXT or BREAK.
    
    Specified by:
    
    then in interface Rule<T>
    
    Parameters:
    
    action - the action to be performed
    
    Returns:
    
    the current object
  - setNextRule
```
public void setNextRule(Rule<T> rule)
```
    The setNextRule() method sets the next Rule in the chain.
    
    Specified by:
    
    setNextRule in interface Rule<T>
    
    Parameters:
    
    rule - the next Rule to add to the chain
  - getWhen
```
public java.util.function.Predicate<FactMap<T>> getWhen()
```
    Description copied from interface: Rule
    
    Method getWhen() gets the Predicate that evaluates the condition of the Rule.
    
    Specified by:
    
    getWhen in interface Rule<T>
    
    Returns:
    
    a Predicate object
  - getThen
```
public java.lang.Object getThen()
```
    Description copied from interface: Rule
    
    Method getThen() gets an instance of a functional interface responsbile for the action to be performed by the Rule.
    
    Specified by:
    
    getThen in interface Rule<T>
    
    Returns:
    
    a functional interface Object

Class StandardRule<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StandardRule

Method Detail

create

create

run

given

given

given

when

then

setNextRule

getWhen

getThen