com.ihr.xbrl.util

Class CollectionIterator<E>

java.lang.Object

com.ihr.xbrl.util.CollectionIterator<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

java.util.Iterator<E>

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

Helpful class to Iterate over values of a collection with additional information about the relative position of last returned value.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
CollectionIterator(java.util.Collection<E> baseCol) Creates a CollectionIterator over the collection received in the baseCol parameter.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Checks for the existence of next value.
boolean	isFirst() Returns true if the method next() has not been used or has been used only once.
boolean	isLast() Returns true if it is certain the next call to hasNext() will return false.
E	next() Access to the next value in the iterator and advance the iterator one element .
void	remove() Removes from the underlying collection the last element returned by this iterator (optional operation).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

CollectionIterator

public CollectionIterator(java.util.Collection<E> baseCol)

Creates a CollectionIterator over the collection received in the baseCol parameter.

Parameters:

baseCol - the collection to iterate

Method Detail

hasNext

public boolean hasNext()

Checks for the existence of next value.

Specified by:

hasNext in interface java.util.Iterator<E>

Returns:

true, if successful

next

public E next()

Access to the next value in the iterator and advance the iterator one element .

Specified by:

next in interface java.util.Iterator<E>

Returns:

the next value in the surrounding iterator

remove

public void remove()

Removes from the underlying collection the last element returned by this iterator (optional operation).

Specified by:

remove in interface java.util.Iterator<E>

isFirst

public boolean isFirst()

Returns true if the method next() has not been used or has been used only once.

Returns:

boolean value

isLast

public boolean isLast()

Returns true if it is certain the next call to hasNext() will return false.

Returns:

boolean value