Package com.cta4j.train.common.model

Record Class Arrival

java.lang.Object
java.lang.Record
com.cta4j.train.common.model.Arrival
Record Components:
stationId - the unique identifier of the station for which this arrival was generated
stationName - the display name of the station for which this arrival was generated
stopId - the unique identifier of the stop for which this arrival was generated
stopDescription - the display name of the stop for which this arrival was generated
line - the train line associated with this arrival
destinationStationId - the unique identifier of the destination station for this arrival
destinationName - the display name of the destination station for this arrival
predictionTime - the date and time (UTC) this arrival was generated
arrivalTime - the date and time (UTC) of a train’s arrival or departure to the stop associated with this arrival
approaching - whether the train associated with this arrival is currently approaching the stop
scheduled - whether this arrival is based on a scheduled time rather than a real-time prediction
delayed - whether the train associated with this arrival is currently delayed
fault - whether the train associated with this arrival is currently experiencing a fault
metadata - the metadata associated with this arrival
@NullMarked public record Arrival(String stationId, String stationName, String stopId, String stopDescription, TrainLine line, String destinationStationId, String destinationName, Instant predictionTime, Instant arrivalTime, boolean approaching, boolean scheduled, boolean delayed, boolean fault, ArrivalMetadata metadata) extends Record
Represents a train arrival.

  • Constructor Details

    • Arrival

      public Arrival(String stationId, String stationName, String stopId, String stopDescription, TrainLine line, String destinationStationId, String destinationName, Instant predictionTime, Instant arrivalTime, boolean approaching, boolean scheduled, boolean delayed, boolean fault, ArrivalMetadata metadata)
      Constructs an Arrival.
      Parameters:
      stationId - the unique identifier of the station for which the arrival was generated
      stationName - the display name of the station for which the arrival was generated
      stopId - the unique identifier of the stop for which the arrival was generated
      stopDescription - the display name of the stop for which the arrival was generated
      line - the train line associated with the arrival
      destinationStationId - the unique identifier of the destination station for the arrival
      destinationName - the display name of the destination station for the arrival
      predictionTime - the date and time (UTC) the arrival was generated
      arrivalTime - the date and time (UTC) of a train’s arrival or departure to the stop associated with the arrival
      approaching - whether the train associated with the arrival is currently approaching the stop
      scheduled - whether the arrival is based on a scheduled time rather than a real-time prediction
      delayed - whether the train associated with the arrival is currently delayed
      fault - whether the train associated with the arrival is currently experiencing a fault
      metadata - the metadata associated with the arrival
      Throws:
      NullPointerException - if stationId, stationName, stopId, stopDescription, line, destinationStationId, destinationName, predictionTime, arrivalTime, or metadata is null

  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • stationId

      public String stationId()
      Returns the value of the stationId record component.
      Returns:
      the value of the stationId record component

    • stationName

      public String stationName()
      Returns the value of the stationName record component.
      Returns:
      the value of the stationName record component

    • stopId

      public String stopId()
      Returns the value of the stopId record component.
      Returns:
      the value of the stopId record component

    • stopDescription

      public String stopDescription()
      Returns the value of the stopDescription record component.
      Returns:
      the value of the stopDescription record component

    • line

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

    • destinationStationId

      public String destinationStationId()
      Returns the value of the destinationStationId record component.
      Returns:
      the value of the destinationStationId record component

    • destinationName

      public String destinationName()
      Returns the value of the destinationName record component.
      Returns:
      the value of the destinationName record component

    • predictionTime

      public Instant predictionTime()
      Returns the value of the predictionTime record component.
      Returns:
      the value of the predictionTime record component

    • arrivalTime

      public Instant arrivalTime()
      Returns the value of the arrivalTime record component.
      Returns:
      the value of the arrivalTime record component

    • approaching

      public boolean approaching()
      Returns the value of the approaching record component.
      Returns:
      the value of the approaching record component

    • scheduled

      public boolean scheduled()
      Returns the value of the scheduled record component.
      Returns:
      the value of the scheduled record component

    • delayed

      public boolean delayed()
      Returns the value of the delayed record component.
      Returns:
      the value of the delayed record component

    • fault

      public boolean fault()
      Returns the value of the fault record component.
      Returns:
      the value of the fault record component

    • metadata

      public ArrivalMetadata metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component