Package com.cta4j.bus.prediction.query

Record Class VehiclesPredictionsQuery

java.lang.Object
java.lang.Record
com.cta4j.bus.prediction.query.VehiclesPredictionsQuery
Record Components:
vehicleIds - the List of vehicle IDs to retrieve predictions for
maxResults - the optional maximum number of predictions to return
@NullMarked public record VehiclesPredictionsQuery(List<String> vehicleIds, @Nullable Integer maxResults) extends Record
Represents a query for vehicle arrival predictions.

  • Constructor Details

    • VehiclesPredictionsQuery

      public VehiclesPredictionsQuery(List<String> vehicleIds, @Nullable Integer maxResults)
      Constructs a VehiclesPredictionsQuery.
      Parameters:
      vehicleIds - the List of vehicle IDs to retrieve predictions for
      maxResults - the optional maximum number of predictions to return
      Throws:
      NullPointerException - if vehicleIds or any of its elements are null
      IllegalArgumentException - if maxResults is non-null and not positive

  • Method Details

    • builder

      public static VehiclesPredictionsQuery.Builder builder(List<String> vehicleIds)
      Creates a builder for VehiclesPredictionsQuery.
      Parameters:
      vehicleIds - the List of vehicle IDs to retrieve predictions for
      Returns:
      a new Builder instance
      Throws:
      NullPointerException - if vehicleIds or any of its elements are null

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • vehicleIds

      public List<String> vehicleIds()
      Returns the value of the vehicleIds record component.
      Returns:
      the value of the vehicleIds record component

    • maxResults

      public @Nullable Integer maxResults()
      Returns the value of the maxResults record component.
      Returns:
      the value of the maxResults record component