com.pb.routing.enums

Enum RoadTypePriority

java.lang.Object

java.lang.Enum<RoadTypePriority>

com.pb.routing.enums.RoadTypePriority

All Implemented Interfaces:

Serializable, Comparable<RoadTypePriority>

public enum RoadTypePriority
extends Enum<RoadTypePriority>

Different priorities for supported RoadTypes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVOID Completely ignores a RoadType while performing route calculations.
HIGH Sets the RoadType preference to highest while performing route calculations.
LOW Sets the RoadType preference to LOW while performing route calculations.
MEDIUM Sets the RoadType preference to MEDIUM(higher than LOW but lower than HIGH) while performing route calculations.

Method Summary

Modifier and Type	Method and Description
String	getValue() Returns the priority of this RoadType.
static RoadTypePriority	toRoadTypePriority(String input) Converts the specified value to corresponding RoadTypePriority choice.
static RoadTypePriority	valueOf(String name) Returns the enum constant of this type with the specified name.
static RoadTypePriority[]	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

AVOID

public static final RoadTypePriority AVOID

Completely ignores a RoadType while performing route calculations.

LOW

public static final RoadTypePriority LOW

Sets the RoadType preference to LOW while performing route calculations.

MEDIUM

public static final RoadTypePriority MEDIUM

Sets the RoadType preference to MEDIUM(higher than LOW but lower than HIGH) while performing route calculations.

HIGH

public static final RoadTypePriority HIGH

Sets the RoadType preference to highest while performing route calculations.

Method Detail

values

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

Returns:

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

valueOf

public static RoadTypePriority 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 priority of this RoadType.

Returns:

A String, the priority of this RoadType.

toRoadTypePriority

public static RoadTypePriority toRoadTypePriority(String input)

Converts the specified value to corresponding RoadTypePriority choice.

For e.g. RoadTypePriority.toRoadTypePriority("high") gives RoadTypePriority.HIGH

Parameters:

input - A String, road type priority value.

Returns:

Corresponding RoadTypePriority choice.