Package org.egothor.stemmer.trie

Record Class CompiledNode<V>

java.lang.Object
java.lang.Record
org.egothor.stemmer.trie.CompiledNode<V>
Type Parameters:
V - value type
Record Components:
edgeLabels - internal edge label array
children - internal child array
orderedValues - internal ordered values array
orderedCounts - internal ordered counts array
public record CompiledNode<V>(char[] edgeLabels, CompiledNode<V>[] children, V[] orderedValues, int[] orderedCounts) extends Record
Immutable compiled trie node optimized for read access.

The returned arrays are the internal backing storage of the compiled node. They are exposed for efficient access by closely related trie infrastructure and therefore must never be modified by callers. The node itself is still immutable from the public API perspective because construction wires these arrays once and all lookup operations thereafter treat them as read-only.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompiledNode(char[] edgeLabels, CompiledNode<V>[] children, V[] orderedValues, int... orderedCounts)
    Creates one validated compiled node.

  • Method Summary

    Modifier and Type
    Method
    Description
    CompiledNode<V>[]
    children()
    Returns the internal child-node array.
    char[]
    edgeLabels()
    Returns the internal edge-label array.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    CompiledNode<V>
    findChild(char edge)
    Finds a child for the supplied edge character.
    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

    • CompiledNode

      public CompiledNode(char[] edgeLabels, CompiledNode<V>[] children, V[] orderedValues, int... orderedCounts)
      Creates one validated compiled node.
      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

    • children

      public CompiledNode<V>[] children()
      Returns the internal child-node array.

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

      Returns:
      internal child-node 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

    • findChild

      public CompiledNode<V> findChild(char edge)
      Finds a child for the supplied edge character.
      Parameters:
      edge - edge character
      Returns:
      child node, or null if absent

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