org.hippoecm.hst.content.beans.standard

Interface HippoDocumentIterator<E>

All Superinterfaces:

Iterator<E>

public interface HippoDocumentIterator<E>
extends Iterator<E>

Method Summary

Methods

Modifier and Type	Method and Description
int	getPosition() Returns the current position within the iterator.
void	skip(int skipNum) this method skips the first skipNum documents in the iterator.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

skip

void skip(int skipNum)

this method skips the first skipNum documents in the iterator. When skipNum is large enough to skip past the last HippoDocumentBean, then no error will be thrown, but this method returns. The Iterator.hasNext() will then return false

Parameters:

skipNum -

getPosition

int getPosition()

Returns the current position within the iterator. The number returned is the 0-based index of the next element in the iterator, i.e. the one that will be returned on the subsequent next call.

Note that this method does not check if there is a next element, i.e. an empty iterator will always return 0.

Returns:

a long