org.apache.commons.collections.iterators

Class UnmodifiableMapIterator

Implemented Interfaces:
Iterator, MapIterator, Unmodifiable

public final class UnmodifiableMapIterator
extends java.lang.Object
implements MapIterator, Unmodifiable

Decorates a map iterator such that it cannot be modified.

Version:
$Revision: 1.7 $ $Date: 2004/02/18 00:59:50 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

Method Summary

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

Method Details

decorate

public static MapIterator decorate(MapIterator iterator)
Decorates the specified iterator such that it cannot be modified.

Parameters:
iterator - the iterator to decorate


getKey

public Object getKey()
Gets the current key, which is the key returned by the last call to next().
Specified by:
getKey in interface MapIterator

Returns:
the current key


getValue

public Object getValue()
Gets the current value, which is the value associated with the last key returned by next().
Specified by:
getValue in interface MapIterator

Returns:
the current value


hasNext

public boolean hasNext()
Checks to see if there are more entries still to be iterated.
Specified by:
hasNext in interface MapIterator

Returns:
true if the iterator has more elements


next

public Object next()
Gets the next key from the Map.
Specified by:
next in interface MapIterator

Returns:
the next key in the iteration


remove

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

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

Specified by:
remove in interface MapIterator


setValue

public Object setValue(Object value)
Sets the value associated with the current key (optional operation).
Specified by:
setValue in interface MapIterator

Parameters:
value - the new value

Returns:
the previous value


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