BytesRefIterator (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.util, interface: BytesRefIterator

Package org.apache.lucene.util

# Interface BytesRefIterator

All Known Subinterfaces:
  `BytesRefArray.IndexedBytesRefIterator`

All Known Implementing Classes:
  `AutomatonTermsEnum`, `BaseTermsEnum`, `ExitableDirectoryReader.ExitableTermsEnum`, `FilteredTermsEnum`, `FilterLeafReader.FilterTermsEnum`, `FuzzyTermsEnum`, `MultiTermsEnum`, `OfflineSorter.ByteSequencesReader`, `PointInSetQuery.Stream`, `PrefixCodedTerms.TermIterator`, `SingleTermsEnum`, `TermsEnum`

public interface BytesRefIterator
A simple iterator interface for `BytesRef` iteration.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final BytesRefIterator`
  `EMPTY`
  Singleton BytesRefIterator that iterates over 0 BytesRefs.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `BytesRef`
  `next()`
  Increments the iteration to the next `BytesRef` in the iterator.

- ## Field Details

  - ### EMPTY

    static final BytesRefIterator EMPTY
    Singleton BytesRefIterator that iterates over 0 BytesRefs.

- ## Method Details

  - ### next

    BytesRef next() throws IOException
    Increments the iteration to the next `BytesRef` in the iterator. Returns the resulting `BytesRef` or `null` if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.
    Returns:
      the next `BytesRef` in the iterator or `null` if the end of the iterator is reached.
    Throws:
      `IOException` - If there is a low-level I/O error.