org.apache.commons.collections.iterators
Class UnmodifiableMapIterator
java.lang.Object
org.apache.commons.collections.iterators.UnmodifiableMapIterator
- Iterator, MapIterator, Unmodifiable
public final class UnmodifiableMapIterator
extends java.lang.Object
Decorates a map iterator such that it cannot be modified.
$Revision: 1.7 $ $Date: 2004/02/18 00:59:50 $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).
|
decorate
public static MapIterator decorate(MapIterator iterator)
Decorates the specified iterator such that it cannot be modified.
iterator
- the iterator to decorate
getKey
public Object getKey()
Gets the current key, which is the key returned by the last call
to next()
.
- getKey in interface MapIterator
getValue
public Object getValue()
Gets the current value, which is the value associated with the last key
returned by next()
.
- getValue in interface MapIterator
hasNext
public boolean hasNext()
Checks to see if there are more entries still to be iterated.
- hasNext in interface MapIterator
true
if the iterator has more elements
next
public Object next()
Gets the next key from the Map
.
- next in interface MapIterator
- 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()
.
- remove in interface MapIterator
setValue
public Object setValue(Object value)
Sets the value associated with the current key (optional operation).
- setValue in interface MapIterator
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.