Module org.apache.lucene.codecs
Package org.apache.lucene.codecs.simpletext

Record Class SimpleTextLiveDocsFormat.SimpleTextBits

java.lang.Object
java.lang.Record
org.apache.lucene.codecs.simpletext.SimpleTextLiveDocsFormat.SimpleTextBits
All Implemented Interfaces:
Bits
Enclosing class:
SimpleTextLiveDocsFormat
static record SimpleTextLiveDocsFormat.SimpleTextBits(BitSet bits, int size) 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 BitSet
    bits
    The field for the bits record component.
    private final int
    size
    The field for the size record component.

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

    EMPTY_ARRAY

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleTextBits(BitSet bits, int size)
    Creates an instance of a SimpleTextBits record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    BitSet
    bits()
    Returns the value of the bits 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.
    int
    length()
    Returns the number of bits in this set
    int
    size()
    Returns the value of the size 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

    • bits

      private final BitSet bits
      The field for the bits record component.

    • size

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

  • Constructor Details

    • SimpleTextBits

      SimpleTextBits(BitSet bits, int size)
      Creates an instance of a SimpleTextBits record class.
      Parameters:
      bits - the value for the bits record component
      size - the value for the size 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. 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.

    • bits

      public BitSet bits()
      Returns the value of the bits record component.
      Returns:
      the value of the bits record component

    • size

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