Package org.apache.commons.collections.iterators

Class TransformIterator

java.lang.Object
org.apache.commons.collections.iterators.TransformIterator
All Implemented Interfaces:
Iterator
@Deprecated(since="2021-04-30") public class TransformIterator extends Object implements Iterator
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 an iterator such that each element returned is transformed.
Since:
Commons Collections 1.0

  • Constructor Details

    • TransformIterator

      public TransformIterator()
      Deprecated.
      Constructs a new TransformIterator that will not function until the setIterator method is invoked.

    • TransformIterator

      public TransformIterator(Iterator iterator)
      Deprecated.
      Constructs a new TransformIterator that won't transform elements from the given iterator.
      Parameters:
      iterator - the iterator to use

    • TransformIterator

      public TransformIterator(Iterator iterator, Transformer transformer)
      Deprecated.
      Constructs a new TransformIterator that will use the given iterator and transformer. If the given transformer is null, then objects will not be transformed.
      Parameters:
      iterator - the iterator to use
      transformer - the transformer to use

  • Method Details

    • hasNext

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

    • next

      public Object next()
      Deprecated.
      Gets the next object from the iteration, transforming it using the current transformer. If the transformer is null, no transformation occurs and the object from the iterator is returned directly.
      Specified by:
      next in interface Iterator
      Returns:
      the next object
      Throws:
      NoSuchElementException - if there are no more elements

    • remove

      public void remove()
      Deprecated.
      Specified by:
      remove in interface Iterator

    • getIterator

      public Iterator getIterator()
      Deprecated.
      Gets the iterator this iterator is using.
      Returns:
      the iterator.

    • setIterator

      public void setIterator(Iterator 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

    • getTransformer

      public Transformer getTransformer()
      Deprecated.
      Gets the transformer this iterator is using.
      Returns:
      the transformer.

    • setTransformer

      public void setTransformer(Transformer transformer)
      Deprecated.
      Sets the transformer this the iterator to use. A null transformer is a no-op transformer.
      Parameters:
      transformer - the transformer to use