Package com.day.cq.commons
Interface RangeIterator<E>
-
- All Superinterfaces:
java.util.Iterator<E>
public interface RangeIterator<E> extends java.util.Iterator<E>
ExtendsIterator<E>
with theskip
,getSize
andgetPosition
methods.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getPosition()
Returns the current position within the iterator.long
getSize()
Returns the number of elements in the iterator.void
skip(long skipNum)
Skip a number of elements in the iterator.
-
-
-
Method Detail
-
skip
void skip(long skipNum)
Skip a number of elements in the iterator.- Parameters:
skipNum
- the non-negative number of elements to skip- Throws:
java.util.NoSuchElementException
- if skipped past the last element in the iterator.
-
getSize
long getSize()
Returns the number of elements in the iterator. If this information is unavailable, returns -1.- Returns:
- a long
-
getPosition
long 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 subsequentnext
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
-
-