Package org.hibernate.search.engine.spatial

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

org.hibernate.search.engine.spatial.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<DistanceUnit>

public enum DistanceUnit
extends Enum<DistanceUnit>

Distance units.

Enum Constant Summary

Enum Constants

Enum Constant	Description
KILOMETERS
METERS
MILES
NAUTICAL_MILES
YARDS

Method Summary

Modifier and Type	Method	Description
Double	fromMeters(Double distanceInMeters)
double	toMeters(double distance)
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

METERS

public static final DistanceUnit METERS

KILOMETERS

public static final DistanceUnit KILOMETERS

MILES

public static final DistanceUnit MILES

YARDS

public static final DistanceUnit YARDS

NAUTICAL_MILES

public static final DistanceUnit NAUTICAL_MILES

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

toMeters

public double toMeters(double distance)

fromMeters

public Double fromMeters(Double distanceInMeters)