Waterway

java.lang.Object
- java.lang.Enum<Waterway>
- - org.ka2ddo.yaac.osm.Waterway

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Waterway>, AmenityOrWay, EnumMayHaveFlags
```
public enum Waterway
extends java.lang.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 Summary

Enum Constants
Enum Constant and Description
`boatyard`
`canal`
`canoe_pass`
`check_dam`
`dam`
`debris_screen`
`ditch`
`dock`
`drain`
`fairway`
`fish_pass`
`floodgate`
`fuel`
`lock_gate`
`rapids`
`river`
`riverbank`
`security_lock`
`sluice_gate`
`stream`
`turning_point`
`user_defined`
`water_point`
`waterfall`
`weir`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmenityType`	`getAmenityType()` Get amenity type associated with this enumeration; only for types that are amenities.
`short`	`getFlagMask()` Indicates any flag bits implied by this enum type.
`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
```
  - weir
```
public static final Waterway weir
```
  - boatyard
```
public static final Waterway boatyard
```
  - dock
```
public static final Waterway dock
```
  - fairway
```
public static final Waterway fairway
```
  - fish_pass
```
public static final Waterway fish_pass
```
  - canoe_pass
```
public static final Waterway canoe_pass
```
  - lock_gate
```
public static final Waterway lock_gate
```
  - sluice_gate
```
public static final Waterway sluice_gate
```
  - floodgate
```
public static final Waterway floodgate
```
  - debris_screen
```
public static final Waterway debris_screen
```
  - security_lock
```
public static final Waterway security_lock
```
  - check_dam
```
public static final Waterway check_dam
```
  - turning_point
```
public static final Waterway turning_point
```
  - water_point
```
public static final Waterway water_point
```
  - fuel
```
public static final Waterway fuel
```
- 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
  - 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
  - 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

Enum Waterway

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

user_defined

stream

river

riverbank

canal

ditch

drain

rapids

waterfall

dam

weir

boatyard

dock

fairway

fish_pass

canoe_pass

lock_gate

sluice_gate

floodgate

debris_screen

security_lock

check_dam

turning_point

water_point

fuel

Method Detail

values

valueOf

wayType

getAmenityType

value

getFlagMask