org.opentripplanner.api.model

Enum BoardAlightType

java.lang.Object

java.lang.Enum<BoardAlightType>

org.opentripplanner.api.model.BoardAlightType

All Implemented Interfaces:

Serializable, Comparable<BoardAlightType>

public enum BoardAlightType
extends Enum<BoardAlightType>

Distinguish between special ways a passenger may board or alight at a stop. The majority of boardings and alightings will be of type "default" -- a regular boarding or alighting at a regular transit stop. Currently, the only non-default types are related to GTFS-Flex, but this pattern can be extended as necessary.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT A regular boarding or alighting at a fixed-route transit stop.
DEVIATED A boarding or alighting at which the vehicle deviates from its fixed route to drop off a passenger.
FLAG_STOP A flag-stop boarding or alighting, e.g.

Method Summary

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

DEFAULT

public static final BoardAlightType DEFAULT

A regular boarding or alighting at a fixed-route transit stop.

FLAG_STOP

public static final BoardAlightType FLAG_STOP

A flag-stop boarding or alighting, e.g. flagging the bus down or a passenger asking the bus driver for a drop-off between stops. This is specific to GTFS-Flex.

DEVIATED

public static final BoardAlightType DEVIATED

A boarding or alighting at which the vehicle deviates from its fixed route to drop off a passenger. This is specific to GTFS-Flex.

Method Detail

values

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

Returns:

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

valueOf

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