FollowApi (CTA Java SDK 4.0.2 API)

@NullMarked public interface FollowApi

Provides access to follow-related endpoints of the CTA Train Tracker API.

This API allows retrieval of information about a specific train run.

Method Summary

Modifier and Type

Method

Description

Optional<FollowTrain>

findByRun(String run)

Retrieves a train by its run number.

Method Details
- findByRun
  
  Optional<FollowTrain> findByRun(String run)
  
  Retrieves a train by its run number.
  
  Parameters:
  
  run - the run number of the train
  
  Returns:
  
  an Optional containing the FollowTrain if found, or an empty Optional if no train exists with the given run number
  
  Throws:
  
  NullPointerException - if run is null