openlr.location.data

Enum Orientation

java.lang.Object

java.lang.Enum<Orientation>

openlr.location.data.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>

public enum Orientation
extends Enum<Orientation>

The enumeration Orientation defines how a point location is oriented with respect to the direction of the line 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
AGAINST_LINE_DIRECTION against line direction means from second LRP to first LRP
BOTH in both directions
NO_ORIENTATION_OR_UNKNOWN no orientation or unknown
WITH_LINE_DIRECTION with line direction from first LRP to second LRP

Method Summary

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

NO_ORIENTATION_OR_UNKNOWN

public static final Orientation NO_ORIENTATION_OR_UNKNOWN

no orientation or unknown

WITH_LINE_DIRECTION

public static final Orientation WITH_LINE_DIRECTION

with line direction from first LRP to second LRP

AGAINST_LINE_DIRECTION

public static final Orientation AGAINST_LINE_DIRECTION

against line direction means from second LRP to first LRP

BOTH

public static final Orientation BOTH

in both directions

Method Detail

values

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

Returns:

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

valueOf

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

getOrientationValues

public static List<Orientation> getOrientationValues()

Gets the orientation values.

Returns:

the orientation values

getDefault

public static Orientation getDefault()

Gets the default.

Returns:

the default