Package org.ka2ddo.yaac.osm

Enum Class Location

java.lang.Object

java.lang.Enum<Location>

org.ka2ddo.yaac.osm.Location

All Implemented Interfaces:

Serializable, Comparable<Location>, Constable

public enum Location
extends Enum<Location>

This enum defines the commonly-used values of the location="*" attribute of OSM. See the definition of location on the OpenStreetMap wiki.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
overground
overhead
roof
rooftop
surface
underground
underwater

Method Summary

Modifier and Type	Method	Description
int	getFlags2Mask()	Indicates any extended flag bits implied by this enum type.
static Location	value(String name)	Get the enum value associated with the string name specified.
static Location	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Location[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

underground

public static final Location underground

underwater

public static final Location underwater

overground

public static final Location overground

overhead

public static final Location overhead

roof

public static final Location roof

rooftop

public static final Location rooftop

surface

public static final Location surface

Method Details

values

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

value

public static Location value(String name)

Get the enum value associated with the string name specified.

Parameters:

name - String to convert into an Enum

Returns:

Leisure for the string name, or null if no match

getFlags2Mask

public int getFlags2Mask()

Indicates any extended flag bits implied by this enum type.

Returns:

bitmask of flags if this enum implies extended flags