openlr

Enum LocationType

java.lang.Object

java.lang.Enum<LocationType>

openlr.LocationType

All Implemented Interfaces:

Serializable, Comparable<LocationType>

public enum LocationType
extends Enum<LocationType>

The enumeration LocationType specifies the different types of location supported by the OpenLR method.

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
CIRCLE circle area location
CLOSED_LINE closed line area location
GEO_COORDINATES simple geo coordinates
GRID grid area location
LINE_LOCATION line location.
POI_WITH_ACCESS_POINT point of interest with an access point along a line
POINT_ALONG_LINE point along a line
POLYGON polygon area location
RECTANGLE rectangular area location
UNKNOWN Location is UNKNOWN.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<LocationType>	AREA_LOCATIONS The Constant AREA_LOCATIONS.
static EnumSet<LocationType>	POINTS_LOCATIONS The Constant POINTS_LOCATIONS.

Method Summary

Modifier and Type	Method and Description
static List<LocationType>	getLocationTypes() Gets the location types.
static LocationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocationType[]	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 LocationType UNKNOWN

Location is UNKNOWN.

LINE_LOCATION

public static final LocationType LINE_LOCATION

line location.

GEO_COORDINATES

public static final LocationType GEO_COORDINATES

simple geo coordinates

POINT_ALONG_LINE

public static final LocationType POINT_ALONG_LINE

point along a line

POI_WITH_ACCESS_POINT

public static final LocationType POI_WITH_ACCESS_POINT

point of interest with an access point along a line

CIRCLE

public static final LocationType CIRCLE

circle area location

POLYGON

public static final LocationType POLYGON

polygon area location

CLOSED_LINE

public static final LocationType CLOSED_LINE

closed line area location

RECTANGLE

public static final LocationType RECTANGLE

rectangular area location

GRID

public static final LocationType GRID

grid area location

Field Detail

AREA_LOCATIONS

public static final EnumSet<LocationType> AREA_LOCATIONS

The Constant AREA_LOCATIONS.

POINTS_LOCATIONS

public static final EnumSet<LocationType> POINTS_LOCATIONS

The Constant POINTS_LOCATIONS.

Method Detail

values

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

Returns:

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

valueOf

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

getLocationTypes

public static List<LocationType> getLocationTypes()

Gets the location types.

Returns:

the location types