Interface BytesRefIterator

    • 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.
        the next BytesRef in the iterator or null if the end of the iterator is reached.
        IOException - If there is a low-level I/O error.
      • getComparator

        Comparator<BytesRef> getComparator()
        Return the BytesRef 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.