Package com.mrbysco.spellchecker.util

Record Class LocationData

java.lang.Object
java.lang.Record
com.mrbysco.spellchecker.util.LocationData
public record LocationData(String word, String wordsUntil) extends Record

  • Constructor Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LocationData

      public LocationData(String word, String wordsUntil)
      Creates an instance of a LocationData record class.
      Parameters:
      word - the value for the word record component
      wordsUntil - the value for the wordsUntil 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • word

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

    • wordsUntil

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