Enum LinearUnitId

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

    public enum LinearUnitId
    extends java.lang.Enum<LinearUnitId>
    Defines a list of the most commonly-used units of linear measurement. These values can be used to create instances of LinearUnit, as an alternative to using well-known IDs (WKIDs).

    In addition to the units in this enumeration, you can also use less commonly-used units, by passing a WKID of a linear unit to the inherited Unit.fromUnitId(int) factory method. The supported WKIDs are documented in the 'Projected coordinate systems' table in the developer Guide.

    Since:
    100.0.0
    See Also:
    LinearUnit.getLinearUnitId(), LinearUnit(LinearUnitId), Unit.getUnitId()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CENTIMETERS
      Indicates a linear measurement in centimeters.
      FEET
      Indicates a linear measurement in feet.
      INCHES
      Indicates a linear measurement in inches.
      KILOMETERS
      Indicates a linear measurement in kilometers.
      METERS
      Indicates a linear measurement in meters.
      MILES
      Indicates a linear measurement in statute miles.
      MILLIMETERS
      Indicates a linear measurement in millimeters.
      NAUTICAL_MILES
      Indicates a linear measurement in nautical miles.
      OTHER
      Indicates that the unit of linear measurement is a custom unit, or is a unit not listed in the enumerated type.
      YARDS
      Indicates a linear measurement in yards.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LinearUnitId valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LinearUnitId[] 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

      • FEET

        public static final LinearUnitId FEET
        Indicates a linear measurement in feet. This unit has a WKID of 9002.
      • INCHES

        public static final LinearUnitId INCHES
        Indicates a linear measurement in inches. This unit has a WKID of 109008.
      • KILOMETERS

        public static final LinearUnitId KILOMETERS
        Indicates a linear measurement in kilometers. This unit has a WKID of 9036.
      • METERS

        public static final LinearUnitId METERS
        Indicates a linear measurement in meters. This unit has a WKID of 9001.
      • MILLIMETERS

        public static final LinearUnitId MILLIMETERS
        Indicates a linear measurement in millimeters. This unit has a WKID of 1025.
      • MILES

        public static final LinearUnitId MILES
        Indicates a linear measurement in statute miles. This unit has a WKID of 9093.
      • NAUTICAL_MILES

        public static final LinearUnitId NAUTICAL_MILES
        Indicates a linear measurement in nautical miles. This unit has a WKID of 9030.
      • YARDS

        public static final LinearUnitId YARDS
        Indicates a linear measurement in yards. This unit has a WKID of 9096.
      • CENTIMETERS

        public static final LinearUnitId CENTIMETERS
        Indicates a linear measurement in centimeters. This unit has a WKID of 1033.
      • OTHER

        public static final LinearUnitId OTHER
        Indicates that the unit of linear measurement is a custom unit, or is a unit not listed in the enumerated type.

        This value may be returned from a LinearUnit created from a WKID of a less commonly used unit of measurement that does not have an equivalent value in this enumeration. See Unit.getUnitId().

    • Method Detail

      • values

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

        public static LinearUnitId 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