Package org.apache.commons.collections.iterators

Class EntrySetMapIterator

java.lang.Object
org.apache.commons.collections.iterators.EntrySetMapIterator
All Implemented Interfaces:
Iterator, MapIterator, ResettableIterator
@Deprecated(since="2021-04-30") public class EntrySetMapIterator extends Object implements MapIterator, ResettableIterator
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.
Implements a MapIterator using a Map entrySet. Reverse iteration is not supported. 
  MapIterator it = map.mapIterator();
  while (it.hasNext()) {
    Object key = it.next();
    Object value = it.getValue();
    it.setValue(newValue);
  }
Since:
Commons Collections 3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    EntrySetMapIterator(Map map)
    Deprecated.
    Constructor.

  • 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.
    void
    reset()
    Deprecated.
    Resets the state of the iterator.
    Object
    setValue(Object value)
    Deprecated.
    Sets the value associated with the current key.
    String
    toString()
    Deprecated.
    Gets the iterator as a String.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Iterator

    forEachRemaining

  • Constructor Details

    • EntrySetMapIterator

      public EntrySetMapIterator(Map map)
      Deprecated.
      Constructor.
      Parameters:
      map - the map to iterate over

  • Method Details

    • hasNext

      public boolean hasNext()
      Deprecated.
      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.
      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
      Throws:
      NoSuchElementException - if the iteration is finished

    • remove

      public void remove()
      Deprecated.
      Removes the last returned key from the underlying Map.

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

      Specified by:
      remove in interface Iterator
      Specified by:
      remove in interface MapIterator
      Throws:
      UnsupportedOperationException - if remove is not supported by the map
      IllegalStateException - if next() has not yet been called
      IllegalStateException - if remove() has already been called since the last call to next()

    • getKey

      public Object getKey()
      Deprecated.
      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
      Throws:
      IllegalStateException - if next() has not yet been called

    • getValue

      public Object getValue()
      Deprecated.
      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
      Throws:
      IllegalStateException - if next() has not yet been called

    • setValue

      public Object setValue(Object value)
      Deprecated.
      Sets the value associated with the current key.
      Specified by:
      setValue in interface MapIterator
      Parameters:
      value - the new value
      Returns:
      the previous value
      Throws:
      UnsupportedOperationException - if setValue is not supported by the map
      IllegalStateException - if next() has not yet been called
      IllegalStateException - if remove() has been called since the last call to next()

    • reset

      public void reset()
      Deprecated.
      Resets the state of the iterator.
      Specified by:
      reset in interface ResettableIterator

    • toString

      public String toString()
      Deprecated.
      Gets the iterator as a String.
      Overrides:
      toString in class Object
      Returns:
      a string version of the iterator