Module OneMTA

Package dev.katsute.onemta.bus

Enum Class BusDirection

java.lang.Object

java.lang.Enum<BusDirection>

dev.katsute.onemta.bus.BusDirection

All Implemented Interfaces:

Serializable, Comparable<BusDirection>, java.lang.constant.Constable

public enum BusDirection
extends Enum<BusDirection>

The direction for a bus.

Since:

1.0.0

Version:

1.0.0

Author:

Katsute

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORWARD	Buses going from the first stop to the last stop.
REVERSE	Buses going from the last stop to the first stop.

Method Summary

Modifier and Type	Method	Description
static BusDirection	asDirection(int direction)	Converts a GTFS direction ID to an enum.
final int	getDirection()	Returns the GTFS direction ID.
static BusDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BusDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FORWARD

public static final BusDirection FORWARD

Buses going from the first stop to the last stop.
Ex: M1 'Harlem - East Village' going towards 'Harlem - 147 Street'

Since:

1.0.0

REVERSE

public static final BusDirection REVERSE

Buses going from the last stop to the first stop.
Ex: M1 'Harlem - East Village' going towards 'Harlem - East Village'

Since:

1.0.0

Method Details

values

public static BusDirection[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BusDirection valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDirection

public final int getDirection()

Returns the GTFS direction ID.

Returns:

gtfs direction

Since:

1.0.0

asDirection

public static BusDirection asDirection(int direction)

Converts a GTFS direction ID to an enum.

Parameters:

direction - gtfs direction

Returns:

direction

Since:

1.0.0