Index (CTA Java SDK 3.0.2 API)

A B C D E F G H I L N O P R S T U V Y
All Classes and Interfaces|All Packages|Serialized Form

A

active() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the active record component.
apiKey(String) - Method in interface com.cta4j.bus.client.BusClient.Builder: Sets the API key used for authentication.
apiKey(String) - Method in interface com.cta4j.train.client.TrainClient.Builder: Sets the API key used for authentication.
approaching() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the approaching record component.
approaching() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the approaching record component.
ARRIVAL - Enum constant in enum class com.cta4j.bus.model.BusPredictionType: Indicates an arrival prediction.
arrivals() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the arrivals record component.
arrivals() - Method in record class com.cta4j.train.model.Train: Returns the value of the arrivals record component.
arrivalTime() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the arrivalTime record component.
arrivalTime() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the arrivalTime record component.
arrivalTime() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the arrivalTime record component.
arrivalTime() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the arrivalTime record component.

B

BLUE - Enum constant in enum class com.cta4j.train.model.Route: The Blue Line route.
BROWN - Enum constant in enum class com.cta4j.train.model.Route: The Brown Line route.
build() - Method in interface com.cta4j.bus.client.BusClient.Builder: Builds a configured BusClient instance.
build() - Method in interface com.cta4j.train.client.TrainClient.Builder: Builds a configured TrainClient instance.
builder() - Static method in interface com.cta4j.bus.client.BusClient: Creates a new BusClient.Builder for configuring and building a BusClient.
builder() - Static method in interface com.cta4j.train.client.TrainClient: Creates a new TrainClient.Builder for configuring and building a TrainClient.
Bus - Record Class in com.cta4j.bus.model: A bus currently in service.
Bus(String, String, String, BusCoordinates, List<UpcomingBusArrival>, Boolean) - Constructor for record class com.cta4j.bus.model.Bus: Creates an instance of a Bus record class.
BusClient - Interface in com.cta4j.bus.client: A client for interacting with the CTA Bus Tracker API.
BusClient.Builder - Interface in com.cta4j.bus.client: A builder for configuring and creating BusClient instances.
BusCoordinates - Record Class in com.cta4j.bus.model: The coordinates and heading of a bus.
BusCoordinates(BigDecimal, BigDecimal, Integer) - Constructor for record class com.cta4j.bus.model.BusCoordinates: Creates an instance of a BusCoordinates record class.
BusPredictionType - Enum Class in com.cta4j.bus.model: A type of bus prediction, either an arrival or a departure.

C

com.cta4j.bus.client - package com.cta4j.bus.client
com.cta4j.bus.model - package com.cta4j.bus.model
com.cta4j.exception - package com.cta4j.exception
com.cta4j.train.client - package com.cta4j.train.client
com.cta4j.train.model - package com.cta4j.train.model
coordinates() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the coordinates record component.
coordinates() - Method in record class com.cta4j.train.model.Train: Returns the value of the coordinates record component.
cta4j.java.sdk - module cta4j.java.sdk: The cta4j Java SDK module.
Cta4jException - Exception Class in com.cta4j.exception: A custom exception class for handling cta4j specific errors.
Cta4jException(String) - Constructor for exception class com.cta4j.exception.Cta4jException: Constructs a new Cta4jException with the specified detail message.
Cta4jException(String, Throwable) - Constructor for exception class com.cta4j.exception.Cta4jException: Constructs a new Cta4jException with the specified detail message and cause.

D

delayed() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the delayed record component.
delayed() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the delayed record component.
delayed() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the delayed record component.
delayed() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the delayed record component.
delayed() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the delayed record component.
DEPARTURE - Enum constant in enum class com.cta4j.bus.model.BusPredictionType: Indicates a departure prediction.
description() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the description record component.
destination() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the destination record component.
destination() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the destination record component.
destination() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the destination record component.
destinationName() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the destinationName record component.
destinationName() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the destinationName record component.
destinationStopId() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the destinationStopId record component.
destinationStopId() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the destinationStopId record component.
Detour - Record Class in com.cta4j.bus.model: A detour affecting one or more bus routes.
Detour(String, String, Boolean, String, List<DetourRouteDirection>, Instant, Instant) - Constructor for record class com.cta4j.bus.model.Detour: Creates an instance of a Detour record class.
DetourRouteDirection - Record Class in com.cta4j.bus.model: A bus route and its direction affected by a detour.
DetourRouteDirection(String, String) - Constructor for record class com.cta4j.bus.model.DetourRouteDirection: Creates an instance of a DetourRouteDirection record class.
direction() - Method in record class com.cta4j.bus.model.DetourRouteDirection: Returns the value of the direction record component.
direction() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the direction record component.
direction() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the direction record component.
distanceToStop() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the distanceToStop record component.
distanceToStop() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the distanceToStop record component.

E

endTime() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the endTime record component.
equals(Object) - Method in record class com.cta4j.bus.model.Bus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.BusCoordinates: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.Detour: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.DetourRouteDirection: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.Route: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.Stop: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.StopArrival: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.train.model.StationArrival: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.train.model.Train: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.train.model.TrainCoordinates: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Indicates whether some other object is "equal to" this one.
etaMinutes() - Method in record class com.cta4j.bus.model.StopArrival: Calculates the estimated time of arrival (ETA) in minutes from the current time to the predicted arrival time.
etaMinutes() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Calculates the estimated time of arrival (ETA) in minutes from the current time to the predicted arrival time.
etaMinutes() - Method in record class com.cta4j.train.model.StationArrival: Calculates the estimated time of arrival (ETA) in minutes from the prediction time to the arrival time.
etaMinutes() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Calculates the estimated time of arrival (ETA) in minutes from the prediction time to the arrival time.

F

faulted() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the faulted record component.
faulted() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the faulted record component.
flags() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the flags record component.
flags() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the flags record component.

G

getBus(String) - Method in interface com.cta4j.bus.client.BusClient: Retrieves information about a specific bus by its ID.
getDetours(String, String) - Method in interface com.cta4j.bus.client.BusClient: Retrieves a List of detours for a specific bus route and direction.
getDirections(String) - Method in interface com.cta4j.bus.client.BusClient: Retrieves a List of directions for a specific bus route.
getRoutes() - Method in interface com.cta4j.bus.client.BusClient: Retrieves a List of all bus routes.
getStationArrivals(String) - Method in interface com.cta4j.train.client.TrainClient: Retrieves a List of upcoming arrivals for a specific station.
getStopArrivals(String, String) - Method in interface com.cta4j.bus.client.BusClient: Retrieves a List of upcoming arrivals for a specific bus route and stop.
getStops(String, String) - Method in interface com.cta4j.bus.client.BusClient: Retrieves a List of stops for a specific bus route and direction.
getTrain(String) - Method in interface com.cta4j.train.client.TrainClient: Retrieves information about a specific train by its run number.
GREEN - Enum constant in enum class com.cta4j.train.model.Route: The Green Line route.

H

hashCode() - Method in record class com.cta4j.bus.model.Bus: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.BusCoordinates: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.Detour: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.DetourRouteDirection: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.Route: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.Stop: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.StopArrival: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.train.model.StationArrival: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.train.model.Train: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.train.model.TrainCoordinates: Returns a hash code value for this object.
hashCode() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns a hash code value for this object.
heading() - Method in record class com.cta4j.bus.model.BusCoordinates: Returns the value of the heading record component.
heading() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the heading record component.
heading() - Method in record class com.cta4j.train.model.TrainCoordinates: Returns the value of the heading record component.
host(String) - Method in interface com.cta4j.bus.client.BusClient.Builder: Sets the API host used by the client.
host(String) - Method in interface com.cta4j.train.client.TrainClient.Builder: Sets the API host used by the client.

I

id() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the id record component.
id() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the id record component.
id() - Method in record class com.cta4j.bus.model.Route: Returns the value of the id record component.
id() - Method in record class com.cta4j.bus.model.Stop: Returns the value of the id record component.

L

latitude() - Method in record class com.cta4j.bus.model.BusCoordinates: Returns the value of the latitude record component.
latitude() - Method in record class com.cta4j.bus.model.Stop: Returns the value of the latitude record component.
latitude() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the latitude record component.
latitude() - Method in record class com.cta4j.train.model.TrainCoordinates: Returns the value of the latitude record component.
longitude() - Method in record class com.cta4j.bus.model.BusCoordinates: Returns the value of the longitude record component.
longitude() - Method in record class com.cta4j.bus.model.Stop: Returns the value of the longitude record component.
longitude() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the longitude record component.
longitude() - Method in record class com.cta4j.train.model.TrainCoordinates: Returns the value of the longitude record component.

N

N_A - Enum constant in enum class com.cta4j.train.model.Route: Not available / not applicable.
name() - Method in record class com.cta4j.bus.model.Route: Returns the value of the name record component.
name() - Method in record class com.cta4j.bus.model.Stop: Returns the value of the name record component.

O

ORANGE - Enum constant in enum class com.cta4j.train.model.Route: The Orange Line route.

P

PINK - Enum constant in enum class com.cta4j.train.model.Route: The Pink Line route.
predictionTime() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the predictionTime record component.
predictionTime() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the predictionTime record component.
predictionType() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the predictionType record component.
predictionType() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the predictionType record component.
PURPLE - Enum constant in enum class com.cta4j.train.model.Route: The Purple Line route.

R

RED - Enum constant in enum class com.cta4j.train.model.Route: The Red Line route.
route() - Method in record class com.cta4j.bus.model.Bus: Returns the value of the route record component.
route() - Method in record class com.cta4j.bus.model.DetourRouteDirection: Returns the value of the route record component.
route() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the route record component.
route() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the route record component.
route() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the route record component.
route() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the route record component.
Route - Enum Class in com.cta4j.train.model: A train route.
Route - Record Class in com.cta4j.bus.model: A bus route.
Route(String, String) - Constructor for record class com.cta4j.bus.model.Route: Creates an instance of a Route record class.
routeDesignator() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the routeDesignator record component.
routeDesignator() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the routeDesignator record component.
routeDirection() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the routeDirection record component.
routeDirection() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the routeDirection record component.
routeDirections() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the routeDirections record component.
run() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the run record component.
run() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the run record component.

S

scheduled() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the scheduled record component.
scheduled() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the scheduled record component.
startTime() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the startTime record component.
StationArrival - Record Class in com.cta4j.train.model: An arrival prediction for a train at a station.
StationArrival(String, String, String, String, String, Route, String, String, Integer, Instant, Instant, Boolean, Boolean, Boolean, Boolean, String, BigDecimal, BigDecimal, Integer) - Constructor for record class com.cta4j.train.model.StationArrival: Creates an instance of a StationArrival record class.
stationId() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the stationId record component.
stationId() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the stationId record component.
stationName() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the stationName record component.
stationName() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the stationName record component.
Stop - Record Class in com.cta4j.bus.model: A bus stop.
Stop(String, String, BigDecimal, BigDecimal) - Constructor for record class com.cta4j.bus.model.Stop: Creates an instance of a Stop record class.
StopArrival - Record Class in com.cta4j.bus.model: An arrival prediction for a bus at a specific stop.
StopArrival(BusPredictionType, String, String, String, BigInteger, String, String, String, String, Instant, Boolean) - Constructor for record class com.cta4j.bus.model.StopArrival: Creates an instance of a StopArrival record class.
stopDescription() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the stopDescription record component.
stopDescription() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the stopDescription record component.
stopId() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the stopId record component.
stopId() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the stopId record component.
stopId() - Method in record class com.cta4j.train.model.StationArrival: Returns the value of the stopId record component.
stopId() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns the value of the stopId record component.
stopName() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the stopName record component.
stopName() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the stopName record component.

T

toString() - Method in record class com.cta4j.bus.model.Bus: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.BusCoordinates: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.Detour: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.DetourRouteDirection: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.Route: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.Stop: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.StopArrival: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.train.model.StationArrival: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.train.model.Train: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.train.model.TrainCoordinates: Returns a string representation of this record class.
toString() - Method in record class com.cta4j.train.model.UpcomingTrainArrival: Returns a string representation of this record class.
Train - Record Class in com.cta4j.train.model: A train currently in service.
Train(TrainCoordinates, List<UpcomingTrainArrival>) - Constructor for record class com.cta4j.train.model.Train: Creates an instance of a Train record class.
TrainClient - Interface in com.cta4j.train.client: A client for interacting with the CTA Train Tracker API.
TrainClient.Builder - Interface in com.cta4j.train.client: A builder for configuring and creating TrainClient instances.
TrainCoordinates - Record Class in com.cta4j.train.model: The coordinates and heading of a train.
TrainCoordinates(BigDecimal, BigDecimal, Integer) - Constructor for record class com.cta4j.train.model.TrainCoordinates: Creates an instance of a TrainCoordinates record class.

U

UpcomingBusArrival - Record Class in com.cta4j.bus.model: An upcoming arrival prediction for a bus at a stop.
UpcomingBusArrival(BusPredictionType, String, String, String, BigInteger, String, String, String, String, Instant, Boolean) - Constructor for record class com.cta4j.bus.model.UpcomingBusArrival: Creates an instance of a UpcomingBusArrival record class.
UpcomingTrainArrival - Record Class in com.cta4j.train.model: An upcoming arrival prediction for a train at a station.
UpcomingTrainArrival(String, String, String, String, String, Route, String, String, Integer, Instant, Instant, Boolean, Boolean, Boolean, Boolean, String) - Constructor for record class com.cta4j.train.model.UpcomingTrainArrival: Creates an instance of a UpcomingTrainArrival record class.

V

valueOf(String) - Static method in enum class com.cta4j.bus.model.BusPredictionType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.cta4j.train.model.Route: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.cta4j.bus.model.BusPredictionType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.cta4j.train.model.Route: Returns an array containing the constants of this enum class, in the order they are declared.
vehicleId() - Method in record class com.cta4j.bus.model.StopArrival: Returns the value of the vehicleId record component.
vehicleId() - Method in record class com.cta4j.bus.model.UpcomingBusArrival: Returns the value of the vehicleId record component.
version() - Method in record class com.cta4j.bus.model.Detour: Returns the value of the version record component.

Y

YELLOW - Enum constant in enum class com.cta4j.train.model.Route: The Yellow Line route.

A B C D E F G H I L N O P R S T U V Y
All Classes and Interfaces|All Packages|Serialized Form