Module cta4j.java.sdk
Package com.cta4j.bus.model

Record Class Detour

java.lang.Object
java.lang.Record
com.cta4j.bus.model.Detour
Record Components:
id - the unique identifier of the detour
version - the version number of the detour
active - whether the detour is currently active
description - a description of the detour
routeDirections - the list of route directions affected by the detour
startTime - the start time of the detour
endTime - the end time of the detour
public record Detour(String id, String version, Boolean active, String description, List<DetourRouteDirection> routeDirections, Instant startTime, Instant endTime) extends Record
A detour affecting one or more bus routes.

  • Constructor Details

    • Detour

      public Detour(String id, String version, Boolean active, String description, List<DetourRouteDirection> routeDirections, Instant startTime, Instant endTime)
      Creates an instance of a Detour record class.
      Parameters:
      id - the value for the id record component
      version - the value for the version record component
      active - the value for the active record component
      description - the value for the description record component
      routeDirections - the value for the routeDirections record component
      startTime - the value for the startTime record component
      endTime - the value for the endTime record component

  • 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

    • version

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

    • active

      public Boolean active()
      Returns the value of the active record component.
      Returns:
      the value of the active record component

    • description

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

    • routeDirections

      public List<DetourRouteDirection> routeDirections()
      Returns the value of the routeDirections record component.
      Returns:
      the value of the routeDirections record component

    • startTime

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

    • endTime

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