Package org.apache.commons.collections.iterators

Class FilterListIterator

  • All Implemented Interfaces:
    java.util.Iterator, java.util.ListIterator
    @Deprecated(since="2021-04-30")
public class FilterListIterator
extends java.lang.Object
implements java.util.ListIterator
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
    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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void add​(java.lang.Object o)
      Deprecated.
      Not supported.
      java.util.ListIterator getListIterator()
      Deprecated.
      Gets the iterator this iterator is using.
      Predicate getPredicate()
      Deprecated.
      Gets the predicate this iterator is using.
      boolean hasNext()
      Deprecated.
       
      boolean hasPrevious()
      Deprecated.
       
      java.lang.Object next()
      Deprecated.
       
      int nextIndex()
      Deprecated.
       
      java.lang.Object previous()
      Deprecated.
       
      int previousIndex()
      Deprecated.
       
      void remove()
      Deprecated.
      Not supported.
      void set​(java.lang.Object o)
      Deprecated.
      Not supported.
      void setListIterator​(java.util.ListIterator iterator)
      Deprecated.
      Sets the iterator for this iterator to use.
      void setPredicate​(Predicate predicate)
      Deprecated.
      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()
        Deprecated.
        Constructs a new FilterListIterator that will not function until setListIterator and setPredicate are invoked.

      • FilterListIterator

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

      • FilterListIterator

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

      • FilterListIterator

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

    • Method Detail

      • add

        public void add​(java.lang.Object o)
        Deprecated.
        Not supported.
        Specified by:
        add in interface java.util.ListIterator

      • hasNext

        public boolean hasNext()
        Deprecated.
        Specified by:
        hasNext in interface java.util.Iterator
        Specified by:
        hasNext in interface java.util.ListIterator

      • hasPrevious

        public boolean hasPrevious()
        Deprecated.
        Specified by:
        hasPrevious in interface java.util.ListIterator

      • next

        public java.lang.Object next()
        Deprecated.
        Specified by:
        next in interface java.util.Iterator
        Specified by:
        next in interface java.util.ListIterator

      • nextIndex

        public int nextIndex()
        Deprecated.
        Specified by:
        nextIndex in interface java.util.ListIterator

      • previous

        public java.lang.Object previous()
        Deprecated.
        Specified by:
        previous in interface java.util.ListIterator

      • previousIndex

        public int previousIndex()
        Deprecated.
        Specified by:
        previousIndex in interface java.util.ListIterator

      • remove

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

      • set

        public void set​(java.lang.Object o)
        Deprecated.
        Not supported.
        Specified by:
        set in interface java.util.ListIterator

      • getListIterator

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

      • setListIterator

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

      • setPredicate

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