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 and Description
    --- | ---
    `static BytesRefIterator` | `EMPTY` Singleton BytesRefIterator that iterates over 0 BytesRefs.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `BytesRef` | `next()` Increments the iteration to the next `BytesRef` in the iterator.

- - ### Field Detail

    - #### EMPTY

          static final BytesRefIterator EMPTY

      Singleton BytesRefIterator that iterates over 0 BytesRefs.

  - ### Method Detail

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

Copyright © 2000-2022 Apache Software Foundation. All Rights Reserved.