Top Description Fields Constructors Methods
com.carrotsearch.hppc

public abstract Class AbstractIterator<E>

extends Object
implements Iterator<E>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Known Direct Subclasses
com.carrotsearch.hppc.IntFloatHashMap.EntryIterator, com.carrotsearch.hppc.IntFloatHashMap.KeysIterator, com.carrotsearch.hppc.IntFloatHashMap.ValuesIterator, com.carrotsearch.hppc.IntHashSet.EntryIterator, com.carrotsearch.hppc.IntIntHashMap.EntryIterator, com.carrotsearch.hppc.IntIntHashMap.KeysIterator, com.carrotsearch.hppc.IntIntHashMap.ValuesIterator, com.carrotsearch.hppc.IntLongHashMap.EntryIterator, com.carrotsearch.hppc.IntLongHashMap.KeysIterator, com.carrotsearch.hppc.IntLongHashMap.ValuesIterator, com.carrotsearch.hppc.IntObjectHashMap.EntryIterator, com.carrotsearch.hppc.IntObjectHashMap.KeysIterator, com.carrotsearch.hppc.IntObjectHashMap.ValuesIterator, com.carrotsearch.hppc.IntPgmIndex.IntEmptyPgmIndex.IntEmptyIterator, com.carrotsearch.hppc.IntPgmIndex.RangeIterator, com.carrotsearch.hppc.IntShortHashMap.EntryIterator, com.carrotsearch.hppc.IntShortHashMap.KeysIterator, com.carrotsearch.hppc.IntShortHashMap.ValuesIterator, com.carrotsearch.hppc.ShortCharHashMap.EntryIterator, com.carrotsearch.hppc.ShortCharHashMap.KeysIterator, com.carrotsearch.hppc.ShortCharHashMap.ValuesIterator, com.carrotsearch.hppc.ShortDoubleHashMap.EntryIterator, com.carrotsearch.hppc.ShortDoubleHashMap.KeysIterator, com.carrotsearch.hppc.ShortDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.ShortFloatHashMap.EntryIterator, com.carrotsearch.hppc.ShortFloatHashMap.KeysIterator, com.carrotsearch.hppc.ShortFloatHashMap.ValuesIterator, com.carrotsearch.hppc.ShortHashSet.EntryIterator, com.carrotsearch.hppc.ShortIntHashMap.EntryIterator, com.carrotsearch.hppc.ShortIntHashMap.KeysIterator, com.carrotsearch.hppc.ShortIntHashMap.ValuesIterator, com.carrotsearch.hppc.ShortLongHashMap.EntryIterator, com.carrotsearch.hppc.ShortLongHashMap.KeysIterator, com.carrotsearch.hppc.ShortLongHashMap.ValuesIterator, com.carrotsearch.hppc.ShortObjectHashMap.EntryIterator, com.carrotsearch.hppc.ShortObjectHashMap.KeysIterator, com.carrotsearch.hppc.ShortObjectHashMap.ValuesIterator, com.carrotsearch.hppc.CharIntHashMap.EntryIterator, com.carrotsearch.hppc.CharIntHashMap.KeysIterator, com.carrotsearch.hppc.CharIntHashMap.ValuesIterator, com.carrotsearch.hppc.CharLongHashMap.EntryIterator, com.carrotsearch.hppc.CharLongHashMap.KeysIterator, com.carrotsearch.hppc.CharLongHashMap.ValuesIterator, com.carrotsearch.hppc.CharObjectHashMap.EntryIterator, com.carrotsearch.hppc.CharObjectHashMap.KeysIterator, com.carrotsearch.hppc.CharObjectHashMap.ValuesIterator, com.carrotsearch.hppc.CharShortHashMap.EntryIterator, com.carrotsearch.hppc.CharShortHashMap.KeysIterator, com.carrotsearch.hppc.CharShortHashMap.ValuesIterator, com.carrotsearch.hppc.DoubleArrayDeque.ValueIterator, com.carrotsearch.hppc.DoubleArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.DoubleArrayList.ValueIterator, com.carrotsearch.hppc.DoublePgmIndex.DoubleEmptyPgmIndex.DoubleEmptyIterator, com.carrotsearch.hppc.DoublePgmIndex.RangeIterator, com.carrotsearch.hppc.FloatArrayDeque.ValueIterator, com.carrotsearch.hppc.FloatArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.ByteArrayDeque.ValueIterator, com.carrotsearch.hppc.ByteArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.FloatArrayList.ValueIterator, com.carrotsearch.hppc.LongArrayDeque.ValueIterator, com.carrotsearch.hppc.LongArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.LongIntHashMap.EntryIterator, com.carrotsearch.hppc.LongIntHashMap.KeysIterator, com.carrotsearch.hppc.LongIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongByteHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongByteHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongByteHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectDoubleHashMap.EntryIterator, com.carrotsearch.hppc.ObjectDoubleHashMap.KeysIterator, com.carrotsearch.hppc.ObjectDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectFloatHashMap.EntryIterator, com.carrotsearch.hppc.ObjectFloatHashMap.KeysIterator, com.carrotsearch.hppc.ObjectFloatHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectHashSet.EntryIterator, com.carrotsearch.hppc.ObjectIntHashMap.EntryIterator, com.carrotsearch.hppc.ObjectIntHashMap.KeysIterator, com.carrotsearch.hppc.ObjectIntHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectLongHashMap.EntryIterator, com.carrotsearch.hppc.ObjectLongHashMap.KeysIterator, com.carrotsearch.hppc.ObjectLongHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectObjectHashMap.EntryIterator, com.carrotsearch.hppc.ObjectObjectHashMap.KeysIterator, com.carrotsearch.hppc.ObjectObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongCharHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongCharHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongCharHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongDoubleHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongDoubleHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongFloatHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongFloatHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongFloatHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongIntHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongIntHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongLongHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongLongHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongLongHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongObjectHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongObjectHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationLongShortHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationLongShortHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationLongShortHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectByteHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectByteHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectByteHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectCharHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectCharHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectCharHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectDoubleHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectDoubleHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectFloatHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectFloatHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectFloatHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectIntHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectIntHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectLongHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectLongHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectLongHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectObjectHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectObjectHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationObjectShortHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationObjectShortHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationObjectShortHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortByteHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortByteHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortByteHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortCharHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortCharHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortCharHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortDoubleHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortDoubleHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortFloatHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortFloatHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortFloatHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortIntHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortIntHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortLongHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortLongHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortLongHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortObjectHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortObjectHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationShortShortHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationShortShortHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationShortShortHashMap.ValuesIterator, com.carrotsearch.hppc.LongLongHashMap.EntryIterator, com.carrotsearch.hppc.LongLongHashMap.KeysIterator, com.carrotsearch.hppc.LongLongHashMap.ValuesIterator, com.carrotsearch.hppc.LongObjectHashMap.EntryIterator, com.carrotsearch.hppc.LongObjectHashMap.KeysIterator, com.carrotsearch.hppc.LongObjectHashMap.ValuesIterator, com.carrotsearch.hppc.LongPgmIndex.LongEmptyPgmIndex.LongEmptyIterator, com.carrotsearch.hppc.LongPgmIndex.RangeIterator, com.carrotsearch.hppc.LongShortHashMap.EntryIterator, com.carrotsearch.hppc.LongShortHashMap.KeysIterator, com.carrotsearch.hppc.LongShortHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectArrayDeque.ValueIterator, com.carrotsearch.hppc.ObjectArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.ObjectArrayList.ValueIterator, com.carrotsearch.hppc.ObjectByteHashMap.EntryIterator, com.carrotsearch.hppc.ObjectByteHashMap.KeysIterator, com.carrotsearch.hppc.ObjectByteHashMap.ValuesIterator, com.carrotsearch.hppc.ObjectCharHashMap.EntryIterator, com.carrotsearch.hppc.ObjectCharHashMap.KeysIterator, com.carrotsearch.hppc.ObjectCharHashMap.ValuesIterator, com.carrotsearch.hppc.FloatPgmIndex.FloatEmptyPgmIndex.FloatEmptyIterator, com.carrotsearch.hppc.FloatPgmIndex.RangeIterator, com.carrotsearch.hppc.IntArrayDeque.ValueIterator, com.carrotsearch.hppc.IntArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.IntArrayList.ValueIterator, com.carrotsearch.hppc.IntByteHashMap.EntryIterator, com.carrotsearch.hppc.IntByteHashMap.KeysIterator, com.carrotsearch.hppc.IntByteHashMap.ValuesIterator, com.carrotsearch.hppc.IntCharHashMap.EntryIterator, com.carrotsearch.hppc.IntCharHashMap.KeysIterator, com.carrotsearch.hppc.IntCharHashMap.ValuesIterator, com.carrotsearch.hppc.IntDoubleHashMap.EntryIterator, com.carrotsearch.hppc.IntDoubleHashMap.KeysIterator, com.carrotsearch.hppc.IntDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.ByteArrayList.ValueIterator, com.carrotsearch.hppc.CharArrayDeque.ValueIterator, com.carrotsearch.hppc.CharArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.CharArrayList.ValueIterator, com.carrotsearch.hppc.CharByteHashMap.EntryIterator, com.carrotsearch.hppc.CharByteHashMap.KeysIterator, com.carrotsearch.hppc.CharByteHashMap.ValuesIterator, com.carrotsearch.hppc.CharCharHashMap.EntryIterator, com.carrotsearch.hppc.CharCharHashMap.KeysIterator, com.carrotsearch.hppc.CharCharHashMap.ValuesIterator, com.carrotsearch.hppc.CharDoubleHashMap.EntryIterator, com.carrotsearch.hppc.CharDoubleHashMap.KeysIterator, com.carrotsearch.hppc.CharDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.CharFloatHashMap.EntryIterator, com.carrotsearch.hppc.CharFloatHashMap.KeysIterator, com.carrotsearch.hppc.CharFloatHashMap.ValuesIterator, com.carrotsearch.hppc.CharHashSet.EntryIterator, com.carrotsearch.hppc.ShortShortHashMap.EntryIterator, com.carrotsearch.hppc.ShortShortHashMap.KeysIterator, com.carrotsearch.hppc.ShortShortHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharByteHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharByteHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharByteHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharCharHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharCharHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharCharHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharDoubleHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharDoubleHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharFloatHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharFloatHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharFloatHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharIntHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharIntHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharLongHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharLongHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharLongHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharObjectHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharObjectHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationCharShortHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationCharShortHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationCharShortHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntByteHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntByteHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntByteHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntCharHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntCharHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntCharHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntDoubleHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntDoubleHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntFloatHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntFloatHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntFloatHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntIntHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntIntHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntIntHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntLongHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntLongHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntLongHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntObjectHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntObjectHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntObjectHashMap.ValuesIterator, com.carrotsearch.hppc.SortedIterationIntShortHashMap.EntryIterator, com.carrotsearch.hppc.SortedIterationIntShortHashMap.KeysIterator, com.carrotsearch.hppc.SortedIterationIntShortHashMap.ValuesIterator, com.carrotsearch.hppc.LongArrayList.ValueIterator, com.carrotsearch.hppc.LongByteHashMap.EntryIterator, com.carrotsearch.hppc.LongByteHashMap.KeysIterator, com.carrotsearch.hppc.LongByteHashMap.ValuesIterator, com.carrotsearch.hppc.LongCharHashMap.EntryIterator, com.carrotsearch.hppc.LongCharHashMap.KeysIterator, com.carrotsearch.hppc.LongCharHashMap.ValuesIterator, com.carrotsearch.hppc.LongDoubleHashMap.EntryIterator, com.carrotsearch.hppc.LongDoubleHashMap.KeysIterator, com.carrotsearch.hppc.LongDoubleHashMap.ValuesIterator, com.carrotsearch.hppc.LongFloatHashMap.EntryIterator, com.carrotsearch.hppc.LongFloatHashMap.KeysIterator, com.carrotsearch.hppc.LongFloatHashMap.ValuesIterator, com.carrotsearch.hppc.LongHashSet.EntryIterator, com.carrotsearch.hppc.ObjectShortHashMap.EntryIterator, com.carrotsearch.hppc.ObjectShortHashMap.KeysIterator, com.carrotsearch.hppc.ObjectShortHashMap.ValuesIterator, com.carrotsearch.hppc.ShortArrayDeque.ValueIterator, com.carrotsearch.hppc.ShortArrayDeque.DescendingValueIterator, com.carrotsearch.hppc.ShortArrayList.ValueIterator, com.carrotsearch.hppc.ShortByteHashMap.EntryIterator, com.carrotsearch.hppc.ShortByteHashMap.KeysIterator, com.carrotsearch.hppc.ShortByteHashMap.ValuesIterator
Imports
java.util.Iterator, .NoSuchElementException

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

Field Summary

Modifier and TypeField and Description
private static final int
private static final int
private E
nextElement

The next element to be returned from next() if fetched.

private static final int
private int
state

Current iterator state.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected final E

Returns:

Returns a unique sentinel value to indicate end-of-iteration.
done
()

Call when done.

protected abstract E

Returns:

Returns the next value for the iterator or chain-calls done().
fetch
()

Fetch next element.

public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.

public E
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

public void
remove()

Overrides default java.util.Iterator.remove.

Default implementation throws UnsupportedOperationException.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

AT_ENDback to summary
private static final int AT_END
CACHEDback to summary
private static final int CACHED
nextElementback to summary
private E nextElement

The next element to be returned from next() if fetched.

NOT_CACHEDback to summary
private static final int NOT_CACHED
stateback to summary
private int state

Current iterator state.

Constructor Detail

AbstractIteratorback to summary
public AbstractIterator()

Method Detail

doneback to summary
protected final E done()

Call when done.

Returns:E

Returns a unique sentinel value to indicate end-of-iteration.

fetchback to summary
protected abstract E fetch()

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

Returns:E

Returns the next value for the iterator or chain-calls done().

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Default implementation throws UnsupportedOperationException.

Annotations
@Override