Package org.jeasy.rules.api

Class RulesEngineParameters

java.lang.Object

org.jeasy.rules.api.RulesEngineParameters

public class RulesEngineParameters
extends Object

Parameters of a rules engine.

• When parameters are used with a DefaultRulesEngine, they are applied on all registered rules.
• When parameters are used with a InferenceRulesEngine, they are applied on candidate rules in each iteration.

Author:

Mahmoud Ben Hassine ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_RULE_PRIORITY_THRESHOLD	Default rule priority threshold.

Constructor Summary

Constructors

Constructor	Description
RulesEngineParameters()	Create a new RulesEngineParameters with default values.
RulesEngineParameters(boolean skipOnFirstAppliedRule, boolean skipOnFirstFailedRule, boolean skipOnFirstNonTriggeredRule, int priorityThreshold, boolean failsOnException)	Create a new RulesEngineParameters.

Method Summary

Modifier and Type	Method	Description
RulesEngineParameters	failsOnException(boolean failsOnException)
int	getPriorityThreshold()
static boolean	hasOptionalParameterAnnotation(Class<?> methodAnnotation)
boolean	isFailsOnException()
boolean	isSkipOnFirstAppliedRule()
boolean	isSkipOnFirstFailedRule()
boolean	isSkipOnFirstNonTriggeredRule()
RulesEngineParameters	priorityThreshold(int priorityThreshold)
void	setFailsOnException(boolean failsOnException)
static void	setOptionalParameterAnnotation(Class<?> optionalParameterAnnotation)
void	setPriorityThreshold(int priorityThreshold)
void	setSkipOnFirstAppliedRule(boolean skipOnFirstAppliedRule)
void	setSkipOnFirstFailedRule(boolean skipOnFirstFailedRule)
void	setSkipOnFirstNonTriggeredRule(boolean skipOnFirstNonTriggeredRule)
RulesEngineParameters	skipOnFirstAppliedRule(boolean skipOnFirstAppliedRule)
RulesEngineParameters	skipOnFirstFailedRule(boolean skipOnFirstFailedRule)
RulesEngineParameters	skipOnFirstNonTriggeredRule(boolean skipOnFirstNonTriggeredRule)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_RULE_PRIORITY_THRESHOLD

public static final int DEFAULT_RULE_PRIORITY_THRESHOLD

Default rule priority threshold.

See Also:

• Constant Field Values

Constructor Details

RulesEngineParameters

public RulesEngineParameters()

Create a new RulesEngineParameters with default values.

RulesEngineParameters

public RulesEngineParameters(boolean skipOnFirstAppliedRule,
 boolean skipOnFirstFailedRule,
 boolean skipOnFirstNonTriggeredRule,
 int priorityThreshold,
 boolean failsOnException)

Create a new RulesEngineParameters.

Parameters:

skipOnFirstAppliedRule - parameter to skip next applicable rules on first applied rule.

skipOnFirstFailedRule - parameter to skip next applicable rules on first failed rule.

skipOnFirstNonTriggeredRule - parameter to skip next applicable rules on first non triggered rule.

priorityThreshold - threshold after which rules should be skipped.

Method Details

getPriorityThreshold

public int getPriorityThreshold()

setPriorityThreshold

public void setPriorityThreshold(int priorityThreshold)

priorityThreshold

public RulesEngineParameters priorityThreshold(int priorityThreshold)

isSkipOnFirstAppliedRule

public boolean isSkipOnFirstAppliedRule()

setSkipOnFirstAppliedRule

public void setSkipOnFirstAppliedRule(boolean skipOnFirstAppliedRule)

skipOnFirstAppliedRule

public RulesEngineParameters skipOnFirstAppliedRule(boolean skipOnFirstAppliedRule)

isSkipOnFirstNonTriggeredRule

public boolean isSkipOnFirstNonTriggeredRule()

setSkipOnFirstNonTriggeredRule

public void setSkipOnFirstNonTriggeredRule(boolean skipOnFirstNonTriggeredRule)

skipOnFirstNonTriggeredRule

public RulesEngineParameters skipOnFirstNonTriggeredRule(boolean skipOnFirstNonTriggeredRule)

isSkipOnFirstFailedRule

public boolean isSkipOnFirstFailedRule()

setSkipOnFirstFailedRule

public void setSkipOnFirstFailedRule(boolean skipOnFirstFailedRule)

isFailsOnException

public boolean isFailsOnException()

setFailsOnException

public void setFailsOnException(boolean failsOnException)

skipOnFirstFailedRule

public RulesEngineParameters skipOnFirstFailedRule(boolean skipOnFirstFailedRule)

failsOnException

public RulesEngineParameters failsOnException(boolean failsOnException)

hasOptionalParameterAnnotation

public static boolean hasOptionalParameterAnnotation(Class<?> methodAnnotation)

setOptionalParameterAnnotation

public static void setOptionalParameterAnnotation(Class<?> optionalParameterAnnotation)

toString

public String toString()

Overrides:

toString in class Object