com.carrotsearch.hppcrt

Class AbstractIterator<E>

java.lang.Object

com.carrotsearch.hppcrt.AbstractIterator<E>

Type Parameters:

E -

All Implemented Interfaces:

java.util.Iterator<E>

Direct Known Subclasses:

ByteArrayDeque.DescendingValueIterator, ByteArrayDeque.ValueIterator, ByteArrayList.ValueIterator, ByteByteHashMap.EntryIterator, ByteByteHashMap.KeysIterator, ByteByteHashMap.ValuesIterator, ByteCharHashMap.EntryIterator, ByteCharHashMap.KeysIterator, ByteCharHashMap.ValuesIterator, ByteDoubleHashMap.EntryIterator, ByteDoubleHashMap.KeysIterator, ByteDoubleHashMap.ValuesIterator, ByteFloatHashMap.EntryIterator, ByteFloatHashMap.KeysIterator, ByteFloatHashMap.ValuesIterator, ByteHashSet.EntryIterator, ByteHeapPriorityQueue.ValueIterator, ByteIndexedHeapPriorityQueue.EntryIterator, ByteIndexedHeapPriorityQueue.KeysIterator, ByteIndexedHeapPriorityQueue.ValuesIterator, ByteIntHashMap.EntryIterator, ByteIntHashMap.KeysIterator, ByteIntHashMap.ValuesIterator, ByteLinkedList.ValueIterator, ByteLongHashMap.EntryIterator, ByteLongHashMap.KeysIterator, ByteLongHashMap.ValuesIterator, ByteObjectHashMap.EntryIterator, ByteObjectHashMap.KeysIterator, ByteObjectHashMap.ValuesIterator, ByteShortHashMap.EntryIterator, ByteShortHashMap.KeysIterator, ByteShortHashMap.ValuesIterator, CharArrayDeque.DescendingValueIterator, CharArrayDeque.ValueIterator, CharArrayList.ValueIterator, CharByteHashMap.EntryIterator, CharByteHashMap.KeysIterator, CharByteHashMap.ValuesIterator, CharCharHashMap.EntryIterator, CharCharHashMap.KeysIterator, CharCharHashMap.ValuesIterator, CharDoubleHashMap.EntryIterator, CharDoubleHashMap.KeysIterator, CharDoubleHashMap.ValuesIterator, CharFloatHashMap.EntryIterator, CharFloatHashMap.KeysIterator, CharFloatHashMap.ValuesIterator, CharHashSet.EntryIterator, CharHeapPriorityQueue.ValueIterator, CharIndexedHeapPriorityQueue.EntryIterator, CharIndexedHeapPriorityQueue.KeysIterator, CharIndexedHeapPriorityQueue.ValuesIterator, CharIntHashMap.EntryIterator, CharIntHashMap.KeysIterator, CharIntHashMap.ValuesIterator, CharLinkedList.ValueIterator, CharLongHashMap.EntryIterator, CharLongHashMap.KeysIterator, CharLongHashMap.ValuesIterator, CharObjectHashMap.EntryIterator, CharObjectHashMap.KeysIterator, CharObjectHashMap.ValuesIterator, CharShortHashMap.EntryIterator, CharShortHashMap.KeysIterator, CharShortHashMap.ValuesIterator, DoubleArrayDeque.DescendingValueIterator, DoubleArrayDeque.ValueIterator, DoubleArrayList.ValueIterator, DoubleByteHashMap.EntryIterator, DoubleByteHashMap.KeysIterator, DoubleByteHashMap.ValuesIterator, DoubleCharHashMap.EntryIterator, DoubleCharHashMap.KeysIterator, DoubleCharHashMap.ValuesIterator, DoubleDoubleHashMap.EntryIterator, DoubleDoubleHashMap.KeysIterator, DoubleDoubleHashMap.ValuesIterator, DoubleFloatHashMap.EntryIterator, DoubleFloatHashMap.KeysIterator, DoubleFloatHashMap.ValuesIterator, DoubleHashSet.EntryIterator, DoubleHeapPriorityQueue.ValueIterator, DoubleIndexedHeapPriorityQueue.EntryIterator, DoubleIndexedHeapPriorityQueue.KeysIterator, DoubleIndexedHeapPriorityQueue.ValuesIterator, DoubleIntHashMap.EntryIterator, DoubleIntHashMap.KeysIterator, DoubleIntHashMap.ValuesIterator, DoubleLinkedList.ValueIterator, DoubleLongHashMap.EntryIterator, DoubleLongHashMap.KeysIterator, DoubleLongHashMap.ValuesIterator, DoubleObjectHashMap.EntryIterator, DoubleObjectHashMap.KeysIterator, DoubleObjectHashMap.ValuesIterator, DoubleShortHashMap.EntryIterator, DoubleShortHashMap.KeysIterator, DoubleShortHashMap.ValuesIterator, FloatArrayDeque.DescendingValueIterator, FloatArrayDeque.ValueIterator, FloatArrayList.ValueIterator, FloatByteHashMap.EntryIterator, FloatByteHashMap.KeysIterator, FloatByteHashMap.ValuesIterator, FloatCharHashMap.EntryIterator, FloatCharHashMap.KeysIterator, FloatCharHashMap.ValuesIterator, FloatDoubleHashMap.EntryIterator, FloatDoubleHashMap.KeysIterator, FloatDoubleHashMap.ValuesIterator, FloatFloatHashMap.EntryIterator, FloatFloatHashMap.KeysIterator, FloatFloatHashMap.ValuesIterator, FloatHashSet.EntryIterator, FloatHeapPriorityQueue.ValueIterator, FloatIndexedHeapPriorityQueue.EntryIterator, FloatIndexedHeapPriorityQueue.KeysIterator, FloatIndexedHeapPriorityQueue.ValuesIterator, FloatIntHashMap.EntryIterator, FloatIntHashMap.KeysIterator, FloatIntHashMap.ValuesIterator, FloatLinkedList.ValueIterator, FloatLongHashMap.EntryIterator, FloatLongHashMap.KeysIterator, FloatLongHashMap.ValuesIterator, FloatObjectHashMap.EntryIterator, FloatObjectHashMap.KeysIterator, FloatObjectHashMap.ValuesIterator, FloatShortHashMap.EntryIterator, FloatShortHashMap.KeysIterator, FloatShortHashMap.ValuesIterator, IntArrayDeque.DescendingValueIterator, IntArrayDeque.ValueIterator, IntArrayList.ValueIterator, IntByteHashMap.EntryIterator, IntByteHashMap.KeysIterator, IntByteHashMap.ValuesIterator, IntCharHashMap.EntryIterator, IntCharHashMap.KeysIterator, IntCharHashMap.ValuesIterator, IntDoubleHashMap.EntryIterator, IntDoubleHashMap.KeysIterator, IntDoubleHashMap.ValuesIterator, IntFloatHashMap.EntryIterator, IntFloatHashMap.KeysIterator, IntFloatHashMap.ValuesIterator, IntHashSet.EntryIterator, IntHeapPriorityQueue.ValueIterator, IntIndexedHeapPriorityQueue.EntryIterator, IntIndexedHeapPriorityQueue.KeysIterator, IntIndexedHeapPriorityQueue.ValuesIterator, IntIntHashMap.EntryIterator, IntIntHashMap.KeysIterator, IntIntHashMap.ValuesIterator, IntLinkedList.ValueIterator, IntLongHashMap.EntryIterator, IntLongHashMap.KeysIterator, IntLongHashMap.ValuesIterator, IntObjectHashMap.EntryIterator, IntObjectHashMap.KeysIterator, IntObjectHashMap.ValuesIterator, IntShortHashMap.EntryIterator, IntShortHashMap.KeysIterator, IntShortHashMap.ValuesIterator, LongArrayDeque.DescendingValueIterator, LongArrayDeque.ValueIterator, LongArrayList.ValueIterator, LongByteHashMap.EntryIterator, LongByteHashMap.KeysIterator, LongByteHashMap.ValuesIterator, LongCharHashMap.EntryIterator, LongCharHashMap.KeysIterator, LongCharHashMap.ValuesIterator, LongDoubleHashMap.EntryIterator, LongDoubleHashMap.KeysIterator, LongDoubleHashMap.ValuesIterator, LongFloatHashMap.EntryIterator, LongFloatHashMap.KeysIterator, LongFloatHashMap.ValuesIterator, LongHashSet.EntryIterator, LongHeapPriorityQueue.ValueIterator, LongIndexedHeapPriorityQueue.EntryIterator, LongIndexedHeapPriorityQueue.KeysIterator, LongIndexedHeapPriorityQueue.ValuesIterator, LongIntHashMap.EntryIterator, LongIntHashMap.KeysIterator, LongIntHashMap.ValuesIterator, LongLinkedList.ValueIterator, LongLongHashMap.EntryIterator, LongLongHashMap.KeysIterator, LongLongHashMap.ValuesIterator, LongObjectHashMap.EntryIterator, LongObjectHashMap.KeysIterator, LongObjectHashMap.ValuesIterator, LongShortHashMap.EntryIterator, LongShortHashMap.KeysIterator, LongShortHashMap.ValuesIterator, ObjectArrayDeque.DescendingValueIterator, ObjectArrayDeque.ValueIterator, ObjectArrayList.ValueIterator, ObjectByteHashMap.EntryIterator, ObjectByteHashMap.KeysIterator, ObjectByteHashMap.ValuesIterator, ObjectCharHashMap.EntryIterator, ObjectCharHashMap.KeysIterator, ObjectCharHashMap.ValuesIterator, ObjectDoubleHashMap.EntryIterator, ObjectDoubleHashMap.KeysIterator, ObjectDoubleHashMap.ValuesIterator, ObjectFloatHashMap.EntryIterator, ObjectFloatHashMap.KeysIterator, ObjectFloatHashMap.ValuesIterator, ObjectHashSet.EntryIterator, ObjectHeapPriorityQueue.ValueIterator, ObjectIndexedHeapPriorityQueue.EntryIterator, ObjectIndexedHeapPriorityQueue.KeysIterator, ObjectIndexedHeapPriorityQueue.ValuesIterator, ObjectIntHashMap.EntryIterator, ObjectIntHashMap.KeysIterator, ObjectIntHashMap.ValuesIterator, ObjectLinkedList.ValueIterator, ObjectLongHashMap.EntryIterator, ObjectLongHashMap.KeysIterator, ObjectLongHashMap.ValuesIterator, ObjectObjectHashMap.EntryIterator, ObjectObjectHashMap.KeysIterator, ObjectObjectHashMap.ValuesIterator, ObjectShortHashMap.EntryIterator, ObjectShortHashMap.KeysIterator, ObjectShortHashMap.ValuesIterator, ShortArrayDeque.DescendingValueIterator, ShortArrayDeque.ValueIterator, ShortArrayList.ValueIterator, ShortByteHashMap.EntryIterator, ShortByteHashMap.KeysIterator, ShortByteHashMap.ValuesIterator, ShortCharHashMap.EntryIterator, ShortCharHashMap.KeysIterator, ShortCharHashMap.ValuesIterator, ShortDoubleHashMap.EntryIterator, ShortDoubleHashMap.KeysIterator, ShortDoubleHashMap.ValuesIterator, ShortFloatHashMap.EntryIterator, ShortFloatHashMap.KeysIterator, ShortFloatHashMap.ValuesIterator, ShortHashSet.EntryIterator, ShortHeapPriorityQueue.ValueIterator, ShortIndexedHeapPriorityQueue.EntryIterator, ShortIndexedHeapPriorityQueue.KeysIterator, ShortIndexedHeapPriorityQueue.ValuesIterator, ShortIntHashMap.EntryIterator, ShortIntHashMap.KeysIterator, ShortIntHashMap.ValuesIterator, ShortLinkedList.ValueIterator, ShortLongHashMap.EntryIterator, ShortLongHashMap.KeysIterator, ShortLongHashMap.ValuesIterator, ShortObjectHashMap.EntryIterator, ShortObjectHashMap.KeysIterator, ShortObjectHashMap.ValuesIterator, ShortShortHashMap.EntryIterator, ShortShortHashMap.KeysIterator, ShortShortHashMap.ValuesIterator

public abstract class AbstractIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>

Simplifies the implementation of iterators a bit. Modeled loosely after Google Guava's API.

Constructor Summary

Constructors

Constructor and Description
AbstractIterator()

Method Summary

Modifier and Type	Method and Description
protected E	done() Call when done.
protected abstract E	fetch() Fetch next element.
boolean	hasNext()
E	next()
void	release() Returns the iterator back to its associated pool, if any.
void	remove() Default implementation throws UnsupportedOperationException.

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

Constructor Detail

AbstractIterator

public AbstractIterator()

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public E next()

Specified by:

next in interface java.util.Iterator<E>

remove

public void remove()

Default implementation throws UnsupportedOperationException.

Specified by:

remove in interface java.util.Iterator<E>

fetch

protected abstract E fetch()

Fetch next element. The implementation must return done() when all elements have been fetched.

done

protected final E done()

Call when done.

release

public final void release()

Returns the iterator back to its associated pool, if any. This method must be called if the iterator cannot be automatically recycled, in the cases:

 Iterator obtained by explicit Iterable.iterator() or any other factory-like interface,
 then later implied in an incomplete iteration loop, i.e where Iterator.hasNext()
 has never returned false.

Note it is always safe to call release() whatever the iterator has already been effectively released or not. Of course, using the iterator after a release() is always a logical error, since such object is supposed to be "freed".