Package com.google.common.collect
Class ConsumingQueueIterator<T>
- java.lang.Object
-
- com.google.common.collect.UnmodifiableIterator<T>
-
- com.google.common.collect.AbstractIterator<T>
-
- com.google.common.collect.ConsumingQueueIterator<T>
-
- All Implemented Interfaces:
java.util.Iterator<T>
class ConsumingQueueIterator<T> extends AbstractIterator<T>
An Iterator implementation which draws elements from a queue, removing them from the queue as it iterates.
-
-
Constructor Summary
Constructors Constructor Description ConsumingQueueIterator(java.util.Queue<T> queue)
ConsumingQueueIterator(T... elements)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description T
computeNext()
Returns the next element.-
Methods inherited from class com.google.common.collect.AbstractIterator
endOfData, hasNext, next, peek
-
Methods inherited from class com.google.common.collect.UnmodifiableIterator
remove
-
-
-
-
Field Detail
-
queue
private final java.util.Queue<T> queue
-
-
Method Detail
-
computeNext
public T computeNext()
Description copied from class:AbstractIterator
Returns the next element. Note: the implementation must callAbstractIterator.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()
orAbstractIterator.next()
calls this method, as does the first invocation ofhasNext
ornext
following each successful call tonext
. Once the implementation either invokesendOfData
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
ornext
invocation that invoked this method. Any further attempts to use the iterator will result in anIllegalStateException
.The implementation of this method may not invoke the
hasNext
,next
, orAbstractIterator.peek()
methods on this instance; if it does, anIllegalStateException
will result.- Specified by:
computeNext
in classAbstractIterator<T>
- Returns:
- the next element if there was one. If
endOfData
was called during execution, the return value will be ignored.
-
-