Package org.apache.commons.collections.iterators

Class EntrySetMapIterator

java.lang.Object
org.apache.commons.collections.iterators.EntrySetMapIterator
All Implemented Interfaces:
Iterator, MapIterator, ResettableIterator
public class EntrySetMapIterator extends Object implements MapIterator, ResettableIterator
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
Version:
$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
Author:
Stephen Colebourne

  • Constructor Details

    • EntrySetMapIterator

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

  • Method Details

    • hasNext

      public boolean hasNext()
      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()
      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()
      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()
      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()
      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)
      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()
      Resets the state of the iterator.
      Specified by:
      reset in interface ResettableIterator

    • toString

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