Interface SkippingIterator<T>

    • Method Detail

      • skipTo

        boolean skipTo​(T theElement)
        Moves the iterators position to the next element which is greater than or equal to theElement.
        Returns:
        true, if such an element exists (in which case the Iterator.next() call will return it), false otherwise
      • skipTo

        default boolean skipTo​(T theElement,
                               T theBound)
        Same contract as skipTo(Object) but skipping is bounded: if the implementation can determine that the next element after target is greater than the bound, it can return false. In other words, if the method returns false, no element between the target (incl.) and the bound (incl.) exists. If the method returns true, the next element is definitely greater or equal than the target, but may exceed the bound. If the method returns false, there's no guarantee on the state of the iterator. If it needs to be reused, it must be first reset.
        Parameters:
        theElement - the target
        theBound - the bound. null means no upper bound.
        Returns:
        true, if an element that is greater than or equal to theElement but less than or equal to theBound exists.
      • comparator

        java.util.Comparator<T> comparator()
        Returns the comparator for this iterator that specifies the order in which the elements are returned.
      • estimatedSize

        long estimatedSize()
        Returns the estimated size of this iterator without advancing the iterator or UNKNOWN_SIZE if the estimate is not known. The estimate is for the whole iterator and will not change after the iterator is advanced. There is no guarantee about the accuracy of the estimate.