Record Class ValueCount<V>

java.lang.Object
java.lang.Record
org.egothor.stemmer.ValueCount<V>
Type Parameters:
V - value type
Record Components:
value - stored value
count - occurrence count associated with the value

public record ValueCount<V>(V value, int count) extends Record
Immutable value-count pair returned by read-only trie queries.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ValueCount(V value, int count)
    Creates a new value-count pair.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the value of the count record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ValueCount

      public ValueCount(V value, int count)
      Creates a new value-count pair.
      Parameters:
      value - stored value
      count - occurrence count
      Throws:
      NullPointerException - if value is null
      IllegalArgumentException - if count is negative
  • 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 '=='.
      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.
    • value

      public V value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component
    • count

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