agi.foundation.coordinates

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

Enum PoleIndicator

java.lang.Object

java.lang.Enum<PoleIndicator>

agi.foundation.coordinates.PoleIndicator

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PoleIndicator>

public enum PoleIndicator
extends Enum<PoleIndicator>
implements Enumeration

Specifies one of the two geographical poles, or neither.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEITHER Indicates neither pole.
NORTH Indicates the northern pole.
SOUTH Indicates the southern pole.

Method Summary

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

SOUTH

public static final PoleIndicator SOUTH

Indicates the southern pole.

NEITHER

public static final PoleIndicator NEITHER

Indicates neither pole.

NORTH

public static final PoleIndicator NORTH

Indicates the northern pole.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.