Package com.cta4j.bus.pattern

Interface PatternsApi

@NullMarked
public interface PatternsApi

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

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

Method Summary

Modifier and Type	Method	Description
default Optional<RoutePattern>	findById(String patternId)	Retrieves a route pattern by its pattern ID.
List<RoutePattern>	findByIds(Collection<String> patternIds)	Retrieves route patterns by their pattern IDs.
List<RoutePattern>	findByRouteId(String routeId)	Retrieves all route patterns for the specified route ID.

Method Details

findByIds

List<RoutePattern> findByIds(Collection<String> patternIds)

Retrieves route patterns by their pattern IDs.

Parameters:

patternIds - a Collection of route pattern IDs

Returns:

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

Throws:

NullPointerException - if patternIds is null or contains null elements

findById

default Optional<RoutePattern> findById(String patternId)

Retrieves a route pattern by its pattern ID.

Parameters:

patternId - the route pattern ID

Returns:

an Optional containing the RoutePattern if found, or an empty Optional if no pattern exists with the given ID

Throws:

NullPointerException - if patternId is null

findByRouteId

List<RoutePattern> findByRouteId(String routeId)

Retrieves all route patterns for the specified route ID.

Parameters:

routeId - the route ID

Returns:

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

Throws:

NullPointerException - if routeId is null