agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r2.jar)

Enum ChangeStoppingConditionOption

java.lang.Object

java.lang.Enum<ChangeStoppingConditionOption>

agi.foundation.segmentpropagation.ChangeStoppingConditionOption

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ChangeStoppingConditionOption>

public enum ChangeStoppingConditionOption
extends Enum<ChangeStoppingConditionOption>
implements Enumeration

The options for enabling or disabling a StoppingCondition for the ChangeStoppingConditionEnabledOperator

Enum Constant Summary

Enum Constants

Enum Constant and Description
SET_TO_DISABLE_BUT_STILL_FIND_EVENTS Set the Enabled (get / set) to StoppingConditionEnabled.DISABLED_BUT_STILL_FIND_EVENTS.
SET_TO_DISABLED Set the Enabled (get / set) to StoppingConditionEnabled.DISABLED.
SET_TO_ENABLED Set the Enabled (get / set) to StoppingConditionEnabled.ENABLED.
TOGGLE Set the Enabled (get / set) to StoppingConditionEnabled.ENABLED if it is currently one of the disabled options, or to StoppingConditionEnabled.DISABLED if it is currently StoppingConditionEnabled.ENABLED.

Method Summary

Modifier and Type	Method and Description
static ChangeStoppingConditionOption	getDefault() Get the enum constant that is considered to be the default.
static ChangeStoppingConditionOption	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 ChangeStoppingConditionOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChangeStoppingConditionOption[]	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

SET_TO_ENABLED

public static final ChangeStoppingConditionOption SET_TO_ENABLED

Set the Enabled (get / set) to StoppingConditionEnabled.ENABLED.

SET_TO_DISABLED

public static final ChangeStoppingConditionOption SET_TO_DISABLED

Set the Enabled (get / set) to StoppingConditionEnabled.DISABLED.

SET_TO_DISABLE_BUT_STILL_FIND_EVENTS

public static final ChangeStoppingConditionOption SET_TO_DISABLE_BUT_STILL_FIND_EVENTS

Set the Enabled (get / set) to StoppingConditionEnabled.DISABLED_BUT_STILL_FIND_EVENTS.

TOGGLE

public static final ChangeStoppingConditionOption TOGGLE

Set the Enabled (get / set) to StoppingConditionEnabled.ENABLED if it is currently one of the disabled options, or to StoppingConditionEnabled.DISABLED if it is currently StoppingConditionEnabled.ENABLED.

Method Detail

values

public static ChangeStoppingConditionOption[] 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 (ChangeStoppingConditionOption c : ChangeStoppingConditionOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChangeStoppingConditionOption 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 ChangeStoppingConditionOption 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 ChangeStoppingConditionOption getDefault()

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

Returns:

The default enum constant.