de.innovationgate.utils

Interface SkippingIterator<T>

All Superinterfaces:

java.util.Iterator<T>

All Known Subinterfaces:

ResultSetIterator<T>

All Known Implementing Classes:

SkippingIteratorWrapper, WGAbstractResultSetIterator, WGContentNavigator.Iterator, WGHierarchyContentIterator, WGStandardResultSetIterator, WGStructEntryIterator, WGStructEntryRetrievalIterator

public interface SkippingIterator<T>
extends java.util.Iterator<T>

An iterator that is able to skip an arbitrary number of results without retrieving them (which may save resources)

Method Summary

Methods

Modifier and Type	Method and Description
int	skip(int nrOfElements) Will skip the given number of elements in the queue.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

skip

int skip(int nrOfElements)

Will skip the given number of elements in the queue. The next call of the Iterator.next() method will return the element immediately after the last skipped one. Must be called before any iterating methods (Iterator.next() Iterator.hasNext()) have been used. Otherwise an IllegalStateException is thrown.

Parameters:

nrOfElements - Number of elements to skip

Returns:

The number of skipping iterations that could not be performed because the iterator reached the end. Should be 0 when the iterator was able to complete all operations without reaching the end.

Throws:

java.lang.IllegalStateException - when called after iterating methods have been used