org.apache.lucene.spatial.geometry
Enum DistanceUnits

java.lang.Object
  java.lang.Enum<DistanceUnits>
      org.apache.lucene.spatial.geometry.DistanceUnits

All Implemented Interfaces:

Serializable, Comparable<DistanceUnits>

public enum DistanceUnits
extends Enum<DistanceUnits>

NOTE: This API is still in flux and might change in incompatible ways in the next release.

Enum Constant Summary

KILOMETERS

MILES

Method Summary

static DistanceUnits	valueOf(String name) Returns the enum constant of this type with the specified name.
static DistanceUnits[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MILES

public static final DistanceUnits MILES

KILOMETERS

public static final DistanceUnits KILOMETERS

Method Detail

values

public static final DistanceUnits[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(DistanceUnits c : DistanceUnits.values())
        System.out.println(c);

Returns:

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

valueOf

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