Module org.apache.lucene.core
Package org.apache.lucene.index

Record Class SortingCodecReader.SortingBits

java.lang.Object
java.lang.Record
org.apache.lucene.index.SortingCodecReader.SortingBits
All Implemented Interfaces:
Bits
Enclosing class:
SortingCodecReader
private static record SortingCodecReader.SortingBits(Bits in, Sorter.DocMap docMap) extends Record implements Bits

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.lucene.util.Bits

    Bits.MatchAllBits, Bits.MatchNoBits

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Sorter.DocMap
    docMap
    The field for the docMap record component.
    private final Bits
    in
    The field for the in record component.

    Fields inherited from interface org.apache.lucene.util.Bits

    EMPTY_ARRAY

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    SortingBits(Bits in, Sorter.DocMap docMap)
    Creates an instance of a SortingBits record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Sorter.DocMap
    docMap()
    Returns the value of the docMap record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    get(int index)
    Returns the value of the bit with the specified index.
    final int
    hashCode()
    Returns a hash code value for this object.
    Bits
    in()
    Returns the value of the in record component.
    int
    length()
    Returns the number of bits in this set
    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

    • in

      private final Bits in
      The field for the in record component.

    • docMap

      private final Sorter.DocMap docMap
      The field for the docMap record component.

  • Constructor Details

    • SortingBits

      private SortingBits(Bits in, Sorter.DocMap docMap)
      Creates an instance of a SortingBits record class.
      Parameters:
      in - the value for the in record component
      docMap - the value for the docMap record component

  • Method Details

    • get

      public boolean get(int index)
      Description copied from interface: Bits
      Returns the value of the bit with the specified index.
      Specified by:
      get in interface Bits
      Parameters:
      index - index, should be non-negative and < Bits.length(). The result of passing negative or out of bounds values is undefined by this interface, just don't do it!
      Returns:
      true if the bit is set, false otherwise.

    • length

      public int length()
      Description copied from interface: Bits
      Returns the number of bits in this set
      Specified by:
      length in interface Bits

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

    • in

      public Bits in()
      Returns the value of the in record component.
      Returns:
      the value of the in record component

    • docMap

      public Sorter.DocMap docMap()
      Returns the value of the docMap record component.
      Returns:
      the value of the docMap record component