|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.iterators.FilterIterator
public class FilterIterator
Decorates another Iterator using a predicate to filter elements.
This iterator decorates the underlying iterator, only allowing through
those elements that match the specified Predicate.
| Constructor Summary | |
|---|---|
FilterIterator()
Constructs a new FilterIterator that will not function
until setIterator is invoked. |
|
FilterIterator(java.util.Iterator iterator)
Constructs a new FilterIterator that will not function
until setPredicate is invoked. |
|
FilterIterator(java.util.Iterator iterator,
Predicate predicate)
Constructs a new FilterIterator that will use the
given iterator and predicate. |
|
| Method Summary | |
|---|---|
java.util.Iterator |
getIterator()
Gets the iterator this iterator is using. |
Predicate |
getPredicate()
Gets the predicate this iterator is using. |
boolean |
hasNext()
Returns true if the underlying iterator contains an object that matches the predicate. |
java.lang.Object |
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(java.util.Iterator iterator)
Sets the iterator for this iterator to use. |
void |
setPredicate(Predicate predicate)
Sets the predicate this the iterator to use. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FilterIterator()
FilterIterator that will not function
until setIterator is invoked.
public FilterIterator(java.util.Iterator iterator)
FilterIterator that will not function
until setPredicate is invoked.
iterator - the iterator to use
public FilterIterator(java.util.Iterator iterator,
Predicate predicate)
FilterIterator that will use the
given iterator and predicate.
iterator - the iterator to usepredicate - the predicate to use| Method Detail |
|---|
public boolean hasNext()
hasNext in interface java.util.Iteratorjava.lang.NullPointerException - if either the iterator or predicate are nullpublic java.lang.Object next()
next in interface java.util.Iteratorjava.lang.NullPointerException - if either the iterator or predicate are null
java.util.NoSuchElementException - 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 java.util.Iteratorjava.lang.IllegalStateException - if hasNext() has already
been called.public java.util.Iterator getIterator()
public void setIterator(java.util.Iterator iterator)
iterator - the iterator to usepublic Predicate getPredicate()
public void setPredicate(Predicate predicate)
predicate - the predicate to use
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||