agi.foundation

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

Enum BehaviorBeyondAvailability

java.lang.Object

java.lang.Enum<BehaviorBeyondAvailability>

agi.foundation.BehaviorBeyondAvailability

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BehaviorBeyondAvailability>

public enum BehaviorBeyondAvailability
extends Enum<BehaviorBeyondAvailability>
implements Enumeration

Defines the behavior when the evaluation time is beyond the availability for the object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTRAPOLATE Extrapolates values when evaluated beyond the object's availability.
RETURN_ENDPOINT_VALUE Returns the closest endpoint value when evaluated beyond the object's availability.
THROW_EXCEPTION Throws an exception when evaluated beyond the object's availability.

Method Summary

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

THROW_EXCEPTION

public static final BehaviorBeyondAvailability THROW_EXCEPTION

Throws an exception when evaluated beyond the object's availability.

RETURN_ENDPOINT_VALUE

public static final BehaviorBeyondAvailability RETURN_ENDPOINT_VALUE

Returns the closest endpoint value when evaluated beyond the object's availability.

EXTRAPOLATE

public static final BehaviorBeyondAvailability EXTRAPOLATE

Extrapolates values when evaluated beyond the object's availability.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.