Package com.cta4j.bus.vehicle

Interface VehiclesApi

@NullMarked
public interface VehiclesApi

Provides access to vehicle-related endpoints of the CTA BusTime API.

This API allows retrieval of vehicles by their IDs or by associated route IDs.

Method Summary

Modifier and Type	Method	Description
default Optional<Vehicle>	findById(String id)	Retrieves a vehicle by its ID.
List<Vehicle>	findByIds(Collection<String> ids)	Retrieves vehicles by their IDs.
default List<Vehicle>	findByRouteId(String routeId)	Retrieves all vehicles for the specified route ID.
List<Vehicle>	findByRouteIds(Collection<String> routeIds)	Retrieves all vehicles for the specified route IDs.

Method Details

findByIds

List<Vehicle> findByIds(Collection<String> ids)

Retrieves vehicles by their IDs.

Parameters:

ids - a Collection of vehicle IDs

Returns:

a List of Vehicles corresponding to the provided IDs, or an empty List if no vehicles are found

Throws:

NullPointerException - if ids is null or contains null elements

findById

default Optional<Vehicle> findById(String id)

Retrieves a vehicle by its ID.

Parameters:

id - the vehicle ID

Returns:

an Optional containing the Vehicle if found, or an empty Optional if no vehicle exists with the given ID

Throws:

NullPointerException - if id is null

Cta4jException - if multiple vehicles are found for the given ID

findByRouteIds

List<Vehicle> findByRouteIds(Collection<String> routeIds)

Retrieves all vehicles for the specified route IDs.

Parameters:

routeIds - a Collection of route IDs

Returns:

a List of Vehicles associated with the route IDs, or an empty List if no vehicles exist for the route IDs

Throws:

NullPointerException - if routeIds is null or contains null elements

findByRouteId

default List<Vehicle> findByRouteId(String routeId)

Retrieves all vehicles for the specified route ID.

Parameters:

routeId - the route ID

Returns:

a List of Vehicles associated with the route ID, or an empty List if no vehicles exist for the route ID

Throws:

NullPointerException - if routeId is null