Module io.github.brantunger.unruly.core

Package io.github.brantunger.unruly.api

Enum Class RuleEvaluation.Outcome

java.lang.Object

java.lang.Enum<RuleEvaluation.Outcome>

io.github.brantunger.unruly.api.RuleEvaluation.Outcome

All Implemented Interfaces:

Serializable, Comparable<RuleEvaluation.Outcome>, Constable

Enclosing class:

RuleEvaluation

public static enum RuleEvaluation.Outcome
extends Enum<RuleEvaluation.Outcome>

What evaluating a rule's condition found, or that the run skipped the rule. A run that fails throws, so there is no outcome for a failure.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATCHED	The condition was true.
NOT_EVALUATED	The condition wasn't evaluated: the rule comes after the match on a first-match engine, so it's neither matched nor unmatched.
NOT_MATCHED	The condition was false.
SKIPPED	The run skipped the rule without evaluating its condition: the rule is disabled, outside its validity window when the run started, or carries none of the tags the run was given.

Method Summary

Modifier and Type	Method	Description
static RuleEvaluation.Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RuleEvaluation.Outcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MATCHED

public static final RuleEvaluation.Outcome MATCHED

The condition was true. On every engine, a matched rule is one that fired, unless the run failed.

NOT_MATCHED

public static final RuleEvaluation.Outcome NOT_MATCHED

The condition was false.

NOT_EVALUATED

public static final RuleEvaluation.Outcome NOT_EVALUATED

The condition wasn't evaluated: the rule comes after the match on a first-match engine, so it's neither matched nor unmatched.

SKIPPED

public static final RuleEvaluation.Outcome SKIPPED

The run skipped the rule without evaluating its condition: the rule is disabled, outside its validity window when the run started, or carries none of the tags the run was given. A skipped rule is reported as skipped wherever it is in the list, including after the match on a first-match engine.

Method Details

values

public static RuleEvaluation.Outcome[] values()

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

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RuleEvaluation.Outcome valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null