com.graphhopper.routing.util

Enum PriorityCode

java.lang.Object

java.lang.Enum<PriorityCode>

com.graphhopper.routing.util.PriorityCode

All Implemented Interfaces:

Serializable, Comparable<PriorityCode>

public enum PriorityCode
extends Enum<PriorityCode>

Used to store a priority value in the way flags of an edge. Used in combination with PriorityWeighting

Author:

Peter Karich

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVOID_AT_ALL_COSTS
AVOID_IF_POSSIBLE
BEST
PREFER
REACH_DEST
UNCHANGED
VERY_NICE
WORST

Method Summary

Modifier and Type	Method and Description
static double	getFactor(int val) This method returns the PriorityCode.value in a range between 0 and 1 suitable for direct usage in a Weighting.
int	getValue()
static PriorityCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static PriorityCode[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORST

public static final PriorityCode WORST

AVOID_AT_ALL_COSTS

public static final PriorityCode AVOID_AT_ALL_COSTS

REACH_DEST

public static final PriorityCode REACH_DEST

AVOID_IF_POSSIBLE

public static final PriorityCode AVOID_IF_POSSIBLE

UNCHANGED

public static final PriorityCode UNCHANGED

PREFER

public static final PriorityCode PREFER

VERY_NICE

public static final PriorityCode VERY_NICE

BEST

public static final PriorityCode BEST

Method Detail

values

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

Returns:

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

valueOf

public static PriorityCode 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 int getValue()

getFactor

public static double getFactor(int val)

This method returns the PriorityCode.value in a range between 0 and 1 suitable for direct usage in a Weighting.