Package co.elasticsearch.enterprisesearch.client.model

Enum Geolocation.Unit

java.lang.Object

java.lang.Enum<Geolocation.Unit>

co.elasticsearch.enterprisesearch.client.model.Geolocation.Unit

All Implemented Interfaces:

Serializable, Comparable<Geolocation.Unit>

Enclosing class:

Geolocation

public static enum Geolocation.Unit
extends Enum<Geolocation.Unit>

Represents a Geolocation Unit of measurement

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTIMETERS	Centimeters
FEET	Feet
INCHES	Inch
KILOMETERS	Kilometer
METERS	Meters
MILES	Mile
MILLIMETERS	Millimeters
YARDS	Yard

Method Summary

Modifier and Type	Method	Description
static Geolocation.Unit	findByValue(String value)	Find the Unit by value
String	getValue()	The facet value
static Geolocation.Unit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Geolocation.Unit[]	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

MILLIMETERS

public static final Geolocation.Unit MILLIMETERS

Millimeters

CENTIMETERS

public static final Geolocation.Unit CENTIMETERS

Centimeters

METERS

public static final Geolocation.Unit METERS

Meters

KILOMETERS

public static final Geolocation.Unit KILOMETERS

Kilometer

INCHES

public static final Geolocation.Unit INCHES

Inch

FEET

public static final Geolocation.Unit FEET

Feet

YARDS

public static final Geolocation.Unit YARDS

Yard

MILES

public static final Geolocation.Unit MILES

Mile

Method Detail

values

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

Returns:

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

valueOf

public static Geolocation.Unit 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

findByValue

public static Geolocation.Unit findByValue(String value)

Find the Unit by value

Parameters:

value - The value to lookup

Returns:

The Unit that matches the value, otherwise throw an exception

getValue

public String getValue()

The facet value

Returns:

The value value