ilog.views.util.collections

Class IlvCompositeIterator<E>

java.lang.Object

ilog.views.util.collections.IlvCompositeIterator<E>

All Implemented Interfaces:

Iterator<E>

public class IlvCompositeIterator<E>
extends Object
implements Iterator<E>

An IlvCompositeIterator wrappers a collection of existing iterators into a single traversal sequence. The composite iterator traverses the elements of each child iterator in their natural sequence.

Since:

JViews 5.5

Constructor Summary

Constructors

Constructor and Description
IlvCompositeIterator(Collection<Iterator<E>> iterators) Creates a new IlvCompositeIterator from a collection of child iterators.
IlvCompositeIterator(Iterator<E>[] iterators) Creates a new IlvCompositeIterator from an array of child iterators.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns whether the iteration has more elements.
E	next() Returns the next element in the iteration.
void	remove() Removes the last object returned by the iterator from the underlying collection .

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IlvCompositeIterator

public IlvCompositeIterator(Iterator<E>[] iterators)

Creates a new IlvCompositeIterator from an array of child iterators.

IlvCompositeIterator

public IlvCompositeIterator(Collection<Iterator<E>> iterators)

Creates a new IlvCompositeIterator from a collection of child iterators.

Method Detail

hasNext

public boolean hasNext()

Returns whether the iteration has more elements. In other words, returns true if next would return an element rather than throwing an exception.

Specified by:

hasNext in interface Iterator<E>

next

public E next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<E>

Returns:

The next element in the iteration.

Throws:

NoSuchElementException - if the iteration has no more elements.

remove

public void remove()

Removes the last object returned by the iterator from the underlying collection . This method can be called only once per call to next.

The method is optional and currently throws an unconditional UnsupportedOperationException.

Specified by:

remove in interface Iterator<E>