Package org.egothor.stemmer.trie

Record Class NodeData<V>

java.lang.Object
java.lang.Record
org.egothor.stemmer.trie.NodeData<V>
Type Parameters:
V - value type
Record Components:
edgeLabels - edge labels
childNodeIds - child node identifiers
orderedValues - ordered values
orderedCounts - ordered counts
public record NodeData<V>(char[] edgeLabels, int[] childNodeIds, V[] orderedValues, int[] orderedCounts) extends Record
Intermediate node data used during deserialization before child references are resolved.

The arrays exposed by the accessors are the internal backing storage of this holder. They are returned directly for efficiency because the deserialization pipeline copies references into immutable compiled nodes immediately after the record is created. Callers must therefore treat every returned array as read-only.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NodeData(char[] edgeLabels, int[] childNodeIds, V[] orderedValues, int... orderedCounts)
    Creates one validated node-data holder.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    childNodeIds()
    Returns the internal child-node identifier array.
    char[]
    edgeLabels()
    Returns the internal edge-label array.
    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[]
    orderedCounts()
    Returns the internal ordered-counts array.
    V[]
    orderedValues()
    Returns the internal ordered-values array.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • NodeData

      public NodeData(char[] edgeLabels, int[] childNodeIds, V[] orderedValues, int... orderedCounts)
      Creates one validated node-data holder.
      Throws:
      NullPointerException - if any array argument is null
      IllegalArgumentException - if the edge-related arrays or value-related arrays do not have matching lengths

  • Method Details

    • edgeLabels

      public char[] edgeLabels()
      Returns the internal edge-label array.

      The returned array is not copied for performance reasons and must be treated as read-only.

      Returns:
      internal edge-label array

    • childNodeIds

      public int[] childNodeIds()
      Returns the internal child-node identifier array.

      The returned array is not copied for performance reasons and must be treated as read-only.

      Returns:
      internal child-node identifier array

    • orderedValues

      public V[] orderedValues()
      Returns the internal ordered-values array.

      The returned array is not copied for performance reasons and must be treated as read-only.

      Returns:
      internal ordered-values array

    • orderedCounts

      public int[] orderedCounts()
      Returns the internal ordered-counts array.

      The returned array is not copied for performance reasons and must be treated as read-only.

      Returns:
      internal ordered-counts array

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