Package org.apache.commons.collections4.iterators

Class FilterListIterator<E>

  • All Implemented Interfaces:
    Iterator<E>, ListIterator<E>
    public class FilterListIterator<E>
extends Object
implements ListIterator<E>
    Decorates another ListIterator 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 Detail

      • FilterListIterator

        public FilterListIterator()
        Constructs a new FilterListIterator that will not function until setListIterator and setPredicate are invoked.

      • FilterListIterator

        public FilterListIterator​(ListIterator<? extends E> iterator)
        Constructs a new FilterListIterator that will not function until setPredicate is invoked.
        Parameters:
        iterator - the iterator to use

      • FilterListIterator

        public FilterListIterator​(ListIterator<? extends E> iterator,
                          Predicate<? super E> predicate)
        Constructs a new FilterListIterator.
        Parameters:
        iterator - the iterator to use
        predicate - the predicate to use

      • FilterListIterator

        public FilterListIterator​(Predicate<? super E> predicate)
        Constructs a new FilterListIterator that will not function until setListIterator is invoked.
        Parameters:
        predicate - the predicate to use.

    • Method Detail

      • add

        public void add​(E o)
        Not supported.
        Specified by:
        add in interface ListIterator<E>
        Parameters:
        o - the element to insert

      • set

        public void set​(E o)
        Not supported.
        Specified by:
        set in interface ListIterator<E>
        Parameters:
        o - the element with which to replace the last element returned by next or previous

      • 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.

      • setPredicate

        public void setPredicate​(Predicate<? super E> predicate)
        Sets the predicate this the iterator to use.
        Parameters:
        predicate - the transformer to use