Package com.couchbase.client.core.api.search.sort

Enum CoreSearchGeoDistanceUnits

java.lang.Object

java.lang.Enum<CoreSearchGeoDistanceUnits>

com.couchbase.client.core.api.search.sort.CoreSearchGeoDistanceUnits

All Implemented Interfaces:

Serializable, Comparable<CoreSearchGeoDistanceUnits>, java.lang.constant.Constable

@Internal
public enum CoreSearchGeoDistanceUnits
extends Enum<CoreSearchGeoDistanceUnits>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTIMETERS
FEET
INCH
KILOMETERS
METERS
MILES
MILLIMETERS
NAUTICAL_MILES
YARDS

Method Summary

Modifier and Type	Method	Description
String	identifier()
static CoreSearchGeoDistanceUnits	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CoreSearchGeoDistanceUnits[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

METERS

public static final CoreSearchGeoDistanceUnits METERS

MILES

public static final CoreSearchGeoDistanceUnits MILES

CENTIMETERS

public static final CoreSearchGeoDistanceUnits CENTIMETERS

MILLIMETERS

public static final CoreSearchGeoDistanceUnits MILLIMETERS

NAUTICAL_MILES

public static final CoreSearchGeoDistanceUnits NAUTICAL_MILES

KILOMETERS

public static final CoreSearchGeoDistanceUnits KILOMETERS

FEET

public static final CoreSearchGeoDistanceUnits FEET

YARDS

public static final CoreSearchGeoDistanceUnits YARDS

INCH

public static final CoreSearchGeoDistanceUnits INCH

Method Details

values

public static CoreSearchGeoDistanceUnits[] values()

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

Returns:

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

valueOf

public static CoreSearchGeoDistanceUnits 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()