public final class

UnmodifiableMapIterator

extends Object
implements MapIterator Unmodifiable
java.lang.Object
   ↳ org.apache.commons.collections.iterators.UnmodifiableMapIterator

Class Overview

Decorates a map iterator such that it cannot be modified.

Summary

Public Methods
static MapIterator decorate(MapIterator iterator)
Decorates the specified iterator such that it cannot be modified.
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 (optional operation).
Object setValue(Object value)
Sets the value associated with the current key (optional operation).
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.commons.collections.MapIterator

Public Methods

public static MapIterator decorate (MapIterator iterator)

Decorates the specified iterator such that it cannot be modified.

Parameters
iterator the iterator to decorate
Throws
IllegalArgumentException if the iterator is null

public Object getKey ()

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

Returns
  • the current key

public Object getValue ()

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

Returns
  • the current value

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

public void remove ()

Removes the last returned key from the underlying Map (optional operation).

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

public Object setValue (Object value)

Sets the value associated with the current key (optional operation).

Parameters
value the new value
Returns
  • the previous value