Package com.google.common.collect

Class ConsumingQueueIterator<T>

  • All Implemented Interfaces:
    java.util.Iterator<T>
    @GwtCompatible
class ConsumingQueueIterator<T>
extends AbstractIterator<T>
    An Iterator implementation which draws elements from a queue, removing them from the queue as it iterates.

    • Field Detail

      • queue

        private final java.util.Queue<T> queue

    • Constructor Detail

      • ConsumingQueueIterator

        ConsumingQueueIterator​(T... elements)

      • ConsumingQueueIterator

        ConsumingQueueIterator​(java.util.Queue<T> queue)

    • Method Detail

      • computeNext

        public T computeNext()
        Description copied from class: AbstractIterator
        Returns the next element. Note: the implementation must call AbstractIterator.endOfData() when there are no elements left in the iteration. Failure to do so could result in an infinite loop.

        The initial invocation of AbstractIterator.hasNext() or AbstractIterator.next() calls this method, as does the first invocation of hasNext or next following each successful call to next. Once the implementation either invokes endOfData or throws an exception, computeNext is guaranteed to never be called again.

        If this method throws an exception, it will propagate outward to the hasNext or next invocation that invoked this method. Any further attempts to use the iterator will result in an IllegalStateException.

        The implementation of this method may not invoke the hasNext, next, or AbstractIterator.peek() methods on this instance; if it does, an IllegalStateException will result.

        Specified by:
        computeNext in class AbstractIterator<T>
        Returns:
        the next element if there was one. If endOfData was called during execution, the return value will be ignored.