Record Class GameHighScore

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.GameHighScore
All Implemented Interfaces:
Serializable, ApiResult
public record GameHighScore(int position, @NotNull User user, int score) extends Record implements ApiResult
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    GameHighScore(int position, @NotNull User user, int score)
    Creates an instance of a GameHighScore 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
    position()
    Returns the value of the position record component.
    int
    score()
    Returns the value of the score record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull User
    user()
    Returns the value of the user record component.

    Methods inherited from class Object

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

  • Constructor Details

    • GameHighScore

      public GameHighScore(int position, @NotNull @NotNull User user, int score)
      Creates an instance of a GameHighScore record class.
      Parameters:
      position - the value for the position record component
      user - the value for the user record component
      score - the value for the score 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 the compare method from their corresponding wrapper classes.
      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.

    • position

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

    • user

      @NotNull public @NotNull User user()
      Returns the value of the user record component.
      Returns:
      the value of the user record component

    • score

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