Module org.apache.lucene.core
Package org.apache.lucene.util

Interface BytesRefIterator

All Known Subinterfaces:
BytesRefArray.IndexedBytesRefIterator, InputIterator
All Known Implementing Classes:
AutomatonTermsEnum, BaseTermsEnum, BlockReader, BlockTermsReader.FieldReader.SegmentTermsEnum, BloomFilteringPostingsFormat.BloomFilteredFieldsProducer.BloomFilteredTermsEnum, BufferedInputIterator, DirectPostingsFormat.DirectField.DirectIntersectTermsEnum, DirectPostingsFormat.DirectField.DirectTermsEnum, DocumentDictionary.DocumentInputIterator, DocumentValueSourceDictionary.DocumentValueSourceInputIterator, DocValuesConsumer.BitsFilteredTermsEnum, DocValuesConsumer.MergedTermsEnum, ExitableDirectoryReader.ExitableTermsEnum, ExternalRefSorter.ByteSequenceIterator, FieldTermIterator, FileDictionary.FileIterator, FilteredTermsEnum, FilterLeafReader.FilterTermsEnum, FreqProxFields.FreqProxTermsEnum, FreqProxTermsWriter.SortingTermsEnum, FSTTermsReader.TermsReader.BaseTermsEnum, FSTTermsReader.TermsReader.IntersectTermsEnum, FSTTermsReader.TermsReader.SegmentTermsEnum, FuzzyTermsEnum, HighFrequencyDictionary.HighFrequencyIterator, IDVersionSegmentTermsEnum, InputIterator.InputIteratorWrapper, IntersectBlockReader, IntersectTermsEnum, IntersectTermsEnum, Lucene50CompressingTermVectorsReader.TVTermsEnum, Lucene70DocValuesProducer.TermsDict, Lucene80DocValuesProducer.TermsDict, Lucene90CompressingTermVectorsReader.TVTermsEnum, Lucene90DocValuesProducer.TermsDict, MappedMultiFields.MappedMultiTermsEnum, MemoryIndex.MemoryIndexReader.MemoryTermsEnum, MultiTermsEnum, OfflineSorter.ByteSequencesReader, OrdsIntersectTermsEnum, OrdsSegmentTermsEnum, PlainTextDictionary.FileIterator, PointInSetIncludingScoreQuery.Stream, PointInSetQuery.Stream, PrefixCodedTerms.TermIterator, SeekingTermSetTermsEnum, SegmentTermsEnum, SegmentTermsEnum, SimpleTextFieldsReader.SimpleTextTermsEnum, SimpleTextTermVectorsReader.SimpleTVTermsEnum, SingleTermsEnum, SortedDocValuesTermsEnum, SortedInputIterator, SortedSetDocValuesTermsEnum, STBlockReader, STIntersectBlockReader, STMergingBlockReader, STMergingTermsEnum, TermFilteredPresearcher.BytesRefHashIterator, TermInSetQuery.SetEnum, TermsEnum, TermVectorFilteredLeafReader.TermVectorFilteredTermsEnum, UnsortedInputIterator, WFSTCompletionLookup.WFSTInputIterator
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.