Class FilteredIterator<E>
java.lang.Object
com.globalmentor.collections.iterators.AbstractPrimedIterator<E>
com.globalmentor.collections.iterators.AbstractFilteredIterator<E>
com.globalmentor.collections.iterators.FilteredIterator<E>
- Type Parameters:
E
- The type of element returned by the iterator.
- All Implemented Interfaces:
Iterator<E>
An iterator that filters an existing iterator using a
Filter
.
This version does not support AbstractPrimedIterator.remove()
.
This version releases the decorated iterator when iteration is finished.
This class is not thread safe.
- Author:
- Garret Wilson
-
Constructor Summary
ConstructorDescriptionFilteredIterator
(Iterator<E> iterator, Filter<E> filter) Decorated iterator and filter constructor. -
Method Summary
Methods inherited from class com.globalmentor.collections.iterators.AbstractFilteredIterator
primeNext
Methods inherited from class com.globalmentor.collections.iterators.AbstractPrimedIterator
hasNext, next, remove
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 Details
-
FilteredIterator
Decorated iterator and filter constructor.- Parameters:
iterator
- The decorated iterator to be filtered.filter
- The filter for this iterator's elements.- Throws:
NullPointerException
- if the given iterator and/or filter isnull
.
-
-
Method Details
-
isPass
Indicates whether the given element is included when filtering. This version delegates toFilter.isPass(Object)
.- Specified by:
isPass
in classAbstractFilteredIterator<E>
- Parameters:
element
- The element in the filtered iterator.- Returns:
true
if the element should be included, ornull
if it should be filtered out.
-