Package com.cta4j.train.location.model

Record Class TrainLocations

java.lang.Object
java.lang.Record
com.cta4j.train.location.model.TrainLocations
Record Components:
line - the train line associated with these locations
trains - the List of LocationTrains for this train line
@NullMarked public record TrainLocations(TrainLine line, List<LocationTrain> trains) extends Record
Represents the locations of all trains on a route.

  • Constructor Details

    • TrainLocations

      public TrainLocations(TrainLine line, List<LocationTrain> trains)
      Constructs a TrainLocations.
      Parameters:
      line - the train line associated with the locations
      trains - the List of LocationTrains for the train line
      Throws:
      NullPointerException - if line or trains is null, or if trains 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.

    • line

      public TrainLine line()
      Returns the value of the line record component.
      Returns:
      the value of the line record component

    • trains

      public List<LocationTrain> trains()
      Returns the value of the trains record component.
      Returns:
      the value of the trains record component