Enum Class Waterway

java.lang.Object
java.lang.Enum<Waterway>
org.ka2ddo.yaac.osm.Waterway
All Implemented Interfaces:
Serializable, Comparable<Waterway>, Constable, AmenityOrWay, EnumMayHaveFlags

public enum Waterway extends Enum<Waterway> implements AmenityOrWay, EnumMayHaveFlags
Supported types of the OSM waterway="*" attribute. See the definition of waterway on the OpenStreetMap wiki.
Author:
Andrew Pavlin, KA2DDO
  • Enum Constant Details

    • user_defined

      public static final Waterway user_defined
    • stream

      public static final Waterway stream
    • river

      public static final Waterway river
    • riverbank

      public static final Waterway riverbank
    • canal

      public static final Waterway canal
    • ditch

      public static final Waterway ditch
    • drain

      public static final Waterway drain
    • rapids

      public static final Waterway rapids
    • waterfall

      public static final Waterway waterfall
    • dam

      public static final Waterway dam
    • weir

      public static final Waterway weir
  • Method Details

    • values

      public static Waterway[] 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 Waterway 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
    • value

      public static Waterway value(String name)
      Get the enum value associated with the string name specified.
      Parameters:
      name - String to convert into an Enum
      Returns:
      Waterway for the string name, or null if no match
    • 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