Enum GeoUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GeoUnit>

    public enum GeoUnit
    extends java.lang.Enum<GeoUnit>
    Enumeration representing distance units options for the geospatial command.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FEET
      Represents distance in feet.
      KILOMETERS
      Represents distance in kilometers.
      METERS
      Represents distance in meters.
      MILES
      Represents distance in miles.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getValkeyAPI()  
      static GeoUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GeoUnit[] 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 GeoUnit METERS
        Represents distance in meters.
      • KILOMETERS

        public static final GeoUnit KILOMETERS
        Represents distance in kilometers.
      • MILES

        public static final GeoUnit MILES
        Represents distance in miles.
      • FEET

        public static final GeoUnit FEET
        Represents distance in feet.
    • Method Detail

      • values

        public static GeoUnit[] 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 (GeoUnit c : GeoUnit.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static GeoUnit valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getValkeyAPI

        public java.lang.String getValkeyAPI()