agi.foundation.propagators

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

Enum PropagationEventIndication

java.lang.Object

java.lang.Enum<PropagationEventIndication>

agi.foundation.propagators.PropagationEventIndication

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PropagationEventIndication>

public enum PropagationEventIndication
extends Enum<PropagationEventIndication>
implements Enumeration

An indication of how the propagator should proceed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE_PROPAGATION Continue the current propagation.
STOP_PROPAGATION_AFTER_STEP Stop the propagation after the current step.

Method Summary

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

CONTINUE_PROPAGATION

public static final PropagationEventIndication CONTINUE_PROPAGATION

Continue the current propagation.

STOP_PROPAGATION_AFTER_STEP

public static final PropagationEventIndication STOP_PROPAGATION_AFTER_STEP

Stop the propagation after the current step.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.