Package org.teleight.teleightbots.api.objects

Record Class ProximityAlertTriggered

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.ProximityAlertTriggered
All Implemented Interfaces:
Serializable, ApiResult
public record ProximityAlertTriggered(User traveler, User watcher, int distance) extends Record implements ApiResult
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProximityAlertTriggered(User traveler, User watcher, int distance)
    Creates an instance of a ProximityAlertTriggered record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    distance()
    Returns the value of the distance record component.
    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.
    final String
    toString()
    Returns a string representation of this record class.
    User
    traveler()
    Returns the value of the traveler record component.
    User
    watcher()
    Returns the value of the watcher record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProximityAlertTriggered

      public ProximityAlertTriggered(User traveler, User watcher, int distance)
      Creates an instance of a ProximityAlertTriggered record class.
      Parameters:
      traveler - the value for the traveler record component
      watcher - the value for the watcher record component
      distance - the value for the distance 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.

    • traveler

      public User traveler()
      Returns the value of the traveler record component.
      Returns:
      the value of the traveler record component

    • watcher

      public User watcher()
      Returns the value of the watcher record component.
      Returns:
      the value of the watcher record component

    • distance

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