FixedGapTermsIndexReader (Lucene 10.5.0 codecs API)
Description: declaration: package: org.apache.lucene.codecs.blockterms, class: FixedGapTermsIndexReader

Package org.apache.lucene.codecs.blockterms

# Class FixedGapTermsIndexReader

java.lang.Object
org.apache.lucene.codecs.blockterms.TermsIndexReaderBase
org.apache.lucene.codecs.blockterms.FixedGapTermsIndexReader

All Implemented Interfaces:
  `Closeable`, `AutoCloseable`

public class FixedGapTermsIndexReader extends TermsIndexReaderBase
TermsIndexReader for simple every Nth terms indexes.

See Also:
  - `FixedGapTermsIndexWriter`
WARNING: This API is experimental and might change in incompatible ways in the next release.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class org.apache.lucene.codecs.blockterms.TermsIndexReaderBase

  `TermsIndexReaderBase.FieldIndexEnum`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FixedGapTermsIndexReader(SegmentReadState state)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `close()`
  `TermsIndexReaderBase.FieldIndexEnum`
  `getFieldEnum(FieldInfo fieldInfo)`
  `boolean`
  `supportsOrd()`
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### FixedGapTermsIndexReader

    public FixedGapTermsIndexReader(SegmentReadState state) throws IOException
    Throws:
      `IOException`

- ## Method Details

  - ### supportsOrd

    public boolean supportsOrd()
    Specified by:
      `supportsOrd` in class `TermsIndexReaderBase`

  - ### getFieldEnum

    public TermsIndexReaderBase.FieldIndexEnum getFieldEnum(FieldInfo fieldInfo)
    Specified by:
      `getFieldEnum` in class `TermsIndexReaderBase`

  - ### close

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

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`