Package org.apache.commons.collections.iterators

Class EntrySetMapIterator

  • All Implemented Interfaces:
    java.util.Iterator, MapIterator, ResettableIterator
    @Deprecated(since="2021-04-30")
public class EntrySetMapIterator
extends java.lang.Object
implements MapIterator, ResettableIterator
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    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​(java.util.Map map)
      Deprecated.
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object getKey()
      Deprecated.
      Gets the current key, which is the key returned by the last call to next().
      java.lang.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.
      java.lang.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.
      java.lang.Object setValue​(java.lang.Object value)
      Deprecated.
      Sets the value associated with the current key.
      java.lang.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 Detail

      • EntrySetMapIterator

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

    • Method Detail

      • hasNext

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

      • next

        public java.lang.Object next()
        Deprecated.
        Gets the next key from the Map.
        Specified by:
        next in interface java.util.Iterator
        Specified by:
        next in interface MapIterator
        Returns:
        the next key in the iteration
        Throws:
        java.util.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 java.util.Iterator
        Specified by:
        remove in interface MapIterator
        Throws:
        java.lang.UnsupportedOperationException - if remove is not supported by the map
        java.lang.IllegalStateException - if next() has not yet been called
        java.lang.IllegalStateException - if remove() has already been called since the last call to next()

      • getKey

        public java.lang.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:
        java.lang.IllegalStateException - if next() has not yet been called

      • getValue

        public java.lang.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:
        java.lang.IllegalStateException - if next() has not yet been called

      • setValue

        public java.lang.Object setValue​(java.lang.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:
        java.lang.UnsupportedOperationException - if setValue is not supported by the map
        java.lang.IllegalStateException - if next() has not yet been called
        java.lang.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 java.lang.String toString()
        Deprecated.
        Gets the iterator as a String.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string version of the iterator