ilog.views.util.collections

Class IlvSelectiveIterator<E>

java.lang.Object

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

All Implemented Interfaces:

Iterator<E>

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

IlvSelectiveIterator wrappers an existing Iterator so that it will only visit elements in the original iteration that match a certain criteria. This criteria is defined by an IlvUnaryPredicate which is evaluated against every element. Those elements in the original iteration which cause the predicate to evaluate false are skipped.

Since:

JViews 5.5

Constructor Summary

Constructors

Constructor and Description
IlvSelectiveIterator(Iterator<? extends E> iterator, IlvUnaryPredicate<? super E> predicate) Constructs an IlvSelectiveIterator that will selectively traverse the elements from the specified iterator.

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 from the underlying collection the last object returned by the iterator.

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

IlvSelectiveIterator

public IlvSelectiveIterator(Iterator<? extends E> iterator,
                            IlvUnaryPredicate<? super E> predicate)

Constructs an IlvSelectiveIterator that will selectively traverse the elements from the specified iterator. The unary predicate is applied to each element in the original iteration to select which elements will be traversed by the new IlvSelectiveIterator.

Parameters:

iterator - The original iterator.

predicate - The unary predicate that is applied to each of iterator elements. Those that evaluate true are returned by this iterator.

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 from the underlying collection the last object returned by the iterator. 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>