Index
All Classes and Interfaces|All Packages|Serialized Form
A
- active() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
activerecord component. - approaching() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
approachingrecord component. - approaching() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
approachingrecord component. - ARRIVAL - Enum constant in enum class com.cta4j.model.bus.BusPredictionType
-
Indicates an arrival prediction.
- arrivals() - Method in record class com.cta4j.model.train.Train
-
Returns the value of the
arrivalsrecord component. - arrivalTime() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
arrivalTimerecord component. - arrivalTime() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
arrivalTimerecord component. - arrivalTime() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
arrivalTimerecord component.
B
- BLUE - Enum constant in enum class com.cta4j.model.train.Route
-
The Blue Line route.
- BROWN - Enum constant in enum class com.cta4j.model.train.Route
-
The Brown Line route.
- Bus - Record Class in com.cta4j.model.bus
-
A bus currently in service.
- Bus(String, BigDecimal, BigDecimal, Integer, String, String, Boolean) - Constructor for record class com.cta4j.model.bus.Bus
-
Creates an instance of a
Busrecord class. - BusClient - Class in com.cta4j.client
-
A client for interacting with the CTA Bus Tracker API.
- BusClient(String) - Constructor for class com.cta4j.client.BusClient
-
Constructs a new
BusClientwith the default host and the specified API key. - BusClient(String, String) - Constructor for class com.cta4j.client.BusClient
-
Constructs a new
BusClientwith the specified host and API key. - BusPredictionType - Enum Class in com.cta4j.model.bus
-
A type of bus prediction, either an arrival or a departure.
C
- com.cta4j.client - package com.cta4j.client
- com.cta4j.exception - package com.cta4j.exception
- com.cta4j.model.bus - package com.cta4j.model.bus
- com.cta4j.model.train - package com.cta4j.model.train
- coordinates() - Method in record class com.cta4j.model.train.Train
-
Returns the value of the
coordinatesrecord 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.model.bus.Bus
-
Returns the value of the
delayedrecord component. - delayed() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
delayedrecord component. - delayed() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
delayedrecord component. - delayed() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
delayedrecord component. - DEPARTURE - Enum constant in enum class com.cta4j.model.bus.BusPredictionType
-
Indicates a departure prediction.
- description() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
descriptionrecord component. - destination() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
destinationrecord component. - destination() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
destinationrecord component. - destinationName() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
destinationNamerecord component. - destinationName() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
destinationNamerecord component. - destinationStopId() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
destinationStopIdrecord component. - destinationStopId() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
destinationStopIdrecord component. - Detour - Record Class in com.cta4j.model.bus
-
A detour affecting one or more bus routes.
- Detour(String, String, Boolean, String, List<DetourRouteDirection>, Instant, Instant) - Constructor for record class com.cta4j.model.bus.Detour
-
Creates an instance of a
Detourrecord class. - DetourRouteDirection - Record Class in com.cta4j.model.bus
-
A bus route and its direction affected by a detour.
- DetourRouteDirection(String, String) - Constructor for record class com.cta4j.model.bus.DetourRouteDirection
-
Creates an instance of a
DetourRouteDirectionrecord class. - direction() - Method in record class com.cta4j.model.bus.DetourRouteDirection
-
Returns the value of the
directionrecord component. - direction() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
directionrecord component. - direction() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
directionrecord component. - distanceToStop() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
distanceToStoprecord component.
E
- endTime() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
endTimerecord component. - equals(Object) - Method in record class com.cta4j.model.bus.Bus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.bus.Detour
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.bus.DetourRouteDirection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.bus.Route
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.bus.Stop
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.bus.StopArrival
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.train.StationArrival
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.train.Train
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.train.TrainCoordinates
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Indicates whether some other object is "equal to" this one.
- etaMinutes() - Method in record class com.cta4j.model.bus.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.model.train.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.model.train.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.model.train.StationArrival
-
Returns the value of the
faultedrecord component. - faulted() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
faultedrecord component. - flags() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
flagsrecord component. - flags() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
flagsrecord component.
G
- getBus(String) - Method in class com.cta4j.client.BusClient
-
Retrieves information about a specific bus by its ID.
- getDetours(String, String) - Method in class com.cta4j.client.BusClient
-
Retrieves a
Listof detours for a specific bus route and direction. - getDirections(String) - Method in class com.cta4j.client.BusClient
-
Retrieves a
Listof directions for a specific bus route. - getRoutes() - Method in class com.cta4j.client.BusClient
-
Retrieves a
Listof all bus routes. - getStationArrivals(String) - Method in class com.cta4j.client.TrainClient
-
Retrieves a
Listof upcoming arrivals for a specific station. - getStopArrivals(String, String) - Method in class com.cta4j.client.BusClient
-
Retrieves a
Listof upcoming arrivals for a specific bus route and stop. - getStops(String, String) - Method in class com.cta4j.client.BusClient
-
Retrieves a
Listof stops for a specific bus route and direction. - getTrain(String) - Method in class com.cta4j.client.TrainClient
-
Retrieves information about a specific train by its run number.
- GREEN - Enum constant in enum class com.cta4j.model.train.Route
-
The Green Line route.
H
- hashCode() - Method in record class com.cta4j.model.bus.Bus
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.bus.Detour
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.bus.DetourRouteDirection
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.bus.Route
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.bus.Stop
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.train.StationArrival
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.train.Train
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.train.TrainCoordinates
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns a hash code value for this object.
- heading() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
headingrecord component. - heading() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
headingrecord component. - heading() - Method in record class com.cta4j.model.train.TrainCoordinates
-
Returns the value of the
headingrecord component.
I
- id() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
idrecord component. - id() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
idrecord component. - id() - Method in record class com.cta4j.model.bus.Route
-
Returns the value of the
idrecord component. - id() - Method in record class com.cta4j.model.bus.Stop
-
Returns the value of the
idrecord component.
L
- latitude() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
latituderecord component. - latitude() - Method in record class com.cta4j.model.bus.Stop
-
Returns the value of the
latituderecord component. - latitude() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
latituderecord component. - latitude() - Method in record class com.cta4j.model.train.TrainCoordinates
-
Returns the value of the
latituderecord component. - longitude() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
longituderecord component. - longitude() - Method in record class com.cta4j.model.bus.Stop
-
Returns the value of the
longituderecord component. - longitude() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
longituderecord component. - longitude() - Method in record class com.cta4j.model.train.TrainCoordinates
-
Returns the value of the
longituderecord component.
N
- N_A - Enum constant in enum class com.cta4j.model.train.Route
-
Not available / not applicable.
- name() - Method in record class com.cta4j.model.bus.Route
-
Returns the value of the
namerecord component. - name() - Method in record class com.cta4j.model.bus.Stop
-
Returns the value of the
namerecord component.
O
P
- PINK - Enum constant in enum class com.cta4j.model.train.Route
-
The Pink Line route.
- predictionTime() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
predictionTimerecord component. - predictionTime() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
predictionTimerecord component. - predictionType() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
predictionTyperecord component. - PURPLE - Enum constant in enum class com.cta4j.model.train.Route
-
The Purple Line route.
R
- RED - Enum constant in enum class com.cta4j.model.train.Route
-
The Red Line route.
- route() - Method in record class com.cta4j.model.bus.Bus
-
Returns the value of the
routerecord component. - route() - Method in record class com.cta4j.model.bus.DetourRouteDirection
-
Returns the value of the
routerecord component. - route() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
routerecord component. - route() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
routerecord component. - route() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
routerecord component. - Route - Enum Class in com.cta4j.model.train
-
A train route.
- Route - Record Class in com.cta4j.model.bus
-
A bus route.
- Route(String, String) - Constructor for record class com.cta4j.model.bus.Route
-
Creates an instance of a
Routerecord class. - routeDesignator() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
routeDesignatorrecord component. - routeDirection() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
routeDirectionrecord component. - routeDirections() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
routeDirectionsrecord component. - run() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
runrecord component. - run() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
runrecord component.
S
- scheduled() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
scheduledrecord component. - scheduled() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
scheduledrecord component. - startTime() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
startTimerecord component. - StationArrival - Record Class in com.cta4j.model.train
-
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.model.train.StationArrival
-
Creates an instance of a
StationArrivalrecord class. - stationId() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
stationIdrecord component. - stationId() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
stationIdrecord component. - stationName() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
stationNamerecord component. - stationName() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
stationNamerecord component. - Stop - Record Class in com.cta4j.model.bus
-
A bus stop.
- Stop(String, String, BigDecimal, BigDecimal) - Constructor for record class com.cta4j.model.bus.Stop
-
Creates an instance of a
Stoprecord class. - StopArrival - Record Class in com.cta4j.model.bus
-
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.model.bus.StopArrival
-
Creates an instance of a
StopArrivalrecord class. - stopDescription() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
stopDescriptionrecord component. - stopDescription() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
stopDescriptionrecord component. - stopId() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
stopIdrecord component. - stopId() - Method in record class com.cta4j.model.train.StationArrival
-
Returns the value of the
stopIdrecord component. - stopId() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns the value of the
stopIdrecord component. - stopName() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
stopNamerecord component.
T
- toString() - Method in record class com.cta4j.model.bus.Bus
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.bus.Detour
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.bus.DetourRouteDirection
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.bus.Route
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.bus.Stop
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.train.StationArrival
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.train.Train
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.train.TrainCoordinates
-
Returns a string representation of this record class.
- toString() - Method in record class com.cta4j.model.train.UpcomingTrainArrival
-
Returns a string representation of this record class.
- Train - Record Class in com.cta4j.model.train
-
A train currently in service.
- Train(TrainCoordinates, List<UpcomingTrainArrival>) - Constructor for record class com.cta4j.model.train.Train
-
Creates an instance of a
Trainrecord class. - TrainClient - Class in com.cta4j.client
-
A client for interacting with the CTA Train Tracker API.
- TrainClient(String) - Constructor for class com.cta4j.client.TrainClient
-
Constructs a new
TrainClientwith the default host and the specified API key. - TrainClient(String, String) - Constructor for class com.cta4j.client.TrainClient
-
Constructs a new
TrainClientwith the specified host and API key. - TrainCoordinates - Record Class in com.cta4j.model.train
-
The coordinates and heading of a train.
- TrainCoordinates(BigDecimal, BigDecimal, Integer) - Constructor for record class com.cta4j.model.train.TrainCoordinates
-
Creates an instance of a
TrainCoordinatesrecord class.
U
- UpcomingTrainArrival - Record Class in com.cta4j.model.train
-
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.model.train.UpcomingTrainArrival
-
Creates an instance of a
UpcomingTrainArrivalrecord class.
V
- valueOf(String) - Static method in enum class com.cta4j.model.bus.BusPredictionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.cta4j.model.train.Route
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.cta4j.model.bus.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.model.train.Route
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vehicleId() - Method in record class com.cta4j.model.bus.StopArrival
-
Returns the value of the
vehicleIdrecord component. - version() - Method in record class com.cta4j.model.bus.Detour
-
Returns the value of the
versionrecord component.
Y
A B C D E F G H I L N O P R S T U V YAll Classes and Interfaces|All Packages|Serialized Form