com.conveyal.r5.api.util

Enum LegMode

java.lang.Object

java.lang.Enum<LegMode>

com.conveyal.r5.api.util.LegMode

All Implemented Interfaces:

Serializable, Comparable<LegMode>

public enum LegMode
extends Enum<LegMode>

Modes of transport on access or egress legs

Enum Constant Summary

Enum Constants

Enum Constant and Description
BICYCLE
BICYCLE_RENT
CAR
CAR_PARK
WALK

Method Summary

Modifier and Type	Method and Description
static StreetMode	getDominantStreetMode(Set<LegMode> modes) Return the heaviest/fastest StreetMode for use in stop finding
static StreetMode	toStreetMode(LegMode legMode) Convert between these two enum types
static EnumSet<StreetMode>	toStreetModeSet(EnumSet<LegMode>... legModeSets)
static LegMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LegMode[]	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

WALK

public static final LegMode WALK

BICYCLE

public static final LegMode BICYCLE

CAR

public static final LegMode CAR

BICYCLE_RENT

public static final LegMode BICYCLE_RENT

CAR_PARK

public static final LegMode CAR_PARK

Method Detail

values

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

Returns:

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

valueOf

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

getDominantStreetMode

public static StreetMode getDominantStreetMode(Set<LegMode> modes)

Return the heaviest/fastest StreetMode for use in stop finding

toStreetMode

public static StreetMode toStreetMode(LegMode legMode)

Convert between these two enum types

toStreetModeSet

public static EnumSet<StreetMode> toStreetModeSet(EnumSet<LegMode>... legModeSets)