Package org.apache.commons.collections.iterators

Class FilterListIterator

java.lang.Object
org.apache.commons.collections.iterators.FilterListIterator
All Implemented Interfaces:
Iterator, ListIterator
public class FilterListIterator extends Object implements ListIterator
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:
Commons Collections 2.0
Version:
$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
Author:
Rodney Waldhoff

  • Constructor Details

    • FilterListIterator

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

    • FilterListIterator

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

    • FilterListIterator

      public FilterListIterator(ListIterator iterator, Predicate predicate)
      Constructs a new FilterListIterator.
      Parameters:
      iterator - the iterator to use
      predicate - the predicate to use

    • FilterListIterator

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

  • Method Details

    • add

      public void add(Object o)
      Not supported.
      Specified by:
      add in interface ListIterator

    • hasNext

      public boolean hasNext()
      Specified by:
      hasNext in interface Iterator
      Specified by:
      hasNext in interface ListIterator

    • hasPrevious

      public boolean hasPrevious()
      Specified by:
      hasPrevious in interface ListIterator

    • next

      public Object next()
      Specified by:
      next in interface Iterator
      Specified by:
      next in interface ListIterator

    • nextIndex

      public int nextIndex()
      Specified by:
      nextIndex in interface ListIterator

    • previous

      public Object previous()
      Specified by:
      previous in interface ListIterator

    • previousIndex

      public int previousIndex()
      Specified by:
      previousIndex in interface ListIterator

    • remove

      public void remove()
      Not supported.
      Specified by:
      remove in interface Iterator
      Specified by:
      remove in interface ListIterator

    • set

      public void set(Object o)
      Not supported.
      Specified by:
      set in interface ListIterator

    • getListIterator

      public ListIterator getListIterator()
      Gets the iterator this iterator is using.
      Returns:
      the iterator.

    • setListIterator

      public void setListIterator(ListIterator 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 getPredicate()
      Gets the predicate this iterator is using.
      Returns:
      the predicate.

    • setPredicate

      public void setPredicate(Predicate predicate)
      Sets the predicate this the iterator to use.
      Parameters:
      predicate - the transformer to use