Module org.apache.lucene.core
Package org.apache.lucene.codecs.perfield

Record Class PerFieldDocValuesFormat.ConsumerAndSuffix

java.lang.Object
java.lang.Record
org.apache.lucene.codecs.perfield.PerFieldDocValuesFormat.ConsumerAndSuffix
All Implemented Interfaces:
Closeable, AutoCloseable
Enclosing class:
PerFieldDocValuesFormat
static record PerFieldDocValuesFormat.ConsumerAndSuffix(DocValuesConsumer consumer, int suffix) extends Record implements Closeable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final DocValuesConsumer
    consumer
    The field for the consumer record component.
    private final int
    suffix
    The field for the suffix record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConsumerAndSuffix(DocValuesConsumer consumer, int suffix)
    Creates an instance of a ConsumerAndSuffix record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    DocValuesConsumer
    consumer()
    Returns the value of the consumer 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.
    int
    suffix()
    Returns the value of the suffix record component.
    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

  • Field Details

    • consumer

      private final DocValuesConsumer consumer
      The field for the consumer record component.

    • suffix

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

  • Constructor Details

    • ConsumerAndSuffix

      ConsumerAndSuffix(DocValuesConsumer consumer, int suffix)
      Creates an instance of a ConsumerAndSuffix record class.
      Parameters:
      consumer - the value for the consumer record component
      suffix - the value for the suffix record component

  • Method Details

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException

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

    • consumer

      public DocValuesConsumer consumer()
      Returns the value of the consumer record component.
      Returns:
      the value of the consumer record component

    • suffix

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