org.springframework.data.mongodb.core.geo
Enum Metrics
java.lang.Object
java.lang.Enum<Metrics>
org.springframework.data.mongodb.core.geo.Metrics
- All Implemented Interfaces:
- Serializable, Comparable<Metrics>, Metric
public enum Metrics
- extends Enum<Metrics>
- implements Metric
Commonly used Metrics
for NearQuery
s.
- Author:
- Oliver Gierke
Method Summary |
double |
getMultiplier()
Returns the multiplier to calculate metrics values from a base scale. |
static Metrics |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Metrics[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared. |
KILOMETERS
public static final Metrics KILOMETERS
MILES
public static final Metrics MILES
NEUTRAL
public static final Metrics NEUTRAL
values
public static Metrics[] 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 (Metrics c : Metrics.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static Metrics 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()
- Description copied from interface:
Metric
- Returns the multiplier to calculate metrics values from a base scale.
- Specified by:
getMultiplier
in interface Metric
- Returns:
Copyright © 2011-2013-2013 SpringSource. All Rights Reserved.