org.ka2ddo.yaac.osm

Enum OSMColour

java.lang.Object

java.lang.Enum<OSMColour>

org.ka2ddo.yaac.osm.OSMColour

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OSMColour>

public enum OSMColour
extends java.lang.Enum<OSMColour>

This specifies color attribute values that can be found in OSM tags, to handle types of amenities where the type is the same but the map rendering should be of a different color to show some significance of the instance. For example, a Node with the seamark:type tag value of "buoy_lateral" would probably have a seamark:buoy_lateral:colour tag indicating which side of a channel the buoy was on, which would be significant on a marine chart. However, this is not restricted to marine map features.

Any new values for any of these attributes must be added at the end of the list to maintain enum ordinal stability and therefore backwards compatibility with maps imported with previous versions of this enumeration.

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants

Enum Constant and Description
black
green
red
unknown
white
yellow

Method Summary

Modifier and Type	Method and Description
static OSMColour	value(java.lang.String name) Get the OSMColour object corresponding to this
static OSMColour	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OSMColour[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

unknown

public static final OSMColour unknown

white

public static final OSMColour white

red

public static final OSMColour red

green

public static final OSMColour green

yellow

public static final OSMColour yellow

black

public static final OSMColour black

Method Detail

values

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

Returns:

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

valueOf

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

value

public static OSMColour value(java.lang.String name)

Get the OSMColour object corresponding to this

Parameters:

name - String name of colour

Returns:

OSMColour object matching the name, or null if it is an unsupported colour