Package com.cercalia.sdk.model.poi

Enum PoiRouteWeight

java.lang.Object

java.lang.Enum<PoiRouteWeight>

com.cercalia.sdk.model.poi.PoiRouteWeight

All Implemented Interfaces:

Serializable, Comparable<PoiRouteWeight>, java.lang.constant.Constable

public enum PoiRouteWeight
extends Enum<PoiRouteWeight>

Weight criteria for POI routing calculations.

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
DISTANCE	Optimize for shortest distance.
FAST	Fast route (may be longer in distance).
MONEY	Optimize for lowest toll cost.
REALTIME	Use real-time traffic data.
SHORT	Short route (may be longer in time).
TIME	Optimize for shortest time.

Method Summary

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

TIME

public static final PoiRouteWeight TIME

Optimize for shortest time.

DISTANCE

public static final PoiRouteWeight DISTANCE

Optimize for shortest distance.

MONEY

public static final PoiRouteWeight MONEY

Optimize for lowest toll cost.

REALTIME

public static final PoiRouteWeight REALTIME

Use real-time traffic data.

FAST

public static final PoiRouteWeight FAST

Fast route (may be longer in distance).

SHORT

public static final PoiRouteWeight SHORT

Short route (may be longer in time).

Method Details

values

public static PoiRouteWeight[] values()

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

Returns:

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

valueOf

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

getValue

public String getValue()

Returns:

The API value for the weight.