public class FilterIterator<E> extends Object implements Iterator<E>
Iterator
using a predicate to filter elements.
This iterator decorates the underlying iterator, only allowing through
those elements that match the specified Predicate
.
Constructor and Description |
---|
FilterIterator()
Constructs a new
FilterIterator that will not function
until setIterator is invoked. |
FilterIterator(Iterator<? extends E> iterator)
Constructs a new
FilterIterator that will not function
until setPredicate is invoked. |
FilterIterator(Iterator<? extends E> iterator,
Predicate<? super E> predicate)
Constructs a new
FilterIterator that will use the
given iterator and predicate. |
Modifier and Type | Method and Description |
---|---|
Iterator<? extends E> |
getIterator()
Gets the iterator this iterator is using.
|
Predicate<? super E> |
getPredicate()
Gets the predicate this iterator is using.
|
boolean |
hasNext()
Returns true if the underlying iterator contains an object that
matches the predicate.
|
E |
next()
Returns the next object that matches the predicate.
|
void |
remove()
Removes from the underlying collection of the base iterator the last
element returned by this iterator.
|
void |
setIterator(Iterator<? extends E> iterator)
Sets the iterator for this iterator to use.
|
void |
setPredicate(Predicate<? super E> predicate)
Sets the predicate this the iterator to use.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachRemaining
public FilterIterator()
FilterIterator
that will not function
until setIterator
is invoked.public FilterIterator(Iterator<? extends E> iterator)
FilterIterator
that will not function
until setPredicate
is invoked.iterator
- the iterator to usepublic boolean hasNext()
hasNext
in interface Iterator<E>
NullPointerException
- if either the iterator or predicate are nullpublic E next()
next
in interface Iterator<E>
NullPointerException
- if either the iterator or predicate are nullNoSuchElementException
- if there are no more elements that
match the predicatepublic void remove()
next()
was called, but not after
hasNext()
, because the hasNext()
call
changes the base iterator.remove
in interface Iterator<E>
IllegalStateException
- if hasNext()
has already
been called.public Iterator<? extends E> getIterator()
public void setIterator(Iterator<? extends E> iterator)
iterator
- the iterator to usepublic Predicate<? super E> getPredicate()
Copyright © 2006–2022 Apache Software Foundation. All rights reserved.