Interface BytesRefSorter

  • All Known Implementing Classes:
    ExternalRefSorter, InMemorySorter

    public interface BytesRefSorter
    Collects BytesRef and then allows one to iterate over their sorted order. Implementations of this interface will be called in a single-threaded scenario.
    • Method Detail

      • add

        void add​(BytesRef utf8)
          throws java.io.IOException,
                 java.lang.IllegalStateException
        Adds a single suggestion entry (possibly compound with its bucket).
        Throws:
        java.io.IOException - If an I/O exception occurs.
        java.lang.IllegalStateException - If an addition attempt is performed after a call to iterator() has been made.
      • iterator

        BytesRefIterator iterator()
                           throws java.io.IOException
        Sorts the entries added in add(BytesRef) and returns an iterator over all sorted entries.
        Throws:
        java.io.IOException - If an I/O exception occurs.
      • getComparator

        java.util.Comparator<BytesRef> getComparator()
        Comparator used to determine the sort order of entries.