Enum AreaUnitId

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

    public enum AreaUnitId
    extends java.lang.Enum<AreaUnitId>
    Defines a list of the most commonly-used units of area measurement. These values can be used to create instances of AreaUnit, 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 an area 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:
    AreaUnit.getAreaUnitId(), AreaUnit(AreaUnitId), Unit.getUnitId()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACRES
      Indicates an area measurement in acres.
      HECTARES
      Indicates an area measurement in hectares.
      OTHER
      Indicates that the unit of area measurement is a custom unit, or a unit not listed in the enumerated type.
      SQUARE_CENTIMETERS
      Indicates an area measurement in square centimeters.
      SQUARE_DECIMETERS
      Indicates an area measurement in square decimeters.
      SQUARE_FEET
      Indicates an area measurement in square feet.
      SQUARE_KILOMETERS
      Indicates an area measurement in square kilometers.
      SQUARE_METERS
      Indicates an area measurement in square meters.
      SQUARE_MILES
      Indicates an area measurement in square statute miles.
      SQUARE_MILLIMETERS
      Indicates an area measurement in square millimeters.
      SQUARE_YARDS
      Indicates an area measurement in square yards.
    • Method Summary

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

      • HECTARES

        public static final AreaUnitId HECTARES
        Indicates an area measurement in hectares. This unit has a WKID of 109401.
      • ACRES

        public static final AreaUnitId ACRES
        Indicates an area measurement in acres. This unit has a WKID of 109402.
      • SQUARE_METERS

        public static final AreaUnitId SQUARE_METERS
        Indicates an area measurement in square meters. This unit has a WKID of 109404.
      • SQUARE_FEET

        public static final AreaUnitId SQUARE_FEET
        Indicates an area measurement in square feet. This unit has a WKID of 109405.
      • SQUARE_KILOMETERS

        public static final AreaUnitId SQUARE_KILOMETERS
        Indicates an area measurement in square kilometers. This unit has a WKID of 109414.
      • SQUARE_MILES

        public static final AreaUnitId SQUARE_MILES
        Indicates an area measurement in square statute miles. This unit has a WKID of 109439.
      • SQUARE_YARDS

        public static final AreaUnitId SQUARE_YARDS
        Indicates an area measurement in square yards. This unit has a WKID of 109442.
      • SQUARE_DECIMETERS

        public static final AreaUnitId SQUARE_DECIMETERS
        Indicates an area measurement in square decimeters. This unit has a WKID of 109450.
      • SQUARE_CENTIMETERS

        public static final AreaUnitId SQUARE_CENTIMETERS
        Indicates an area measurement in square centimeters. This unit has a WKID of 109451.
      • SQUARE_MILLIMETERS

        public static final AreaUnitId SQUARE_MILLIMETERS
        Indicates an area measurement in square millimeters. This unit has a WKID of 109452.
      • OTHER

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

        This value may be returned from an AreaUnit 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 AreaUnitId[] 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 (AreaUnitId c : AreaUnitId.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

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