org.apache.commons.collections.iterators

Class EntrySetMapIterator

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: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Constructor Summary
EntrySetMapIterator(Map map)
Constructor.
Method Summary
ObjectgetKey()
Gets the current key, which is the key returned by the last call to next().
ObjectgetValue()
Gets the current value, which is the value associated with the last key returned by next().
booleanhasNext()
Checks to see if there are more entries still to be iterated.
Objectnext()
Gets the next key from the Map.
voidremove()
Removes the last returned key from the underlying Map.
voidreset()
Resets the state of the iterator.
ObjectsetValue(Object value)
Sets the value associated with the current key.
StringtoString()
Gets the iterator as a String.

Constructor Detail

EntrySetMapIterator

public EntrySetMapIterator(Map map)
Constructor.

Parameters: map the map to iterate over

Method Detail

getKey

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

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: IllegalStateException 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: java.util.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().

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

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

toString

public String toString()
Gets the iterator as a String.

Returns: a string version of the iterator

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.