Package org.teleight.teleightbots.api.objects

Record Class Location

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.Location
All Implemented Interfaces:
Serializable, ApiResult
public record Location(Float longitude, Float latitude, @Nullable Float horizontalAccuracy, int livePeriod, int heading, int proximityAlertRadius) extends Record implements ApiResult
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Location(Float longitude, Float latitude, @Nullable Float horizontalAccuracy, int livePeriod, int heading, int proximityAlertRadius)
    Creates an instance of a Location record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    heading()
    Returns the value of the heading record component.
    @Nullable Float
    horizontalAccuracy()
    Returns the value of the horizontalAccuracy record component.
    Float
    latitude()
    Returns the value of the latitude record component.
    int
    livePeriod()
    Returns the value of the livePeriod record component.
    Float
    longitude()
    Returns the value of the longitude record component.
    int
    proximityAlertRadius()
    Returns the value of the proximityAlertRadius record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Location

      public Location(Float longitude, Float latitude, @Nullable @Nullable Float horizontalAccuracy, int livePeriod, int heading, int proximityAlertRadius)
      Creates an instance of a Location record class.
      Parameters:
      longitude - the value for the longitude record component
      latitude - the value for the latitude record component
      horizontalAccuracy - the value for the horizontalAccuracy record component
      livePeriod - the value for the livePeriod record component
      heading - the value for the heading record component
      proximityAlertRadius - the value for the proximityAlertRadius 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. 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.

    • longitude

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

    • latitude

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

    • horizontalAccuracy

      @Nullable public @Nullable Float horizontalAccuracy()
      Returns the value of the horizontalAccuracy record component.
      Returns:
      the value of the horizontalAccuracy record component

    • livePeriod

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

    • heading

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

    • proximityAlertRadius

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