org.opengis.cite.kml2

Enum AltitudeMode

java.lang.Object

java.lang.Enum<AltitudeMode>

org.opengis.cite.kml2.AltitudeMode

All Implemented Interfaces:

Serializable, Comparable<AltitudeMode>

public enum AltitudeMode
extends Enum<AltitudeMode>

An enum type that specifies how the altitude components are interpreted in kml:coordinates, kml:coord and kml:altitude elements. The allowed values are declared by the schema component kml:AltitudeModeGroup; the default value is "clampToGround".

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE
CLAMP_TO_GROUND
CLAMP_TO_SEAFLOOR
RELATIVE_TO_GROUND
RELATIVE_TO_SEAFLOOR

Method Summary

Modifier and Type	Method and Description
static AltitudeMode	fromString(String value) Returns the AltitudeMode constant corresponding to the given string value.
static AltitudeMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AltitudeMode[]	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

CLAMP_TO_GROUND

public static final AltitudeMode CLAMP_TO_GROUND

RELATIVE_TO_GROUND

public static final AltitudeMode RELATIVE_TO_GROUND

ABSOLUTE

public static final AltitudeMode ABSOLUTE

CLAMP_TO_SEAFLOOR

public static final AltitudeMode CLAMP_TO_SEAFLOOR

RELATIVE_TO_SEAFLOOR

public static final AltitudeMode RELATIVE_TO_SEAFLOOR

Method Detail

values

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

Returns:

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

valueOf

public static AltitudeMode 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

fromString

public static AltitudeMode fromString(String value)

Returns the AltitudeMode constant corresponding to the given string value.

Parameters:

value - A String specifying an altitude mode.

Returns:

The AltitudeMode constant corresponding to the given value, or null if there is no match.