net.sf.rubycollect4j.util

Class PeekingIterator<E>

java.lang.Object

net.sf.rubycollect4j.util.PeekingIterator<E>

Type Parameters:

E - the type of elements

All Implemented Interfaces:

java.util.Iterator<E>

public final class PeekingIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>

PeekingIterator is an Iterator which provides a peek() method for user to peek an element advanced.

Constructor Summary

Constructors

Constructor and Description
PeekingIterator(java.util.Iterator<? extends E> iterator) Creates a PeekingIterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext()
E	next()
E	peek() Peeks an element advanced.
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeekingIterator

public PeekingIterator(java.util.Iterator<? extends E> iterator)

Creates a PeekingIterator.

Parameters:

iterator - an Iterator

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public E next()

Specified by:

next in interface java.util.Iterator<E>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E>

peek

public E peek()

Peeks an element advanced. Warning: remove() is temporarily out of function after a peek() until a next() is called.

Returns:

element