org.ka2ddo.yaac.osm

Enum Water

java.lang.Object

java.lang.Enum<Water>

org.ka2ddo.yaac.osm.Water

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Water>, AmenityOrWay, MaybeArea

public enum Water
extends java.lang.Enum<Water>
implements AmenityOrWay, MaybeArea

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

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants

Enum Constant and Description
canal
fish_pass
lagoon
lake
lock
moat
oxbow
pond
reflecting_pool
reservoir
river
stream_pool
wastewater

Method Summary

Modifier and Type	Method and Description
AmenityType	getAmenityType() Get amenity type associated with this enumeration; only for types that are amenities.
boolean	isArea() Indicates whether this enum type implies an area.
static Water	value(java.lang.String name) Get the enum value associated with the string name specified.
static Water	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Water[]	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

canal

public static final Water canal

fish_pass

public static final Water fish_pass

lake

public static final Water lake

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

reflecting_pool

public static final Water reflecting_pool

reservoir

public static final Water reservoir

river

public static final Water river

stream_pool

public static final Water stream_pool

wastewater

public static final Water wastewater

Method Detail

values

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

Returns:

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

valueOf

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

isArea

public boolean isArea()

Indicates whether this enum type implies an area.

Specified by:

isArea in interface MaybeArea

Returns:

boolean true if Ways with this attribute value are assumed to be areas

value

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