Record Class SuggestionInfo

java.lang.Object
java.lang.Record
com.mrbysco.spellchecker.util.SuggestionInfo
public record SuggestionInfo(int posX, int posY, List<String> suggestions, String word) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    SuggestionInfo(int posX, int posY, List<String> suggestions, String word)
    Creates an instance of a SuggestionInfo 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
    posX()
    Returns the value of the posX record component.
    int
    posY()
    Returns the value of the posY record component.
    List<String>
    suggestions()
    Returns the value of the suggestions record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    word()
    Returns the value of the word record component.

    Methods inherited from class Object

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

  • Constructor Details

    • SuggestionInfo

      public SuggestionInfo(int posX, int posY, List<String> suggestions, String word)
      Creates an instance of a SuggestionInfo record class.
      Parameters:
      posX - the value for the posX record component
      posY - the value for the posY record component
      suggestions - the value for the suggestions record component
      word - the value for the word 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.

    • posX

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

    • posY

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

    • suggestions

      public List<String> suggestions()
      Returns the value of the suggestions record component.
      Returns:
      the value of the suggestions record component

    • word

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