Index

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractRulesEngine - Class in org.jeasy.rules.core

Base class for RulesEngine implementations.

Action - Interface in org.jeasy.rules.api

This interface represents a rule's action.

Action - Annotation Interface in org.jeasy.rules.annotation

Annotation to mark a method as a rule action.

add(Fact<T>) - Method in class org.jeasy.rules.api.Facts

Add a fact, replacing any fact with the same name.

afterEvaluate(Rule, Facts, boolean) - Method in interface org.jeasy.rules.api.RuleListener

Triggered after the evaluation of a rule.

afterExecute(Rules, Facts) - Method in interface org.jeasy.rules.api.RulesEngineListener

Triggered after executing the rule set When this listener is used with a InferenceRulesEngine, this method will be triggered after the execution of each candidate rule set in each iteration.

asMap() - Method in class org.jeasy.rules.api.Facts

Return a copy of the facts as a map.

asRule(Object) - Static method in class org.jeasy.rules.core.RuleProxy

Makes the rule object implement the Rule interface.

B

BasicRule - Class in org.jeasy.rules.core

Basic rule implementation class that provides common methods.

BasicRule() - Constructor for class org.jeasy.rules.core.BasicRule

Deprecated, for removal: This API element is subject to removal in a future version.

To avoid hardcoded rule name, Rule name should be unique

BasicRule(String) - Constructor for class org.jeasy.rules.core.BasicRule

Create a new BasicRule.

BasicRule(String, String) - Constructor for class org.jeasy.rules.core.BasicRule

Create a new BasicRule.

BasicRule(String, String, int) - Constructor for class org.jeasy.rules.core.BasicRule

Create a new BasicRule.

beforeEvaluate(Rule, Facts) - Method in interface org.jeasy.rules.api.RuleListener

Triggered before the evaluation of a rule.

beforeEvaluate(Rules, Facts) - Method in interface org.jeasy.rules.api.RulesEngineListener

Triggered before evaluating the rule set.

beforeExecute(Rule, Facts) - Method in interface org.jeasy.rules.api.RuleListener

Triggered before the execution of a rule.

build() - Method in class org.jeasy.rules.core.RuleBuilder

Create a new Rule.

C

check(Rules, Facts) - Method in interface org.jeasy.rules.api.RulesEngine

Check rules without firing them.

check(Rules, Facts) - Method in class org.jeasy.rules.core.DefaultRulesEngine

check(Rules, Facts) - Method in class org.jeasy.rules.core.InferenceRulesEngine

clear() - Method in class org.jeasy.rules.api.Facts

Clear facts.

clear() - Method in class org.jeasy.rules.api.Rules

Clear rules.

compareTo(Rule) - Method in class org.jeasy.rules.core.BasicRule

Condition - Interface in org.jeasy.rules.api

This interface represents a rule's condition.

Condition - Annotation Interface in org.jeasy.rules.annotation

Annotation to mark a method as a rule condition.

D

DEFAULT_DESCRIPTION - Static variable in interface org.jeasy.rules.api.Rule

Default rule description.

DEFAULT_NAME - Static variable in interface org.jeasy.rules.api.Rule

Default rule name.

DEFAULT_PRIORITY - Static variable in interface org.jeasy.rules.api.Rule

Default rule priority.

DEFAULT_RULE_PRIORITY_THRESHOLD - Static variable in class org.jeasy.rules.api.RulesEngineParameters

Default rule priority threshold.

DefaultRulesEngine - Class in org.jeasy.rules.core

Default RulesEngine implementation.

DefaultRulesEngine() - Constructor for class org.jeasy.rules.core.DefaultRulesEngine

Create a new DefaultRulesEngine with default parameters.

DefaultRulesEngine(RulesEngineParameters) - Constructor for class org.jeasy.rules.core.DefaultRulesEngine

Create a new DefaultRulesEngine.

description - Variable in class org.jeasy.rules.core.BasicRule

Rule description.

description - Variable in class org.jeasy.rules.core.FastRule

Rule description.

description() - Element in annotation interface org.jeasy.rules.annotation.Rule

The rule description.

description(String) - Method in class org.jeasy.rules.core.RuleBuilder

Set rule description.

E

equals(Object) - Method in class org.jeasy.rules.api.Fact

equals(Object) - Method in class org.jeasy.rules.core.BasicRule

evaluate(Facts) - Method in interface org.jeasy.rules.api.Condition

Evaluate the condition according to the known facts.

evaluate(Facts) - Method in interface org.jeasy.rules.api.Rule

This method implements the rule's condition(s).

evaluate(Facts) - Method in class org.jeasy.rules.core.BasicRule

This method implements the rule's condition(s).

evaluate(Facts) - Method in class org.jeasy.rules.core.FastRule

execute(Facts) - Method in interface org.jeasy.rules.api.Action

Execute the action when the rule's condition evaluates to true.

execute(Facts) - Method in interface org.jeasy.rules.api.Rule

This method implements the rule's action(s).

execute(Facts) - Method in class org.jeasy.rules.core.BasicRule

This method implements the rule's action(s).

execute(Facts) - Method in class org.jeasy.rules.core.FastRule

F

Fact<T> - Class in org.jeasy.rules.api

A class representing a named fact.

Fact - Annotation Interface in org.jeasy.rules.annotation

Annotation to mark a parameter as a fact.

Fact(String, T) - Constructor for class org.jeasy.rules.api.Fact

Create a new fact.

Facts - Class in org.jeasy.rules.api

This class encapsulates a set of facts and represents a facts namespace.

Facts() - Constructor for class org.jeasy.rules.api.Facts

failsOnException(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

FALSE - Static variable in interface org.jeasy.rules.api.Condition

A NoOp Condition that always returns false.

FastRule - Class in org.jeasy.rules.core

Basic rule implementation class that provides common methods.

FastRule(String) - Constructor for class org.jeasy.rules.core.FastRule

FastRule(String, String, int) - Constructor for class org.jeasy.rules.core.FastRule

fire(Rules, Facts) - Method in interface org.jeasy.rules.api.RulesEngine

Fire all registered rules on given facts.

fire(Rules, Facts) - Method in class org.jeasy.rules.core.DefaultRulesEngine

fire(Rules, Facts) - Method in class org.jeasy.rules.core.InferenceRulesEngine

G

get(String) - Method in class org.jeasy.rules.api.Facts

Get the value of a fact by its name.

getDescription() - Method in interface org.jeasy.rules.api.Rule

Getter for rule description.

getDescription() - Method in class org.jeasy.rules.core.BasicRule

getDescription() - Method in class org.jeasy.rules.core.FastRule

getFact(String) - Method in class org.jeasy.rules.api.Facts

Get a fact by name.

getName() - Method in class org.jeasy.rules.api.Fact

Get the fact name.

getName() - Method in interface org.jeasy.rules.api.Rule

Getter for rule name.

getName() - Method in class org.jeasy.rules.core.BasicRule

getName() - Method in class org.jeasy.rules.core.FastRule

getParameters() - Method in interface org.jeasy.rules.api.RulesEngine

Return the rules engine parameters.

getParameters() - Method in class org.jeasy.rules.core.AbstractRulesEngine

Return a copy of the rules engine parameters.

getPriority() - Method in interface org.jeasy.rules.api.Rule

Getter for rule priority.

getPriority() - Method in class org.jeasy.rules.core.BasicRule

getPriority() - Method in class org.jeasy.rules.core.FastRule

getPriorityThreshold() - Method in class org.jeasy.rules.api.RulesEngineParameters

getRuleListeners() - Method in interface org.jeasy.rules.api.RulesEngine

Return the list of registered rule listeners.

getRuleListeners() - Method in class org.jeasy.rules.core.AbstractRulesEngine

Return an unmodifiable list of the registered rule listeners.

getRulesEngineListeners() - Method in interface org.jeasy.rules.api.RulesEngine

Return the list of registered rules engine listeners.

getRulesEngineListeners() - Method in class org.jeasy.rules.core.AbstractRulesEngine

Return an unmodifiable list of the registered rules engine listeners

getTarget() - Method in class org.jeasy.rules.core.RuleProxy

getValue() - Method in class org.jeasy.rules.api.Fact

Get the fact value.

H

hashCode() - Method in class org.jeasy.rules.api.Fact

hashCode() - Method in class org.jeasy.rules.core.BasicRule

hasOptionalParameterAnnotation(Class<?>) - Static method in class org.jeasy.rules.api.RulesEngineParameters

I

InferenceRulesEngine - Class in org.jeasy.rules.core

Inference RulesEngine implementation.

InferenceRulesEngine() - Constructor for class org.jeasy.rules.core.InferenceRulesEngine

Create a new inference rules engine with default parameters.

InferenceRulesEngine(RulesEngineParameters) - Constructor for class org.jeasy.rules.core.InferenceRulesEngine

Create a new inference rules engine.

invoke(Object, Method, Object[]) - Method in class org.jeasy.rules.core.RuleProxy

isEmpty() - Method in class org.jeasy.rules.api.Rules

Check if the rule set is empty.

isFailsOnException() - Method in class org.jeasy.rules.api.RulesEngineParameters

isSkipOnFirstAppliedRule() - Method in class org.jeasy.rules.api.RulesEngineParameters

isSkipOnFirstFailedRule() - Method in class org.jeasy.rules.api.RulesEngineParameters

isSkipOnFirstNonTriggeredRule() - Method in class org.jeasy.rules.api.RulesEngineParameters

iterator() - Method in class org.jeasy.rules.api.Facts

Return an iterator on the set of facts.

iterator() - Method in class org.jeasy.rules.api.Rules

Return an iterator on the rules set.

N

name - Variable in class org.jeasy.rules.core.BasicRule

Rule name.

name - Variable in class org.jeasy.rules.core.FastRule

Rule name.

name() - Element in annotation interface org.jeasy.rules.annotation.Rule

The rule name which must be unique within a rules registry.

name(String) - Method in class org.jeasy.rules.core.RuleBuilder

Set rule name.

O

onEvaluationError(Rule, Facts, Exception) - Method in interface org.jeasy.rules.api.RuleListener

Triggered on condition evaluation error due to any runtime exception.

onFailure(Rule, Facts, Exception) - Method in interface org.jeasy.rules.api.RuleListener

Triggered after a rule has failed.

onSuccess(Rule, Facts) - Method in interface org.jeasy.rules.api.RuleListener

Triggered after a rule has been executed successfully.

order() - Element in annotation interface org.jeasy.rules.annotation.Action

The order in which the action should be executed.

org.jeasy.rules.annotation - package org.jeasy.rules.annotation

This package contains Easy Rules annotations.

org.jeasy.rules.api - package org.jeasy.rules.api

This package contains Easy Rules public API.

org.jeasy.rules.core - package org.jeasy.rules.core

This package contains Easy Rules core implementation.

P

priority - Variable in class org.jeasy.rules.core.BasicRule

Rule priority.

priority - Variable in class org.jeasy.rules.core.FastRule

Rule priority.

priority() - Element in annotation interface org.jeasy.rules.annotation.Rule

The rule priority.

priority(int) - Method in class org.jeasy.rules.core.RuleBuilder

Set rule priority.

Priority - Annotation Interface in org.jeasy.rules.annotation

Annotation to mark the method to execute to get rule priority.

priorityThreshold(int) - Method in class org.jeasy.rules.api.RulesEngineParameters

put(String, T) - Method in class org.jeasy.rules.api.Facts

Add a fact, replacing any fact with the same name.

R

register(Object...) - Method in class org.jeasy.rules.api.Rules

Register one or more new rules.

register(Rule...) - Method in class org.jeasy.rules.api.Rules

registerRuleListener(RuleListener) - Method in class org.jeasy.rules.core.AbstractRulesEngine

registerRuleListener(RuleListener) - Method in class org.jeasy.rules.core.InferenceRulesEngine

Register a rule listener.

registerRuleListeners(List<RuleListener>) - Method in class org.jeasy.rules.core.AbstractRulesEngine

registerRuleListeners(List<RuleListener>) - Method in class org.jeasy.rules.core.InferenceRulesEngine

Register a list of rule listener.

registerRulesEngineListener(RulesEngineListener) - Method in class org.jeasy.rules.core.AbstractRulesEngine

registerRulesEngineListener(RulesEngineListener) - Method in class org.jeasy.rules.core.InferenceRulesEngine

Register a rules engine listener.

registerRulesEngineListeners(List<RulesEngineListener>) - Method in class org.jeasy.rules.core.AbstractRulesEngine

registerRulesEngineListeners(List<RulesEngineListener>) - Method in class org.jeasy.rules.core.InferenceRulesEngine

Register a list of rules engine listener.

remove(String) - Method in class org.jeasy.rules.api.Facts

Remove a fact by name.

remove(Fact<T>) - Method in class org.jeasy.rules.api.Facts

Remove a fact.

Rule - Interface in org.jeasy.rules.api

Abstraction for a rule that can be fired by a rules engine.

Rule - Annotation Interface in org.jeasy.rules.annotation

Annotation to mark a class as a rule.

RuleBuilder - Class in org.jeasy.rules.core

Builder to create Rule instances.

RuleBuilder() - Constructor for class org.jeasy.rules.core.RuleBuilder

RuleListener - Interface in org.jeasy.rules.api

A listener for rule execution events.

RuleProxy - Class in org.jeasy.rules.core

Main class to create rule proxies from annotated objects.

Rules - Class in org.jeasy.rules.api

This class encapsulates a set of rules and represents a rules namespace.

Rules(Object...) - Constructor for class org.jeasy.rules.api.Rules

Create a new Rules object.

Rules(Set<Rule>) - Constructor for class org.jeasy.rules.api.Rules

Create a new Rules object.

Rules(Rule...) - Constructor for class org.jeasy.rules.api.Rules

Create a new Rules object.

RulesEngine - Interface in org.jeasy.rules.api

Rules engine interface.

RulesEngineListener - Interface in org.jeasy.rules.api

A listener for rules engine execution events.

RulesEngineParameters - Class in org.jeasy.rules.api

Parameters of a rules engine.

RulesEngineParameters() - Constructor for class org.jeasy.rules.api.RulesEngineParameters

Create a new RulesEngineParameters with default values.

RulesEngineParameters(boolean, boolean, boolean, int, boolean) - Constructor for class org.jeasy.rules.api.RulesEngineParameters

Create a new RulesEngineParameters.

S

setDescription(String) - Method in class org.jeasy.rules.core.BasicRule

setFailsOnException(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

setOptionalParameterAnnotation(Class<?>) - Static method in class org.jeasy.rules.api.RulesEngineParameters

setPriority(int) - Method in class org.jeasy.rules.core.BasicRule

setPriorityThreshold(int) - Method in class org.jeasy.rules.api.RulesEngineParameters

setSkipOnFirstAppliedRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

setSkipOnFirstFailedRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

setSkipOnFirstNonTriggeredRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

size() - Method in class org.jeasy.rules.api.Rules

Return how many rules are currently registered.

skipOnFirstAppliedRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

skipOnFirstFailedRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

skipOnFirstNonTriggeredRule(boolean) - Method in class org.jeasy.rules.api.RulesEngineParameters

T

then(Action) - Method in class org.jeasy.rules.core.RuleBuilder

Add an action to the rule.

then(Facts) - Method in class org.jeasy.rules.core.FastRule

toString() - Method in class org.jeasy.rules.api.Fact

toString() - Method in class org.jeasy.rules.api.Facts

toString() - Method in class org.jeasy.rules.api.RulesEngineParameters

toString() - Method in class org.jeasy.rules.core.BasicRule

TRUE - Static variable in interface org.jeasy.rules.api.Condition

A NoOp Condition that always returns true.

U

unregister(Object...) - Method in class org.jeasy.rules.api.Rules

Unregister one or more rules.

unregister(String) - Method in class org.jeasy.rules.api.Rules

Unregister a rule by name.

unregister(Rules...) - Method in class org.jeasy.rules.api.Rules

V

value() - Element in annotation interface org.jeasy.rules.annotation.Fact

W

when(Condition) - Method in class org.jeasy.rules.core.RuleBuilder

Set rule condition.

when(Facts) - Method in class org.jeasy.rules.core.FastRule

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values