Package com.cta4j.train.client

Interface TrainClient

All Known Implementing Classes:

TrainClientImpl

public interface TrainClient

A client for interacting with the CTA Train Tracker API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TrainClient.Builder	A builder for configuring and creating TrainClient instances.

Method Summary

Modifier and Type	Method	Description
static TrainClient.Builder	builder()	Creates a new TrainClient.Builder for configuring and building a TrainClient.
List<StationArrival>	getStationArrivals(String stationId)	Retrieves a List of upcoming arrivals for a specific station.
Optional<Train>	getTrain(String run)	Retrieves information about a specific train by its run number.

Method Details

getStationArrivals

List<StationArrival> getStationArrivals(String stationId)

Retrieves a List of upcoming arrivals for a specific station.

Parameters:

stationId - the ID of the station

Returns:

a List of upcoming arrivals for the specified station

Throws:

NullPointerException - if the specified station ID is null

Cta4jException - if an error occurs while fetching the data

getTrain

Optional<Train> getTrain(String run)

Retrieves information about a specific train by its run number.

Parameters:

run - the run number of the train

Returns:

an Optional containing the train information if found, or an empty Optional if not found

Throws:

NullPointerException - if the specified run number is null

Cta4jException - if an error occurs while fetching the data

builder

static TrainClient.Builder builder()

Creates a new TrainClient.Builder for configuring and building a TrainClient.

Returns:

a new TrainClient.Builder instance