Package com.cta4j.common.geo

Record Class Coordinates

java.lang.Object
java.lang.Record
com.cta4j.common.geo.Coordinates
Record Components:
latitude - the latitude of these coordinates
longitude - the longitude of these coordinates
heading - the heading of these coordinates in degrees (0-359)
@NullMarked public record Coordinates(BigDecimal latitude, BigDecimal longitude, int heading) extends Record
Represents geographic coordinates.

  • Constructor Details

    • Coordinates

      public Coordinates(BigDecimal latitude, BigDecimal longitude, int heading)
      Constructs a Coordinates.
      Parameters:
      latitude - the latitude of the coordinates
      longitude - the longitude of the coordinates
      heading - the heading of the coordinates in degrees (0-359)
      Throws:
      NullPointerException - if latitude or longitude is null
      IllegalArgumentException - if latitude is not between -90 and 90 (inclusive), longitude is not between -180 and 180 (inclusive), or heading is not between 0 and 359 (inclusive)

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

    • 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

    • heading

      public int heading()
      Returns the value of the heading record component.
      Returns:
      the value of the heading record component