agi.foundation.numericalmethods

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

Enum EndsOfSegment

java.lang.Object

java.lang.Enum<EndsOfSegment>

agi.foundation.numericalmethods.EndsOfSegment

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EndsOfSegment>

public enum EndsOfSegment
extends Enum<EndsOfSegment>
implements Enumeration

Specifies if the initial state or final state of a segment should be considered. Note that initial and final mean the initial point that propagation started from and the final point propagated, not initial and final in a time sense.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINAL The final state of a segment.
INITIAL The initial state of a segment.

Method Summary

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

INITIAL

public static final EndsOfSegment INITIAL

The initial state of a segment.

FINAL

public static final EndsOfSegment FINAL

The final state of a segment.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.