org.gatein.common.util

Class IteratorStatus<K>

java.lang.Object

org.gatein.common.util.IteratorStatus<K>

All Implemented Interfaces:

Iterator<K>

public class IteratorStatus<K>
extends Object
implements Iterator<K>

An java.util.Iterator wrapper which keep additional state associated with the wrapped iterator. The implementation of the Iterator interface delegates all operations to the wrapped iterator.

Version:

$Revision: 7228 $

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
IteratorStatus(Collection<K> c)
IteratorStatus(Iterator<K> delegate)

Method Summary

Methods

Modifier and Type	Method and Description
int	getIndex() Returns the index of the last element obtained or -1 if no element has been returned yet.
boolean	hasNext()
boolean	isFirst() Returns true if one element has been iterated.
K	next()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorStatus

public IteratorStatus(Iterator<K> delegate)
               throws IllegalArgumentException

Parameters:

delegate - the wrapped iterator

Throws:

IllegalArgumentException - if the wrapped iterator is null

IteratorStatus

public IteratorStatus(Collection<K> c)
               throws IllegalArgumentException

Parameters:

c - the collection to iterate

Throws:

IllegalArgumentException - if the collection is null

Method Detail

getIndex

public int getIndex()

Returns the index of the last element obtained or -1 if no element has been returned yet.

Returns:

the index of the last element obtained

isFirst

public boolean isFirst()
                throws IllegalStateException

Returns true if one element has been iterated.

Returns:

true if one element has been iterated.

Throws:

IllegalStateException - if no element has been iterated yet

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<K>

next

public K next()

Specified by:

next in interface Iterator<K>

remove

public void remove()

Specified by:

remove in interface Iterator<K>