Package com.cercalia.sdk.model.proximity

Enum ProximityRouteWeight

java.lang.Object

java.lang.Enum<ProximityRouteWeight>

com.cercalia.sdk.model.proximity.ProximityRouteWeight

All Implemented Interfaces:

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

public enum ProximityRouteWeight
extends Enum<ProximityRouteWeight>

Route weight for proximity search with routing.

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.
TIME	Optimize for shortest time.

Method Summary

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

Optimize for shortest time.

DISTANCE

public static final ProximityRouteWeight DISTANCE

Optimize for shortest distance.

Method Details

values

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