Package com.cta4j.train.follow.model

Record Class FollowTrain

java.lang.Object
java.lang.Record
com.cta4j.train.follow.model.FollowTrain
Record Components:
coordinates - the current coordinates of this train being followed
arrivals - the List of Arrivals for this train being followed
@NullMarked public record FollowTrain(@Nullable Coordinates coordinates, List<Arrival> arrivals) extends Record
Represents a response from the "follow" endpoint of the CTA Train Tracker API.

  • Constructor Details

    • FollowTrain

      public FollowTrain(@Nullable Coordinates coordinates, List<Arrival> arrivals)
      Constructs a FollowTrain.
      Parameters:
      coordinates - the current coordinates of the train being followed
      arrivals - the List of Arrivals for the train being followed
      Throws:
      NullPointerException - if arrivals is null, or if arrivals contains null elements

  • Method Details

    • 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.

    • coordinates

      public @Nullable Coordinates coordinates()
      Returns the value of the coordinates record component.
      Returns:
      the value of the coordinates record component

    • arrivals

      public List<Arrival> arrivals()
      Returns the value of the arrivals record component.
      Returns:
      the value of the arrivals record component