openlr.location.data

Enum SideOfRoad

java.lang.Object

java.lang.Enum<SideOfRoad>

openlr.location.data.SideOfRoad

All Implemented Interfaces:

Serializable, Comparable<SideOfRoad>

public enum SideOfRoad
extends Enum<SideOfRoad>

The enumeration SideOfRoad defines on which side of the road a point location can be. The direction of the road is identified by the order of the LRPs and the direction goes from first LRP to second LRP.

OpenLR is a trade mark of TomTom International B.V.

email: software@openlr.org

Author:

TomTom International B.V.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH on both sides
LEFT on the left side
ON_ROAD_OR_UNKNOWN directly on the road or unknown
RIGHT on the right side

Method Summary

Modifier and Type	Method and Description
static SideOfRoad	getDefault() Gets the default.
static List<SideOfRoad>	getSideOfRoadValues() Gets the side of road values.
static SideOfRoad	valueOf(String name) Returns the enum constant of this type with the specified name.
static SideOfRoad[]	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

ON_ROAD_OR_UNKNOWN

public static final SideOfRoad ON_ROAD_OR_UNKNOWN

directly on the road or unknown

RIGHT

public static final SideOfRoad RIGHT

on the right side

LEFT

public static final SideOfRoad LEFT

on the left side

BOTH

public static final SideOfRoad BOTH

on both sides

Method Detail

values

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

Returns:

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

valueOf

public static SideOfRoad valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSideOfRoadValues

public static List<SideOfRoad> getSideOfRoadValues()

Gets the side of road values.

Returns:

the side of road values

getDefault

public static SideOfRoad getDefault()

Gets the default.

Returns:

the default