agi.foundation.propagators

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

Enum SortingFormat

java.lang.Object

java.lang.Enum<SortingFormat>

agi.foundation.propagators.SortingFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SortingFormat>

public enum SortingFormat
extends Enum<SortingFormat>
implements Enumeration

An enumeration that defines the order in which entries in a NumericalPropagationStateHistory are sorted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORWARDS Entries which occur earlier chronologically have a lower index than entries which occur later.
REVERSE Entries which occur later chronologically have a lower index than entries which occur earlier.

Method Summary

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

FORWARDS

public static final SortingFormat FORWARDS

Entries which occur earlier chronologically have a lower index than entries which occur later.

REVERSE

public static final SortingFormat REVERSE

Entries which occur later chronologically have a lower index than entries which occur earlier.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.