Spring Data MongoDB - Core

org.springframework.data.mongodb.core.geo
Enum Metrics

java.lang.Object
  extended by java.lang.Enum<Metrics>
      extended by org.springframework.data.mongodb.core.geo.Metrics
All Implemented Interfaces:
Serializable, Comparable<Metrics>, Metric

Deprecated. As of release 1.5, replaced by Metrics. This class is scheduled to be removed in the next major release.

@Deprecated
public enum Metrics
extends Enum<Metrics>
implements Metric

Commonly used Metrics for NearQuerys.

Author:
Oliver Gierke, Thomas Darimont

Enum Constant Summary
KILOMETERS
          Deprecated.  
MILES
          Deprecated.  
NEUTRAL
          Deprecated.  
 
Method Summary
 double getMultiplier()
          Deprecated.  
static Metrics valueOf(String name)
          Deprecated. Returns the enum constant of this type with the specified name.
static Metrics[] values()
          Deprecated. 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

KILOMETERS

public static final Metrics KILOMETERS
Deprecated. 

MILES

public static final Metrics MILES
Deprecated. 

NEUTRAL

public static final Metrics NEUTRAL
Deprecated. 
Method Detail

values

public static Metrics[] values()
Deprecated. 
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)
Deprecated. 
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()
Deprecated. 
Specified by:
getMultiplier in interface Metric

Spring Data MongoDB - Core

Copyright © 2011-2014–2014 Pivotal Software, Inc.. All rights reserved.