Module OneMTA

Package dev.katsute.onemta

Class MTA

java.lang.Object

dev.katsute.onemta.MTA

public abstract class MTA
extends Object

Represents the MTA API.
Authenticate using create(String, DataResource...)

Since:

1.0.0

Version:

3.0.0

Author:

Katsute

Method Summary

Modifier and Type	Method	Description
static MTA	create(String busToken, int cacheSeconds, DataResource... resources)	Creates an MTA API interface.
static MTA	create(String busToken, DataResource... resources)	Creates an MTA API interface.
abstract Bus.Vehicle	getBus(int bus_id)	Returns a bus.
abstract Bus.Alert[]	getBusAlerts()	Returns bus alerts.
abstract Bus.Route	getBusRoute(String route_id)	Returns a bus route.
abstract Bus.Route	getBusRoute(String route_id, DataResourceType type)	Returns a bus route.
abstract Bus.Stop	getBusStop(int stop_id)	Returns a bus stop.
abstract Bus.Stop	getBusStop(int stop_id, DataResourceType type)	Returns a bus stop.
abstract LIRR.Alert[]	getLIRRAlerts()	Returns Long Island Railroad (LIRR) alerts.
abstract LIRR.Route	getLIRRRoute(int route_id)	Returns a Long Island Railroad (LIRR) route.
abstract LIRR.Stop	getLIRRStop(int stop_id)	Returns a Long Island Railroad (LIRR) stop.
abstract LIRR.Stop	getLIRRStop(String stop_code)	Returns a Long Island Railroad (LIRR) stop.
abstract LIRR.Vehicle	getLIRRTrain(String train_id)	Returns a Long Island Railroad (LIRR) train.
abstract MNR.Alert[]	getMNRAlerts()	Returns Metro North Railroad (MNR) alerts.
abstract MNR.Route	getMNRRoute(int route_id)	Returns a Metro North Railroad (MNR) route.
abstract MNR.Stop	getMNRStop(int stop_id)	Returns a Metro North Railroad (MNR) stop.
abstract MNR.Stop	getMNRStop(String stop_code)	Returns a Metro North Railroad (MNR) stop.
abstract MNR.Vehicle	getMNRTrain(String train_id)	Returns a Metro North Railroad (MNR) train.
abstract Subway.Alert[]	getSubwayAlerts()	Returns subway alerts.
abstract Subway.Route	getSubwayRoute(int route_id)	Returns a subway route.
abstract Subway.Route	getSubwayRoute(String route_id)	Returns a subway route.
abstract Subway.Stop	getSubwayStop(int stop_id)	Returns a subway stop.
abstract Subway.Stop	getSubwayStop(int stop_id, SubwayDirection direction)	Returns a subway stop.
abstract Subway.Stop	getSubwayStop(String stop_id)	Returns a subway stop.
abstract Subway.Stop	getSubwayStop(String stop_id, SubwayDirection direction)	Returns a subway stop.
abstract Subway.Vehicle	getSubwayTrain(String train_id)	Returns a subway train.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static MTA create(String busToken,
 DataResource... resources)

Creates an MTA API interface. Note that bus alerts require a subway token.

Parameters:

busToken - bus token

resources - (required) static data resource, see DataResource

Returns:

MTA

Since:

3.0.0

See Also:

• create(String, int, DataResource...)

create

public static MTA create(String busToken,
 int cacheSeconds,
 DataResource... resources)

Creates an MTA API interface. Note that bus alerts require a subway token.

Parameters:

busToken - bus token

cacheSeconds - how long to cache responses for

resources - (required) static data resource, see DataResource

Returns:

MTA

Since:

3.0.0

See Also:

• create(String, DataResource...)

getBusRoute

public abstract Bus.Route getBusRoute(String route_id)

Returns a bus route. Much slower than getBusRoute(String, DataResourceType), consider passing the DataResourceType the route is in for faster results.

Parameters:

route_id - bus route ID

Returns:

bus route

Since:

1.0.0

See Also:

• Bus.Route
• getBusRoute(String, DataResourceType)

getBusRoute

public abstract Bus.Route getBusRoute(String route_id,
 DataResourceType type)

Returns a bus route.

Parameters:

route_id - bus route ID

type - data resource that the bus route is in, must have been added to create(String, DataResource...)

Returns:

bus route

Since:

1.0.0

See Also:

• DataResourceType
• getBusRoute(String)

getBusStop

public abstract Bus.Stop getBusStop(int stop_id)

Returns a bus stop. Much slower than getBusStop(int, DataResourceType), consider passing the DataResourceType the stop is in for faster results.

Parameters:

stop_id - bus stop ID

Returns:

bus stop

Since:

1.0.0

See Also:

• Bus.Stop
• getBusStop(int, DataResourceType)

getBusStop

public abstract Bus.Stop getBusStop(int stop_id,
 DataResourceType type)

Returns a bus stop.

Parameters:

stop_id - bus stop ID

type - data resource that the bus stop is in, must have been added to create(String, DataResource...)

Returns:

bus stop

Since:

1.0.0

See Also:

• Bus.Stop
• getBusStop(int)

getBus

public abstract Bus.Vehicle getBus(int bus_id)

Returns a bus. Does not work for Bus Company.

Parameters:

bus_id - bus number as it is seen on the front and side of the bus

Returns:

bus

Since:

1.0.0

See Also:

• Bus.Vehicle

getBusAlerts

public abstract Bus.Alert[] getBusAlerts()

Returns bus alerts. Requires a subway token.

Returns:

bus alerts

Since:

1.0.0

See Also:

• Bus.Alert

getSubwayRoute

public abstract Subway.Route getSubwayRoute(int route_id)

Returns a subway route.

Parameters:

route_id - route id

Returns:

subway route

Since:

1.0.0

See Also:

• Subway.Route
• getSubwayRoute(String)

getSubwayRoute

public abstract Subway.Route getSubwayRoute(String route_id)

Returns a subway route.

Parameters:

route_id - route id

Returns:

subway route

Since:

1.0.0

See Also:

• Subway.Route
• getSubwayRoute(int)

getSubwayStop

public abstract Subway.Stop getSubwayStop(int stop_id)

Returns a subway stop.

Parameters:

stop_id - stop id

Returns:

subway stop

Since:

1.0.0

See Also:

• Subway.Stop
• getSubwayStop(String)
• getSubwayStop(int, SubwayDirection)
• getSubwayStop(String, SubwayDirection)

getSubwayStop

public abstract Subway.Stop getSubwayStop(String stop_id)

Returns a subway stop.

Parameters:

stop_id - stop id

Returns:

subway stop

Since:

1.0.0

See Also:

• SubwayDirection
• Subway.Stop
• getSubwayStop(int)
• getSubwayStop(int, SubwayDirection)
• getSubwayStop(String, SubwayDirection)

getSubwayStop

public abstract Subway.Stop getSubwayStop(int stop_id,
 SubwayDirection direction)

Returns a subway stop.

Parameters:

stop_id - stop id

direction - subway direction

Returns:

subway stop

Since:

1.0.0

See Also:

• SubwayDirection
• Subway.Stop
• getSubwayStop(int)
• getSubwayStop(String)
• getSubwayStop(String, SubwayDirection)

getSubwayStop

public abstract Subway.Stop getSubwayStop(String stop_id,
 SubwayDirection direction)

Returns a subway stop.

Parameters:

stop_id - stop id

direction - subway direction

Returns:

subway stop

Since:

1.0.0

See Also:

• SubwayDirection
• Subway.Stop
• getSubwayStop(int)
• getSubwayStop(String)
• getSubwayStop(int, SubwayDirection)

getSubwayTrain

public abstract Subway.Vehicle getSubwayTrain(String train_id)

Returns a subway train.

Parameters:

train_id - train id

Returns:

subway train

Since:

1.0.0

See Also:

• Subway.Vehicle

getSubwayAlerts

public abstract Subway.Alert[] getSubwayAlerts()

Returns subway alerts.

Returns:

subway alerts

Since:

1.0.0

See Also:

• Subway.Alert

getLIRRRoute

public abstract LIRR.Route getLIRRRoute(int route_id)

Returns a Long Island Railroad (LIRR) route.

Parameters:

route_id - route id

Returns:

LIRR route

Since:

1.0.0

See Also:

• LIRR.Route

getLIRRStop

public abstract LIRR.Stop getLIRRStop(int stop_id)

Returns a Long Island Railroad (LIRR) stop.

Parameters:

stop_id - stop id

Returns:

LIRR stop

Since:

1.0.0

See Also:

• LIRR.Stop
• getLIRRStop(String)

getLIRRStop

public abstract LIRR.Stop getLIRRStop(String stop_code)

Returns a Long Island Railroad (LIRR) stop.

Parameters:

stop_code - stop code

Returns:

LIRR stop

Since:

1.0.0

See Also:

• LIRR.Stop
• getLIRRStop(int)

getLIRRTrain

public abstract LIRR.Vehicle getLIRRTrain(String train_id)

Returns a Long Island Railroad (LIRR) train.

Parameters:

train_id - train id

Returns:

LIRR train

Since:

1.0.0

See Also:

• LIRR.Vehicle

getLIRRAlerts

public abstract LIRR.Alert[] getLIRRAlerts()

Returns Long Island Railroad (LIRR) alerts.

Returns:

LIRR alerts

Since:

1.0.0

See Also:

• LIRR.Alert

getMNRRoute

public abstract MNR.Route getMNRRoute(int route_id)

Returns a Metro North Railroad (MNR) route.

Parameters:

route_id - route id

Returns:

MNR route

Since:

1.0.0

See Also:

• MNR.Route

getMNRStop

public abstract MNR.Stop getMNRStop(int stop_id)

Returns a Metro North Railroad (MNR) stop.

Parameters:

stop_id - stop id

Returns:

MNR stop

Since:

1.0.0

See Also:

• MNR.Stop
• getMNRStop(String)

getMNRStop

public abstract MNR.Stop getMNRStop(String stop_code)

Returns a Metro North Railroad (MNR) stop.

Parameters:

stop_code - stop code

Returns:

MNR stop

Since:

1.0.0

See Also:

• MNR.Stop
• getMNRStop(int)

getMNRTrain

public abstract MNR.Vehicle getMNRTrain(String train_id)

Returns a Metro North Railroad (MNR) train.

Parameters:

train_id - train id

Returns:

MNR train

Since:

1.0.0

See Also:

• MNR.Vehicle

getMNRAlerts

public abstract MNR.Alert[] getMNRAlerts()

Returns Metro North Railroad (MNR) alerts.

Returns:

MNR alerts

Since:

1.0.0

See Also:

• MNR.Alert