agi.foundation.segmentpropagation

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

Enum ReturnSegmentBehavior

java.lang.Object

java.lang.Enum<ReturnSegmentBehavior>

agi.foundation.segmentpropagation.ReturnSegmentBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ReturnSegmentBehavior>

public enum ReturnSegmentBehavior
extends Enum<ReturnSegmentBehavior>
implements Enumeration

The possible behaviors of a ReturnSegment's propagation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The ReturnSegment will not return to its ParentList (get / set).
DISABLED_ONLY_FOR_NOMINAL_RUNS The ReturnSegment will not return out of the ParentList (get / set) if NominalRun (get / set) is true.
ENABLED The ReturnSegment will return to the specified ParentList (get / set) it was configured to return to.
ENABLED_ONLY_FOR_NOMINAL_RUNS The ReturnSegment will return out of the ParentList (get / set) only for NominalRun (get / set) is true.

Method Summary

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

The ReturnSegment will return to the specified ParentList (get / set) it was configured to return to.

DISABLED

public static final ReturnSegmentBehavior DISABLED

The ReturnSegment will not return to its ParentList (get / set). The results of the ReturnSegment will still be logged, but no other action will occur.

ENABLED_ONLY_FOR_NOMINAL_RUNS

public static final ReturnSegmentBehavior ENABLED_ONLY_FOR_NOMINAL_RUNS

The ReturnSegment will return out of the ParentList (get / set) only for NominalRun (get / set) is true. Otherwise it will not return and propagation of the SegmentList will continue normally.

DISABLED_ONLY_FOR_NOMINAL_RUNS

public static final ReturnSegmentBehavior DISABLED_ONLY_FOR_NOMINAL_RUNS

The ReturnSegment will not return out of the ParentList (get / set) if NominalRun (get / set) is true. Otherwise it will return and propagation of the SegmentList will end.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.