Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addConsumer(Consumer<Trip>) - Method in class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Register an additional consumer.
- AsyncUraTripReader - Class in de.stklcode.pubtrans.ura.reader
-
Asynchronous stream reader for URA stream API.
- AsyncUraTripReader(URI, UraClientConfiguration, List<Consumer<Trip>>) - Constructor for class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Initialize trip reader.
- AsyncUraTripReader(URI, Consumer<Trip>) - Constructor for class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Initialize trip reader.
- AsyncUraTripReader(URI, List<Consumer<Trip>>) - Constructor for class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Initialize trip reader.
B
- build() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration.Builder
-
Finally build the configuration object.
C
- close() - Method in class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Close the reader.
D
- de.stklcode.pubtrans.juraclient - module de.stklcode.pubtrans.juraclient
-
jURAclient main module.
- de.stklcode.pubtrans.ura - package de.stklcode.pubtrans.ura
-
jURAclient base package - see
UraClientfor usage. - de.stklcode.pubtrans.ura.exception - package de.stklcode.pubtrans.ura.exception
-
jURAclient exceptions thrown by the client.
- de.stklcode.pubtrans.ura.model - package de.stklcode.pubtrans.ura.model
-
jURAclient model classes that represent responses returned by the URA interface.
- de.stklcode.pubtrans.ura.reader - package de.stklcode.pubtrans.ura.reader
-
jURAclient utility classes for asynchronous reading from the API.
F
- forBaseURL(String) - Static method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get new configuration
UraClientConfiguration.Builderfor given base URL. - forDestinationNames(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given destination names.
- forDestinationNames(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given destination names.
- forDirection(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given direction.
- forDirection(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given direction.
- forLines(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given line IDs.
- forLines(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given line IDs.
- forLinesByName(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given line names.
- forLinesByName(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given line names.
- forPosition(Double, Double, Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given destination names.
- forPosition(Double, Double, Integer) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given position and radius.
- forStops(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given stop IDs.
- forStops(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given stop IDs.
- forStopsByName(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given stop names.
- forStopsByName(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given stop names.
G
- getBaseURL() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get the API base URL.
- getConnectTimeout() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get the connection timeout, if any.
- getDestinationName() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
The full length destination name of the trip the vehicle is on.
- getDestinationText() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
The abbreviated destination name of the trip the vehicle is on.
- getDirectionID() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
This identifies the direction of the trip that the vehicle is on.
- getEstimatedTime() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
This is the predicted time of arrival for the vehicle at a specific stop.
- getId() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
Stop identifier.
- getId() - Method in class de.stklcode.pubtrans.ura.model.Trip
- getIndicator() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
The letter(s) that are displayed on top of the bus stop flag (e.g.
- getInstantPath() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get the API instant endpoint path.
- getLatitude() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
The latitude of the stop.
- getLineID() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
The identifier of a route.
- getLineName() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
This is the route number that is displayed on the front of the bus and on any publicity advertising the route.
- getLongitude() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
The longitude of the stop.
- getMessages() - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of messages.
- getMessages() - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters.
- getMessages(UraClient.Query) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of messages.
- getMessages(UraClient.Query, Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of messages for given stopIDs with result limit.
- getMessages(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of messages with limit.
- getMessages(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters.
- getName() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
The name of the bus stop.
- getPriority() - Method in class de.stklcode.pubtrans.ura.model.Message
-
Messages are assigned a priority in order for them to be ranked.
- getState() - Method in class de.stklcode.pubtrans.ura.model.Stop
-
The different stop states and their definitions are provided below: 0: “Open”: Bus stop is being served as usual 1: “Temporarily Closed” : Vehicles are not serving the stop but may be serving a nearby bus stop, predictions may be available 2: “Closed” : Vehicles are not serving the stop.
- getStop() - Method in class de.stklcode.pubtrans.ura.model.Message
-
The stop, the message is targeted.
- getStop() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
The starting stop.
- getStops() - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of stops without filters.
- getStops() - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get stops for set filters.
- getStops(UraClient.Query) - Method in class de.stklcode.pubtrans.ura.UraClient
-
List available stopIDs.
- getStreeamPath() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get the API stream endpoint path.
- getText() - Method in class de.stklcode.pubtrans.ura.model.Message
-
The text of the message.
- getTimeout() - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration
-
Get the response timeout, if any.
- getTrips() - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of trips.
- getTrips() - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters.
- getTrips(UraClient.Query) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of trips.
- getTrips(UraClient.Query, Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of trips for given stopIDs and lineIDs with result limit.
- getTrips(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get list of trips with limit.
- getTrips(Integer) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters with limit.
- getTripsStream(UraClient.Query, Consumer<Trip>) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get trips for given stopIDs and lineIDs using stream API and pass each result to given consumer.
- getTripsStream(UraClient.Query, List<Consumer<Trip>>) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Get trips for given stopIDs and lineIDs using stream API and pass each result to given consumers.
- getTripsStream(Consumer<Trip>) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters.
- getTripsStream(List<Consumer<Trip>>) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Get trips for set filters.
- getType() - Method in class de.stklcode.pubtrans.ura.model.Message
-
Messages are assigned a type.
- getUuid() - Method in class de.stklcode.pubtrans.ura.model.Message
-
This is the unique identifier of the flexible message.
- getVehicleID() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
The unique identifier of the vehicle.
- getVisitID() - Method in class de.stklcode.pubtrans.ura.model.Trip
-
Visit identifier.
M
- Message - Class in de.stklcode.pubtrans.ura.model
-
Entity for a message.
- Message(Stop, String, Integer, Integer, String) - Constructor for class de.stklcode.pubtrans.ura.model.Message
-
Construct Message object from Stop model and set of additional data.
- Message(String, String, String, Integer, Double, Double, String, Integer, Integer, String) - Constructor for class de.stklcode.pubtrans.ura.model.Message
-
Construct Message object from complete set of data.
- Message(List<Serializable>) - Constructor for class de.stklcode.pubtrans.ura.model.Message
-
Construct Message object from raw list of attributes parsed from JSON.
- Message(List<Serializable>, String) - Constructor for class de.stklcode.pubtrans.ura.model.Message
-
Construct Message object from raw list of attributes parsed from JSON with explicitly specified version.
O
- open() - Method in class de.stklcode.pubtrans.ura.reader.AsyncUraTripReader
-
Open the reader, i.e. initiate connection to the API and start reading the response stream.
Q
- Query() - Constructor for class de.stklcode.pubtrans.ura.UraClient.Query
S
- Stop - Class in de.stklcode.pubtrans.ura.model
-
Entity for a single stop.
- Stop(String, String, String, Integer, Double, Double) - Constructor for class de.stklcode.pubtrans.ura.model.Stop
-
Construct Stop object.
- Stop(List<Serializable>) - Constructor for class de.stklcode.pubtrans.ura.model.Stop
-
Construct Stop object from raw list of attributes parsed from JSON.
T
- towards(String...) - Method in class de.stklcode.pubtrans.ura.UraClient.Query
-
Builder pattern to request given direction defined by stop point name.
- towards(String...) - Method in class de.stklcode.pubtrans.ura.UraClient
-
Builder pattern to request given direction defined by stop point name.
- Trip - Class in de.stklcode.pubtrans.ura.model
-
Entity for a single trip.
- Trip(Stop, Integer, String, String, Integer, String, String, String, String, Long) - Constructor for class de.stklcode.pubtrans.ura.model.Trip
-
Construct Trip object from Stop model and set of additional data.
- Trip(String, String, String, Integer, Double, Double, Integer, String, String, Integer, String, String, String, String, Long) - Constructor for class de.stklcode.pubtrans.ura.model.Trip
-
Construct Trip object from complete set of data.
- Trip(List<Serializable>) - Constructor for class de.stklcode.pubtrans.ura.model.Trip
-
Construct Trip object from raw list of attributes parsed from JSON.
- Trip(List<Serializable>, String) - Constructor for class de.stklcode.pubtrans.ura.model.Trip
-
Construct Trip object from raw list of attributes parsed from JSON with explicitly specified version.
U
- UraClient - Class in de.stklcode.pubtrans.ura
-
Client for URA based public transport API.
- UraClient(UraClientConfiguration) - Constructor for class de.stklcode.pubtrans.ura.UraClient
-
Constructor from
UraClientConfiguration. - UraClient(String) - Constructor for class de.stklcode.pubtrans.ura.UraClient
-
Constructor with base URL and default API paths.
- UraClient(String, String, String) - Constructor for class de.stklcode.pubtrans.ura.UraClient
-
Constructor with base URL and custom API paths.
- UraClient.Query - Class in de.stklcode.pubtrans.ura
-
Request meta object.
- UraClientConfiguration - Class in de.stklcode.pubtrans.ura
-
Configuration Object for the
UraClient. - UraClientConfiguration.Builder - Class in de.stklcode.pubtrans.ura
-
Builder for
UraClientConfigurationobjects. - UraClientConfigurationException - Exception in de.stklcode.pubtrans.ura.exception
-
Custom exception class indicating an error with the URA client configuration.
- UraClientConfigurationException(String, Throwable) - Constructor for exception de.stklcode.pubtrans.ura.exception.UraClientConfigurationException
-
Default constructor.
- UraClientException - Exception in de.stklcode.pubtrans.ura.exception
-
Custom exception class indicating an error with the URA API communication.
- UraClientException(String, Throwable) - Constructor for exception de.stklcode.pubtrans.ura.exception.UraClientException
-
Default constructor.
W
- withConnectTimeout(Duration) - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration.Builder
-
Specify a custom connection timeout duration.
- withInstantPath(String) - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration.Builder
-
Specify a custom path to the instant API.
- withStreamPath(String) - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration.Builder
-
Specify a custom path to the stream API.
- withTimeout(Duration) - Method in class de.stklcode.pubtrans.ura.UraClientConfiguration.Builder
-
Specify a custom timeout duration.
All Classes and Interfaces|All Packages|Serialized Form