Module org.apache.lucene.analysis.common
Package org.apache.lucene.analysis.hunspell

Record Class Root<T extends CharSequence>

java.lang.Object
java.lang.Record
org.apache.lucene.analysis.hunspell.Root<T>
All Implemented Interfaces:
Comparable<Root<T>>
record Root<T extends CharSequence>(T extends CharSequence word, int entryId) extends Record implements Comparable<Root<T>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    entryId
    The field for the entryId record component.
    private final T
    word
    The field for the word record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Root(T word, int entryId)
    Creates an instance of a Root record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(Root<T> o)
     
    int
    entryId()
    Returns the value of the entryId 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.
    String
    toString()
    Returns a string representation of this record class.
    T
    word()
    Returns the value of the word record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • word

      private final T extends CharSequence word
      The field for the word record component.

    • entryId

      private final int entryId
      The field for the entryId record component.

  • Constructor Details

    • Root

      Root(T word, int entryId)
      Creates an instance of a Root record class.
      Parameters:
      word - the value for the word record component
      entryId - the value for the entryId record component

  • Method Details

    • toString

      public 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

    • compareTo

      public int compareTo(Root<T> o)
      Specified by:
      compareTo in interface Comparable<T extends CharSequence>

    • 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.

    • word

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

    • entryId

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