org.ka2ddo.yaac.osm
Enum Waterway

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

public enum Waterway
extends java.lang.Enum<Waterway>
implements AmenityOrWay

Supported types of the OSM waterway="*" attribute. See the definition of waterway on the OpenStreetMap wiki.


Enum Constant Summary
canal
           
dam
           
ditch
           
drain
           
rapids
           
river
           
riverbank
           
stream
           
user_defined
           
waterfall
           
 
Method Summary
 AmenityType getAmenityType()
          Get amenity type associated with this enumeration; only for types that are amenities.
 short getExtraFlags()
          Extra flag bits that should be OR'd into the flags field of the Node or Way.
static Waterway value(java.lang.String name)
          Get the enum value associated with the string name specified.
static Waterway valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Waterway[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 WayType wayType()
          Report the WayType for rendering this type of Way.
 
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

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
Method Detail

values

public static Waterway[] 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 (Waterway c : Waterway.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

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

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

getExtraFlags

public short getExtraFlags()
Extra flag bits that should be OR'd into the flags field of the Node or Way.

Returns:
bitmask of flag bits
See Also:
GenericTaggedNode.flags

value

public static Waterway value(java.lang.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