TermsIndexWriterBase.FieldWriter (Lucene 10.5.1 codecs API)
Description: declaration: package: org.apache.lucene.codecs.blockterms, class: TermsIndexWriterBase, class: FieldWriter

Package org.apache.lucene.codecs.blockterms

# Class TermsIndexWriterBase.FieldWriter

java.lang.Object
org.apache.lucene.codecs.blockterms.TermsIndexWriterBase.FieldWriter

Enclosing class:
  `TermsIndexWriterBase`

public abstract class TermsIndexWriterBase.FieldWriter extends Object
Terms index API for a single field.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FieldWriter()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract void`
  `add(BytesRef text, TermStats stats, long termsFilePointer)`
  `abstract boolean`
  `checkIndexTerm(BytesRef text, TermStats stats)`
  `abstract void`
  `finish(long termsFilePointer)`

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

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

- ## Constructor Details

  - ### FieldWriter

    public FieldWriter()

- ## Method Details

  - ### checkIndexTerm

    public abstract boolean checkIndexTerm(BytesRef text, TermStats stats) throws IOException
    Throws:
      `IOException`

  - ### add

    public abstract void add(BytesRef text, TermStats stats, long termsFilePointer) throws IOException
    Throws:
      `IOException`

  - ### finish

    public abstract void finish(long termsFilePointer) throws IOException
    Throws:
      `IOException`