⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.iterators

Class EntrySetMapIterator

java.lang.Object
|
+--org.apache.commons.collections.iterators.EntrySetMapIterator

All Implemented Interfaces:
MapIterator, ResettableIterator


public class EntrySetMapIterator
extends java.lang.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
Author:
Stephen Colebourne

Constructor Summary

EntrySetMapIterator(Map map)

Constructor.

Method Summary

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.

Constructor Details

EntrySetMapIterator

public EntrySetMapIterator(Map map)

Constructor.

Parameters:
map - the map to iterate over

Method Details

getKey

public Object getKey()

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

Returns:
the current key
Throws:
- 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().

Returns:
the current value
Throws:
- if next() has not yet been called

hasNext

public boolean hasNext()

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

Returns:
true if the iterator has more elements

next

public Object next()

Gets the next key from the Map.

Returns:
the next key in the iteration
Throws:
- 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().

Throws:
- if remove is not supported by the map
- if next() has not yet been called
- if remove() has already been called since the last call to next()

reset

public void reset()

Resets the state of the iterator.


setValue

public Object setValue(Object value)

Sets the value associated with the current key.

Parameters:
value - the new value
Returns:
the previous value
Throws:
- if setValue is not supported by the map
- if next() has not yet been called
- if remove() has been called since the last call to next()

toString

public String toString()

Gets the iterator as a String.

Returns:
a string version of the iterator