Class FilterListIterator<E>
- java.lang.Object
-
- org.apache.commons.collections4.iterators.FilterListIterator<E>
-
- All Implemented Interfaces:
Iterator<E>
,ListIterator<E>
public class FilterListIterator<E> extends Object implements ListIterator<E>
Decorates anotherListIterator
using a predicate to filter elements.This iterator decorates the underlying iterator, only allowing through those elements that match the specified
Predicate
.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description FilterListIterator()
Constructs a newFilterListIterator
that will not function untilsetListIterator
andsetPredicate
are invoked.FilterListIterator(ListIterator<? extends E> iterator)
Constructs a newFilterListIterator
that will not function untilsetPredicate
is invoked.FilterListIterator(ListIterator<? extends E> iterator, Predicate<? super E> predicate)
Constructs a newFilterListIterator
.FilterListIterator(Predicate<? super E> predicate)
Constructs a newFilterListIterator
that will not function untilsetListIterator
is invoked.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(E o)
Not supported.ListIterator<? extends E>
getListIterator()
Gets the iterator this iterator is using.Predicate<? super E>
getPredicate()
Gets the predicate this iterator is using.boolean
hasNext()
boolean
hasPrevious()
E
next()
int
nextIndex()
E
previous()
int
previousIndex()
void
remove()
Not supported.void
set(E o)
Not supported.void
setListIterator(ListIterator<? 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.-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Iterator
forEachRemaining
-
-
-
-
Constructor Detail
-
FilterListIterator
public FilterListIterator()
Constructs a newFilterListIterator
that will not function untilsetListIterator
andsetPredicate
are invoked.
-
FilterListIterator
public FilterListIterator(ListIterator<? extends E> iterator)
Constructs a newFilterListIterator
that will not function untilsetPredicate
is invoked.- Parameters:
iterator
- the iterator to use
-
FilterListIterator
public FilterListIterator(ListIterator<? extends E> iterator, Predicate<? super E> predicate)
Constructs a newFilterListIterator
.- Parameters:
iterator
- the iterator to usepredicate
- the predicate to use
-
FilterListIterator
public FilterListIterator(Predicate<? super E> predicate)
Constructs a newFilterListIterator
that will not function untilsetListIterator
is invoked.- Parameters:
predicate
- the predicate to use.
-
-
Method Detail
-
add
public void add(E o)
Not supported.- Specified by:
add
in interfaceListIterator<E>
- Parameters:
o
- the element to insert
-
hasNext
public boolean hasNext()
-
hasPrevious
public boolean hasPrevious()
- Specified by:
hasPrevious
in interfaceListIterator<E>
-
next
public E next()
-
nextIndex
public int nextIndex()
- Specified by:
nextIndex
in interfaceListIterator<E>
-
previous
public E previous()
- Specified by:
previous
in interfaceListIterator<E>
-
previousIndex
public int previousIndex()
- Specified by:
previousIndex
in interfaceListIterator<E>
-
remove
public void remove()
Not supported.
-
set
public void set(E o)
Not supported.- Specified by:
set
in interfaceListIterator<E>
- Parameters:
o
- the element with which to replace the last element returned bynext
orprevious
-
getListIterator
public ListIterator<? extends E> getListIterator()
Gets the iterator this iterator is using.- Returns:
- the iterator.
-
setListIterator
public void setListIterator(ListIterator<? extends E> iterator)
Sets the iterator for this iterator to use. If iteration has started, this effectively resets the iterator.- Parameters:
iterator
- the iterator to use
-
getPredicate
public Predicate<? super E> getPredicate()
Gets the predicate this iterator is using.- Returns:
- the predicate.
-
-