Package org.apache.lucene.util
Interface BytesRefIterator
- All Known Implementing Classes:
FilterAtomicReader.FilterTermsEnum
,FilteredTermsEnum
,FuzzyTermsEnum
,MultiTermsEnum
,PrefixTermsEnum
,SingleTermsEnum
,TermRangeTermsEnum
,TermsEnum
public interface BytesRefIterator
A simple iterator interface for
BytesRef
iteration.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BytesRefIterator
Singleton BytesRefIterator that iterates over 0 BytesRefs. -
Method Summary
-
Field Details
-
EMPTY
Singleton BytesRefIterator that iterates over 0 BytesRefs.
-
-
Method Details
-
next
Increments the iteration to the nextBytesRef
in the iterator. Returns the resultingBytesRef
ornull
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 ornull
if the end of the iterator is reached. - Throws:
IOException
- If there is a low-level I/O error.
-
getComparator
Comparator<BytesRef> getComparator()Return theBytesRef
Comparator used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.
-