agi.foundation.stoppingconditions

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

Enum StoppingConditionTriggeredBehavior

java.lang.Object

java.lang.Enum<StoppingConditionTriggeredBehavior>

agi.foundation.stoppingconditions.StoppingConditionTriggeredBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StoppingConditionTriggeredBehavior>

public enum StoppingConditionTriggeredBehavior
extends Enum<StoppingConditionTriggeredBehavior>
implements Enumeration

Describes how propagation should behave after a stopping condition has been satisfied. This allows the code handing the SatisfiedCallback (get / set) event to control how or if propagation will continue.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE_AND_RESET_COUNTER Continues propagation until the next time a stopping condition is triggered and it resets the iteration counter.
CONTINUE_TO_NEXT_EVENT Continues propagation until the next time a stopping condition is triggered.
DEFAULT_BEHAVIOR If this was the last event to be found by this condition then let propagation stop.
STOP_FUNCTION Stops propagation of the function.

Method Summary

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

STOP_FUNCTION

public static final StoppingConditionTriggeredBehavior STOP_FUNCTION

Stops propagation of the function. This is the default behavior.

CONTINUE_TO_NEXT_EVENT

public static final StoppingConditionTriggeredBehavior CONTINUE_TO_NEXT_EVENT

Continues propagation until the next time a stopping condition is triggered.

CONTINUE_AND_RESET_COUNTER

public static final StoppingConditionTriggeredBehavior CONTINUE_AND_RESET_COUNTER

Continues propagation until the next time a stopping condition is triggered and it resets the iteration counter.

DEFAULT_BEHAVIOR

public static final StoppingConditionTriggeredBehavior DEFAULT_BEHAVIOR

If this was the last event to be found by this condition then let propagation stop. Otherwise proceed to the next event normally.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.