ddf.measure

Enum Distance.LinearUnit

java.lang.Object

java.lang.Enum<Distance.LinearUnit>

ddf.measure.Distance.LinearUnit

All Implemented Interfaces:

Serializable, Comparable<Distance.LinearUnit>

Enclosing class:

Distance

public static enum Distance.LinearUnit
extends Enum<Distance.LinearUnit>

Enumeration for the linear units supported by DDF.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOOT_U_S
KILOMETER
METER
MILE
NAUTICAL_MILE
YARD

Method Summary

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

METER

public static final Distance.LinearUnit METER

KILOMETER

public static final Distance.LinearUnit KILOMETER

NAUTICAL_MILE

public static final Distance.LinearUnit NAUTICAL_MILE

MILE

public static final Distance.LinearUnit MILE

FOOT_U_S

public static final Distance.LinearUnit FOOT_U_S

YARD

public static final Distance.LinearUnit YARD

Method Detail

values

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

Returns:

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

valueOf

public static Distance.LinearUnit 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 Distance.LinearUnit fromString(String enumValueString)

Returns the Distance.LinearUnit enum constant corresponding to the string provided. It should be used as a replacement for the default valueOf() method.

This method supports all the string representations provided when the enum constants are created. As opposed to valueOf(), this method is case-insensitive and will for instance work with nauticalmile, NAUTICALMILE and nauticalMile.

Parameters:

enumValueString - string representing the enum constant to return. Cannot be null or empty.

Returns:

enum constant corresponding to the string representation provided

Throws:

IllegalArgumentException - thrown if the string provided doesn't map to any enum constant, is null or empty