agi.foundation.segmentpropagation

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

Enum TargetedSegmentListOperatorConvergenceBehavior

java.lang.Object

java.lang.Enum<TargetedSegmentListOperatorConvergenceBehavior>

agi.foundation.segmentpropagation.TargetedSegmentListOperatorConvergenceBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TargetedSegmentListOperatorConvergenceBehavior>

public enum TargetedSegmentListOperatorConvergenceBehavior
extends Enum<TargetedSegmentListOperatorConvergenceBehavior>
implements Enumeration

Allows the user to specify the behavior of the parent TargetedSegmentList when an operator finishes successfully.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RUN_OPERATORS_AND_SEGMENTS_AND_CONTINUE The default behavior, each operator will run to completion, run the list of segments a final time if they have not been run as part of the final operator, and propagation will continue.
RUN_OPERATORS_AND_SEGMENTS_AND_STOP This will run all of the operators, run the list of segments a final time if they have not been run as part of the final operator, but will prevent propagators after the TargetedSegmentList from propagating even if the operators converged.
STOP Stop indicates that when one operator converges, all operators should stop and the results should be returned to the user.

Method Summary

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

RUN_OPERATORS_AND_SEGMENTS_AND_CONTINUE

public static final TargetedSegmentListOperatorConvergenceBehavior RUN_OPERATORS_AND_SEGMENTS_AND_CONTINUE

The default behavior, each operator will run to completion, run the list of segments a final time if they have not been run as part of the final operator, and propagation will continue. Note that if the operators do not run the segments in the TargetedSegmentList, the segments will still be propagated once in the propagation of the TargetedSegmentList.

RUN_OPERATORS_AND_SEGMENTS_AND_STOP

public static final TargetedSegmentListOperatorConvergenceBehavior RUN_OPERATORS_AND_SEGMENTS_AND_STOP

This will run all of the operators, run the list of segments a final time if they have not been run as part of the final operator, but will prevent propagators after the TargetedSegmentList from propagating even if the operators converged. Note that if the operators do not run the segments in the TargetedSegmentList, the segments will be propagated.

STOP

public static final TargetedSegmentListOperatorConvergenceBehavior STOP

Stop indicates that when one operator converges, all operators should stop and the results should be returned to the user.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.