com.ihr.xbrl.util

Class NestedIterator<E,F>

java.lang.Object

com.ihr.xbrl.util.NestedIterator<E,F>

Type Parameters:

E - the element type

F - the generic type

All Implemented Interfaces:

java.util.Iterator<java.lang.Object[]>

public class NestedIterator<E,F>
extends java.lang.Object
implements java.util.Iterator<java.lang.Object[]>

Loops over innerIterator, when innerIterator reaches the end, outerIterator is rolled and innerIterator starts again the loop continues until outerIterator finishes.

The return value is converted to an array of values where the first value corresponds with the current value of innerIterator and the second value is the current value of outerIterator.

When innerIterator is an instance of NestedIterator the value returned by next() is not an array of 2 values but an array of 3 values where the last 2 values are the values returned by the innertIterator. This process is recursive so if there are N NestedIterator nested used as innerIterator of the next one, the return value of the next() method of the outermost NestedIterator will be an array of N+1 values where each index represents the N^th iterator starting from the outermost iterator.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
NestedIterator(java.util.Iterator<E> outerIterator, java.util.Iterator<F> innerIterator) Creates an instance of a nested iterator to iterate over values of two iterators so each value of the outer iterator is combined with each one of the values of the inner iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Checks for next.
java.lang.Object[]	next() Next.
void	remove() Removes the.

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

NestedIterator

public NestedIterator(java.util.Iterator<E> outerIterator,
                      java.util.Iterator<F> innerIterator)

Creates an instance of a nested iterator to iterate over values of two iterators so each value of the outer iterator is combined with each one of the values of the inner iterator.

Parameters:

outerIterator - the iterator on the left side, values will be returned on index 0 of the array

innerIterator - the iterator on the right side, values will be returned on the index 1 of the array

Method Detail

hasNext

public boolean hasNext()

Checks for next.

Specified by:

hasNext in interface java.util.Iterator<java.lang.Object[]>

Returns:

true, if successful

next

public java.lang.Object[] next()

Next.

Specified by:

next in interface java.util.Iterator<java.lang.Object[]>

Returns:

the object[]

remove

public void remove()

Removes the.

Specified by:

remove in interface java.util.Iterator<java.lang.Object[]>