public class

EntrySetMapIterator

extends Object
implements MapIterator ResettableIterator
java.lang.Object
   ↳ org.apache.commons.collections.iterators.EntrySetMapIterator

Class Overview

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);
 }

Summary

Public Constructors
EntrySetMapIterator(Map map)
Constructor.
Public Methods
Object getKey()
Gets the current key, which is the key returned by the last call to next().
Object 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.
Object 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.
Object setValue(Object value)
Sets the value associated with the current key.
String toString()
Gets the iterator as a String.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.commons.collections.MapIterator
From interface org.apache.commons.collections.ResettableIterator

Public Constructors

public EntrySetMapIterator (Map map)

Constructor.

Parameters
map the map to iterate over

Public Methods

public Object getKey ()

Gets the current key, which is the key returned by the last call to next().

Returns
  • the current key
Throws
IllegalStateException if next() has not yet been called

public Object getValue ()

Gets the current value, which is the value associated with the last key returned by next().

Returns
  • the current value
Throws
IllegalStateException if next() has not yet been called

public boolean hasNext ()

Checks to see if there are more entries still to be iterated.

Returns
  • true if the iterator has more elements

public Object next ()

Gets the next key from the Map.

Returns
  • the next key in the iteration
Throws
NoSuchElementException if the iteration is finished

public void remove ()

Removes the last returned key from the underlying Map.

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

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()

public void reset ()

Resets the state of the iterator.

public Object setValue (Object value)

Sets the value associated with the current key.

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()

public String toString ()

Gets the iterator as a String.

Returns
  • a string version of the iterator