Module OneMTA

Package dev.katsute.onemta.subway

Enum Class SubwayDirection

java.lang.Object

java.lang.Enum<SubwayDirection>

dev.katsute.onemta.subway.SubwayDirection

All Implemented Interfaces:

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

public enum SubwayDirection
extends Enum<SubwayDirection>

The direction for a subway.

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
NORTH	Uptown, Bronx, and Queens bound trains; also Grand Central bound Shuttle trains.
SOUTH	Downtown, Brooklyn, and Manhattan bound trains; also Times Square bound Shuttle trains.

Method Summary

Modifier and Type	Method	Description
static SubwayDirection	asDirection(int direction)	Converts a GTFS direction ID to an enum.
final int	getDirection()	Returns the GTFS direction ID.
static SubwayDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SubwayDirection[]	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

NORTH

public static final SubwayDirection NORTH

Uptown, Bronx, and Queens bound trains; also Grand Central bound Shuttle trains.

SOUTH

public static final SubwayDirection SOUTH

Downtown, Brooklyn, and Manhattan bound trains; also Times Square bound Shuttle trains.

Method Details

values

public static SubwayDirection[] 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 SubwayDirection 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 SubwayDirection asDirection(int direction)

Converts a GTFS direction ID to an enum.

Parameters:

direction - gtfs direction

Returns:

direction

Since:

1.0.0