com.mapinfo.geocode.api

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

com.mapinfo.geocode.api.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<DistanceUnit>

public enum DistanceUnit
extends Enum<DistanceUnit>
implements Serializable

This enumeration allows you to specify units associated with a distance or offset.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEET English units of feet.
KILOMETERS Metric units of kilometers.
METERS Metric units of meters.
MILES English units of miles.

Method Summary

Modifier and Type	Method and Description
static DistanceUnit	fromValue(String v) This attempts to convert the string into a DistanceUnit.
static DistanceUnit	fromValueWithDefault(String v) This attempts to convert the string into a DistanceUnit.
com.mapinfo.midev.unit.LinearUnit	getLinearUnit() Returns the LinearUnit equivalent to this DistanceUnit.
String	value() Returns the string representing the type of unit
static DistanceUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DistanceUnit[]	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

FEET

public static final DistanceUnit FEET

English units of feet.

METERS

public static final DistanceUnit METERS

Metric units of meters. This is the default unit.

MILES

public static final DistanceUnit MILES

English units of miles.

KILOMETERS

public static final DistanceUnit KILOMETERS

Metric units of kilometers.

Method Detail

values

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

Returns:

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

valueOf

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

fromValue

public static DistanceUnit fromValue(String v)

This attempts to convert the string into a DistanceUnit. Throws an IllegalArgumentException if the string cannot be converted. The lookup is not case-sensitive.

Parameters:

v - represents the unit type

Returns:

a DistanceUnit object

fromValueWithDefault

public static DistanceUnit fromValueWithDefault(String v)

This attempts to convert the string into a DistanceUnit. Returns the default of DistanceUnit.METERS if the string cannot be converted. The lookup is not case-sensitive.

Parameters:

v - represents the unit type

Returns:

a DistanceUnit object

value

public String value()

Returns the string representing the type of unit

Returns:

the type of unit

getLinearUnit

public com.mapinfo.midev.unit.LinearUnit getLinearUnit()

Returns the LinearUnit equivalent to this DistanceUnit.

Returns:

the LinearUnit equivalent to this DistanceUnit