Enum Class Metrics

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

public enum Metrics extends Enum<Metrics> implements Metric
Commonly used Metrics.
Since:
1.8
Author:
Oliver Gierke, Thomas Darimont
  • Enum Constant Details

    • KILOMETERS

      public static final Metrics KILOMETERS
    • MILES

      public static final Metrics MILES
    • NEUTRAL

      public static final Metrics NEUTRAL
  • Method Details

    • values

      public static Metrics[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Metrics valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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:
    • getAbbreviation

      public String getAbbreviation()
      Description copied from interface: Metric
      Returns the scientific abbreviation of the unit the Metric is in.
      Specified by:
      getAbbreviation in interface Metric
      Returns: