com.aquenos.cassandra.pvarchiver.common

Interface SizedIterator<E>

Type Parameters:

E - the type of elements returned by this iterator.

All Superinterfaces:

Iterator<E>

public interface SizedIterator<E>
extends Iterator<E>

Iterator that provides the number of remaining elements. This interface can be used when the number of elements returned in an iteration has to be known in advance, but the Collection interface cannot be used (e.g. because elements are consumed by the iterator).

Like regular iterators, sized iterators have to be expected to not be thread-safe unless explicitly stated differently in the documentation of the implementation.

Since:

3.2

Author:

Sebastian Marsching

Method Summary

Modifier and Type	Method and Description
int	remainingCount() Returns the number of elements that will be provided by this iterator.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

remainingCount

int remainingCount()

Returns the number of elements that will be provided by this iterator. If remainingCount() returns zero, Iterator.hasNext() returns false. If hasNext() returns true, remainingCount() returns a number greater than zero. Each time Iterator.next() is called, this number is decremented by one.

If the number of remaining elements is greater than Integer.MAX_VALUE, Integer.MAX_VALUE is returned instead of the actual number.

Returns:

number of remaining elements in this iterator. This is the number of times that next can be called without throwing a NoSuchElementException.