Package com.cta4j.bus.stop.model

Record Class Stop

java.lang.Object
java.lang.Record
com.cta4j.bus.stop.model.Stop
Record Components:
id - the unique identifier of this stop
name - the display name of this stop (e.g. "Madison and Clark")
latitude - the latitude coordinate of this stop
longitude - the longitude coordinate of this stop
detoursAdded - the List of detour IDs which temporarily add service to this stop
detoursRemoved - the List of detour IDs which temporarily remove service from this stop
gtfsSequence - the GTFS sequence number of this stop, if applicable
adaAccessible - whether this stop is ADA accessible, if known
@NullMarked public record Stop(String id, String name, BigDecimal latitude, BigDecimal longitude, @Nullable List<Integer> detoursAdded, @Nullable List<Integer> detoursRemoved, @Nullable Integer gtfsSequence, @Nullable Boolean adaAccessible) extends Record
Represents a bus stop.

NOTE: gtfsSequence is not well-documented by the CTA. As such, its presence here is primarily for completeness and may not be populated or described correctly.

  • Constructor Details

    • Stop

      public Stop(String id, String name, BigDecimal latitude, BigDecimal longitude, @Nullable List<Integer> detoursAdded, @Nullable List<Integer> detoursRemoved, @Nullable Integer gtfsSequence, @Nullable Boolean adaAccessible)
      Constructs a Stop.
      Parameters:
      id - the unique identifier of the stop
      name - the display name of the stop (e.g. "Madison and Clark")
      latitude - the latitude coordinate of the stop
      longitude - the longitude coordinate of the stop
      detoursAdded - the List of detour IDs which temporarily add service to the stop
      detoursRemoved - the List of detour IDs which temporarily remove service from the stop
      gtfsSequence - the GTFS sequence number of the stop, if applicable
      adaAccessible - whether the stop is ADA accessible, if known
      Throws:
      NullPointerException - if id, name, latitude, or longitude is null, or if any element of detoursAdded or detoursRemoved 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. 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.

    • id

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

    • name

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

    • latitude

      public BigDecimal latitude()
      Returns the value of the latitude record component.
      Returns:
      the value of the latitude record component

    • longitude

      public BigDecimal longitude()
      Returns the value of the longitude record component.
      Returns:
      the value of the longitude record component

    • detoursAdded

      public @Nullable List<Integer> detoursAdded()
      Returns the value of the detoursAdded record component.
      Returns:
      the value of the detoursAdded record component

    • detoursRemoved

      public @Nullable List<Integer> detoursRemoved()
      Returns the value of the detoursRemoved record component.
      Returns:
      the value of the detoursRemoved record component

    • gtfsSequence

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

    • adaAccessible

      public @Nullable Boolean adaAccessible()
      Returns the value of the adaAccessible record component.
      Returns:
      the value of the adaAccessible record component