Package slash.navigation.base

Enum Class RouteCharacteristics

java.lang.Object

java.lang.Enum<RouteCharacteristics>

slash.navigation.base.RouteCharacteristics

All Implemented Interfaces:

Serializable, Comparable<RouteCharacteristics>, Constable

public enum RouteCharacteristics
extends Enum<RouteCharacteristics>

Enumeration of the characteristics of a BaseRoute. Route: a list of points (often with names) connected in a specific order. Usually a collection of waypoints defining the route you want to pass while traveling, created by PC software, or generated inside a GPS device. They can be composed of existing waypoints, or new "routepoints" might be generated. Track: a collection of locations recorded by your GPS device while traveling -- "breadcrumb trails". The order of trackpoints within the track is important. Usually a trackpoint doesn't have a name or description, but usually has a timestamp. This distinguishes a trackpoint from a waypoint. Waypoints: are geopoints that are not necessarily connected to other points, and their order is unimportant. They can be entered before, while or after you actually visit the place and might have tags like name, description and the like. Usually used to mark special locations as your home, a hotel or a geocache.

Author:

Christian Pesch

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
Route
Track
Waypoints

Method Summary

Modifier and Type	Method	Description
static RouteCharacteristics	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RouteCharacteristics[]	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

Route

public static final RouteCharacteristics Route

Track

public static final RouteCharacteristics Track

Waypoints

public static final RouteCharacteristics Waypoints

Method Details

values

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