Package org.ka2ddo.yaac.osm

Enum Class Water

java.lang.Object
java.lang.Enum<Water>
org.ka2ddo.yaac.osm.Water
All Implemented Interfaces:
Serializable, Comparable<Water>, Constable, AmenityOrWay, EnumMayHaveFlags
public enum Water extends Enum<Water> implements AmenityOrWay, EnumMayHaveFlags
Supported types of the OSM water="*" attribute. See the definition of water on the OpenStreetMap wiki.
Author:
Andrew Pavlin, KA2DDO

  • Enum Constant Details

    • basin

      public static final Water basin

    • bay

      public static final Water bay

    • canal

      public static final Water canal

    • cenote

      public static final Water cenote

    • ditch

      public static final Water ditch

    • drain

      public static final Water drain

    • fish_pass

      public static final Water fish_pass

    • lake

      public static final Water lake

    • harbour

      public static final Water harbour

    • lagoon

      public static final Water lagoon

    • lock

      public static final Water lock

    • moat

      public static final Water moat

    • oxbow

      public static final Water oxbow

    • pond

      public static final Water pond

    • rapids

      public static final Water rapids

    • reflecting_pool

      public static final Water reflecting_pool

    • reservoir

      public static final Water reservoir

    • river

      public static final Water river

    • stream

      public static final Water stream

    • stream_pool

      public static final Water stream_pool

    • wastewater

      public static final Water wastewater

  • Method Details

    • values

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