com.pb.routing.enums

Enum OptimizeBy

java.lang.Object

java.lang.Enum<OptimizeBy>

com.pb.routing.enums.OptimizeBy

All Implemented Interfaces:

Serializable, Comparable<OptimizeBy>

public enum OptimizeBy
extends Enum<OptimizeBy>

Supported optimization parameters for routing operations - Time and Distance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTANCE Optimize By Distance
TIME Optimize By Time

Method Summary

Modifier and Type	Method and Description
String	getValue() Returns the value of optimization parameter.
static OptimizeBy	toOptimizeBy(String input) Converts the specified value to corresponding OptimizeBy choice.
static OptimizeBy	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptimizeBy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TIME

public static final OptimizeBy TIME

Optimize By Time

DISTANCE

public static final OptimizeBy DISTANCE

Optimize By Distance

Method Detail

values

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

Returns:

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

valueOf

public static OptimizeBy 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 value of optimization parameter.

Returns:

A String, the value of optimization parameter.

toOptimizeBy

public static OptimizeBy toOptimizeBy(String input)

Converts the specified value to corresponding OptimizeBy choice.

For e.g. OptimizeBy.toOptimizeBy("time") gives OptimizeBy.TIME

Parameters:

input - A String, optimization parameter.

Returns:

Corresponding OptimizeBy choice.