Package org.apache.commons.collections.iterators

Class AbstractMapIteratorDecorator

java.lang.Object
org.apache.commons.collections.iterators.AbstractMapIteratorDecorator
All Implemented Interfaces:
Iterator, MapIterator
@Deprecated(since="2021-04-30") public class AbstractMapIteratorDecorator extends Object implements MapIterator
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.
Provides basic behaviour for decorating a map iterator with extra functionality.

All methods are forwarded to the decorated map iterator.

Since:
Commons Collections 3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractMapIteratorDecorator(MapIterator iterator)
    Deprecated.
    Constructor that decorates the specified iterator.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getKey()
    Deprecated.
    Gets the current key, which is the key returned by the last call to next().
    Object
    getValue()
    Deprecated.
    Gets the current value, which is the value associated with the last key returned by next().
    boolean
    hasNext()
    Deprecated.
    Checks to see if there are more entries still to be iterated.
    Object
    next()
    Deprecated.
    Gets the next key from the Map.
    void
    remove()
    Deprecated.
    Removes the last returned key from the underlying Map (optional operation).
    Object
    setValue(Object obj)
    Deprecated.
    Sets the value associated with the current key (optional operation).

    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 Details

    • AbstractMapIteratorDecorator

      public AbstractMapIteratorDecorator(MapIterator iterator)
      Deprecated.
      Constructor that decorates the specified iterator.
      Parameters:
      iterator - the iterator to decorate, must not be null
      Throws:
      IllegalArgumentException - if the collection is null

  • Method Details

    • hasNext

      public boolean hasNext()
      Deprecated.
      Description copied from interface: MapIterator
      Checks to see if there are more entries still to be iterated.
      Specified by:
      hasNext in interface Iterator
      Specified by:
      hasNext in interface MapIterator
      Returns:
      true if the iterator has more elements

    • next

      public Object next()
      Deprecated.
      Description copied from interface: MapIterator
      Gets the next key from the Map.
      Specified by:
      next in interface Iterator
      Specified by:
      next in interface MapIterator
      Returns:
      the next key in the iteration

    • remove

      public void remove()
      Deprecated.
      Description copied from interface: MapIterator
      Removes the last returned key from the underlying Map (optional operation).

      This method can be called once per call to next().

      Specified by:
      remove in interface Iterator
      Specified by:
      remove in interface MapIterator

    • getKey

      public Object getKey()
      Deprecated.
      Description copied from interface: MapIterator
      Gets the current key, which is the key returned by the last call to next().
      Specified by:
      getKey in interface MapIterator
      Returns:
      the current key

    • getValue

      public Object getValue()
      Deprecated.
      Description copied from interface: MapIterator
      Gets the current value, which is the value associated with the last key returned by next().
      Specified by:
      getValue in interface MapIterator
      Returns:
      the current value

    • setValue

      public Object setValue(Object obj)
      Deprecated.
      Description copied from interface: MapIterator
      Sets the value associated with the current key (optional operation).
      Specified by:
      setValue in interface MapIterator
      Parameters:
      obj - the new value
      Returns:
      the previous value