Package org.ka2ddo.yaac.osm

Enum Class Natural

java.lang.Object
java.lang.Enum<Natural>
org.ka2ddo.yaac.osm.Natural
All Implemented Interfaces:
Serializable, Comparable<Natural>, Constable, AmenityOrWay, EnumMayHaveFlags
public enum Natural extends Enum<Natural> implements EnumMayHaveFlags, AmenityOrWay
This enums defines the supported types of natural structures defined by OSM. See the definition of natural on the OpenStreetMap wiki.
Author:
Andrew Pavlin, KA2DDO

  • Enum Constant Details

    • cliff

      public static final Natural cliff

    • coastline

      public static final Natural coastline

    • glacier

      public static final Natural glacier

    • volcano

      public static final Natural volcano

    • water

      public static final Natural water

    • wetland

      public static final Natural wetland

    • bay

      public static final Natural bay

    • beach

      public static final Natural beach

    • cave_entrance

      public static final Natural cave_entrance

    • fell

      public static final Natural fell

    • grassland

      public static final Natural grassland

    • heath

      public static final Natural heath

    • mud

      public static final Natural mud

    • peak

      public static final Natural peak

    • sand

      public static final Natural sand

    • scree

      public static final Natural scree

    • scrub

      public static final Natural scrub

    • spring

      public static final Natural spring

    • stone

      public static final Natural stone

    • tree

      public static final Natural tree

    • wood

      public static final Natural wood

    • moor

      public static final Natural moor

    • geyser

      public static final Natural geyser

    • hot_spring

      public static final Natural hot_spring

  • Method Details

    • values

      public static Natural[] 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 Natural 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

    • wayType

      public WayType wayType()
      Report the WayType for rendering this type of Way.
      Specified by:
      wayType in interface AmenityOrWay
      Returns:
      WayType

    • getAmenityType

      public AmenityType getAmenityType()
      Get amenity type associated with this enumeration; only for types that are amenities.
      Specified by:
      getAmenityType in interface AmenityOrWay
      Returns:
      AmenityType for this type, or null if not an amenity

    • getFlagMask

      public short getFlagMask()
      Indicates any flag bits implied by this enum type.
      Specified by:
      getFlagMask in interface EnumMayHaveFlags
      Returns:
      bitmask of flags if this enum implies flags

    • value

      public static Natural value(String name)
      Get the enum value associated with the string name specified.
      Parameters:
      name - String to convert into an Enum
      Returns:
      Natural for the string name, or null if no match