io.buybrain.util

Class QueuedIterator<T>

java.lang.Object

io.buybrain.util.QueuedIterator<T>

Type Parameters:

T - the element type

All Implemented Interfaces:

Iterator<T>

public class QueuedIterator<T>
extends Object
implements Iterator<T>

An iterator backed by a queue that keeps producing values (or blocks) until it's explicitly ended. Useful for iterating over collections that don't fit in memory.

Constructor Summary

Constructors

Constructor and Description
QueuedIterator(int capacity) QueuedIterator constructor

Method Summary

Modifier and Type	Method and Description
void	done() Mark this iterator as done.
boolean	hasNext()
T	next()
void	put(T elem) Put the next value into this iterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

QueuedIterator

public QueuedIterator(int capacity)

QueuedIterator constructor

Parameters:

capacity - the maximum amount of queued elements before it starts blocking

Method Detail

put

public void put(T elem)

Put the next value into this iterator. May block if the internal queue is at max capacity.

Parameters:

elem - the value

done

public void done()

Mark this iterator as done. It will publish all messages queued before this call and then end.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>