org.opentripplanner.api.common

Enum Message

java.lang.Object

java.lang.Enum<Message>

org.opentripplanner.api.common.Message

All Implemented Interfaces:

Serializable, Comparable<Message>

public enum Message
extends Enum<Message>

The purpose of Messages is to read supply Message.properties to underlying calling code... The ENUM's enumerated values should be named to reflect the property names inside of Message.properties

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOGUS_PARAMETER
GEOCODE_FROM_AMBIGUOUS
GEOCODE_FROM_NOT_FOUND
GEOCODE_FROM_TO_AMBIGUOUS
GEOCODE_FROM_TO_NOT_FOUND
GEOCODE_TO_AMBIGUOUS
GEOCODE_TO_NOT_FOUND
GRAPH_UNAVAILABLE
LOCATION_NOT_ACCESSIBLE
NO_TRANSIT_TIMES
OUTSIDE_BOUNDS
PATH_NOT_FOUND
PLAN_OK
REQUEST_TIMEOUT
SYSTEM_ERROR
TOO_CLOSE
TRIANGLE_NOT_AFFINE
TRIANGLE_OPTIMIZE_TYPE_NOT_SET
TRIANGLE_VALUES_NOT_SET
UNDERSPECIFIED_TRIANGLE

Method Summary

Modifier and Type	Method and Description
static Message	findEnumByProperty(String value)
static Message	findEnumByProperty(String value, Locale l) will return the enum who's .property value matches the passed in value ...
String	get()
String	get(Locale l)
String	get(String def, Locale l)
Properties	getConfig() simple checker / getter of the config
int	getId()
static Message	valueOf(String name) Returns the enum constant of this type with the specified name.
static Message[]	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

PLAN_OK

public static final Message PLAN_OK

SYSTEM_ERROR

public static final Message SYSTEM_ERROR

GRAPH_UNAVAILABLE

public static final Message GRAPH_UNAVAILABLE

OUTSIDE_BOUNDS

public static final Message OUTSIDE_BOUNDS

PATH_NOT_FOUND

public static final Message PATH_NOT_FOUND

NO_TRANSIT_TIMES

public static final Message NO_TRANSIT_TIMES

REQUEST_TIMEOUT

public static final Message REQUEST_TIMEOUT

BOGUS_PARAMETER

public static final Message BOGUS_PARAMETER

GEOCODE_FROM_NOT_FOUND

public static final Message GEOCODE_FROM_NOT_FOUND

GEOCODE_TO_NOT_FOUND

public static final Message GEOCODE_TO_NOT_FOUND

GEOCODE_FROM_TO_NOT_FOUND

public static final Message GEOCODE_FROM_TO_NOT_FOUND

TOO_CLOSE

public static final Message TOO_CLOSE

LOCATION_NOT_ACCESSIBLE

public static final Message LOCATION_NOT_ACCESSIBLE

GEOCODE_FROM_AMBIGUOUS

public static final Message GEOCODE_FROM_AMBIGUOUS

GEOCODE_TO_AMBIGUOUS

public static final Message GEOCODE_TO_AMBIGUOUS

GEOCODE_FROM_TO_AMBIGUOUS

public static final Message GEOCODE_FROM_TO_AMBIGUOUS

UNDERSPECIFIED_TRIANGLE

public static final Message UNDERSPECIFIED_TRIANGLE

TRIANGLE_NOT_AFFINE

public static final Message TRIANGLE_NOT_AFFINE

TRIANGLE_OPTIMIZE_TYPE_NOT_SET

public static final Message TRIANGLE_OPTIMIZE_TYPE_NOT_SET

TRIANGLE_VALUES_NOT_SET

public static final Message TRIANGLE_VALUES_NOT_SET

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

getConfig

public Properties getConfig()

simple checker / getter of the config

get

public String get(String def,
                  Locale l)

get

public String get(Locale l)

get

public String get()

findEnumByProperty

public static Message findEnumByProperty(String value,
                                         Locale l)

will return the enum who's .property value matches the passed in value ... NOTE: not sure where this will be used...from legacy code in case it's ever needed...

findEnumByProperty

public static Message findEnumByProperty(String value)