org.apache.commons.collections4.iterators

Class EntrySetMapIterator<K,V>

  • All Implemented Interfaces:
    Iterator<K>, MapIterator<K,V>, ResettableIterator<K> 

    public class EntrySetMapIterator<K,V>
extends Object
implements MapIterator<K,V>, ResettableIterator<K>
    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:
    3.0

    • Method Summary

      Modifier and Type Method and Description
      K getKey()
      Gets the current key, which is the key returned by the last call to next().
      V getValue()
      Gets the current value, which is the value associated with the last key returned by next().
      boolean hasNext()
      Checks to see if there are more entries still to be iterated.
      K next()
      Gets the next key from the Map.
      void remove()
      Removes the last returned key from the underlying Map.
      void reset()
      Resets the state of the iterator.
      V setValue(V value)
      Sets the value associated with the current key.
      String toString()
      Gets the iterator as a String.

    • Constructor Detail

      • EntrySetMapIterator

        public EntrySetMapIterator(Map<K,V> map)
        Constructor.
        Parameters:
        map - the map to iterate over

    • Method Detail

      • hasNext

        public boolean hasNext()
        Checks to see if there are more entries still to be iterated.
        Specified by:
        hasNext in interface  Iterator<K>
        Specified by:
        hasNext in interface  MapIterator<K,V>
        Returns:
        true if the iterator has more elements

      • getKey

        public K getKey()
        Gets the current key, which is the key returned by the last call to next().
        Specified by:
        getKey in interface  MapIterator<K,V>
        Returns:
        the current key
        Throws:
        IllegalStateException - if next() has not yet been called

      • getValue

        public V getValue()
        Gets the current value, which is the value associated with the last key returned by next().
        Specified by:
        getValue in interface  MapIterator<K,V>
        Returns:
        the current value
        Throws:
        IllegalStateException - if next() has not yet been called

      • reset

        public void reset()
        Resets the state of the iterator.

      • toString

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