Package com.couchbase.client.java.search.sort

Enum SearchGeoDistanceUnits

java.lang.Object

java.lang.Enum<SearchGeoDistanceUnits>

com.couchbase.client.java.search.sort.SearchGeoDistanceUnits

All Implemented Interfaces:

Serializable, Comparable<SearchGeoDistanceUnits>

public enum SearchGeoDistanceUnits
extends Enum<SearchGeoDistanceUnits>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Centimeters
Feet
Inch
Kilometers
Meters
Miles
Millimeters
NauticalMiles
Yards

Method Summary

Modifier and Type	Method	Description
String	identifier()
CoreSearchGeoDistanceUnits	toCore()
static SearchGeoDistanceUnits	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchGeoDistanceUnits[]	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 SearchGeoDistanceUnits Meters

Miles

public static final SearchGeoDistanceUnits Miles

Centimeters

public static final SearchGeoDistanceUnits Centimeters

Millimeters

public static final SearchGeoDistanceUnits Millimeters

NauticalMiles

public static final SearchGeoDistanceUnits NauticalMiles

Kilometers

public static final SearchGeoDistanceUnits Kilometers

Feet

public static final SearchGeoDistanceUnits Feet

Yards

public static final SearchGeoDistanceUnits Yards

Inch

public static final SearchGeoDistanceUnits Inch

Method Detail

values

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

Returns:

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

valueOf

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

identifier

public String identifier()

toCore

@Internal
public CoreSearchGeoDistanceUnits toCore()