agi.foundation.stoppingconditions

(agi.foundation.models-2024r3.jar)

Enum StoppingConditionEnabled

java.lang.Object

java.lang.Enum<StoppingConditionEnabled>

agi.foundation.stoppingconditions.StoppingConditionEnabled

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StoppingConditionEnabled>

public enum StoppingConditionEnabled
extends Enum<StoppingConditionEnabled>
implements Enumeration

Settings for enabling or disabling a StoppingCondition.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The StoppingCondition is completely disabled and events will not be found.
DISABLED_BUT_STILL_FIND_EVENTS The StoppingCondition will not stop propagation, but events will still be found and logged.
ENABLED The StoppingCondition is enabled and events will be found normally.

Method Summary

Modifier and Type	Method and Description
static StoppingConditionEnabled	getDefault() Get the enum constant that is considered to be the default.
static StoppingConditionEnabled	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static StoppingConditionEnabled	valueOf(String name) Returns the enum constant of this type with the specified name.
static StoppingConditionEnabled[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENABLED

public static final StoppingConditionEnabled ENABLED

The StoppingCondition is enabled and events will be found normally.

DISABLED_BUT_STILL_FIND_EVENTS

public static final StoppingConditionEnabled DISABLED_BUT_STILL_FIND_EVENTS

The StoppingCondition will not stop propagation, but events will still be found and logged.

DISABLED

public static final StoppingConditionEnabled DISABLED

The StoppingCondition is completely disabled and events will not be found.

Method Detail

values

public static StoppingConditionEnabled[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StoppingConditionEnabled c : StoppingConditionEnabled.values())
    System.out.println(c);

Returns:

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

valueOf

public static StoppingConditionEnabled valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StoppingConditionEnabled getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static StoppingConditionEnabled getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.