org.springframework.data.redis.connection

Enum RedisGeoCommands.DistanceUnit

java.lang.Object

java.lang.Enum<RedisGeoCommands.DistanceUnit>

org.springframework.data.redis.connection.RedisGeoCommands.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<RedisGeoCommands.DistanceUnit>, Metric

Enclosing interface:

RedisGeoCommands

public static enum RedisGeoCommands.DistanceUnit
extends Enum<RedisGeoCommands.DistanceUnit>
implements Metric

Metrics supported by Redis.

Since:

1.8

Author:

Christoph Strobl

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEET
KILOMETERS
METERS
MILES

Method Summary

Modifier and Type	Method and Description
String	getAbbreviation()
double	getMultiplier()
static RedisGeoCommands.DistanceUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static RedisGeoCommands.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 RedisGeoCommands.DistanceUnit METERS

KILOMETERS

public static final RedisGeoCommands.DistanceUnit KILOMETERS

MILES

public static final RedisGeoCommands.DistanceUnit MILES

FEET

public static final RedisGeoCommands.DistanceUnit FEET

Method Detail

values

public static RedisGeoCommands.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 (RedisGeoCommands.DistanceUnit c : RedisGeoCommands.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 RedisGeoCommands.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

getMultiplier

public double getMultiplier()

Specified by:

getMultiplier in interface Metric

getAbbreviation

public String getAbbreviation()

Specified by:

getAbbreviation in interface Metric