org.apache.commons.collections
Interface MapIterator
- Iterator
- OrderedMapIterator
- AbstractDualBidiMap.BidiMapIterator, AbstractHashedMap.HashMapIterator, AbstractLinkedMap.LinkMapIterator, AbstractMapIteratorDecorator, AbstractOrderedMapIteratorDecorator, DualTreeBidiMap.BidiOrderedMapIterator, EmptyMapIterator, EmptyOrderedMapIterator, EntrySetMapIterator, UnmodifiableMapIterator, UnmodifiableOrderedMapIterator
public interface MapIterator
extends Iterator
Defines an iterator that operates over a
Map
.
This iterator is a special version designed for maps. It can be more
efficient to use this rather than an entry set iterator where the option
is available, and it is certainly more convenient.
A map that provides this interface may not hold the data internally using
Map Entry objects, thus this interface can avoid lots of object creation.
In use, this iterator iterates through the keys in the map. After each call
to
next()
, the
getValue()
method provides direct
access to the value. The value can also be set using
setValue()
.
MapIterator it = map.mapIterator();
while (it.hasNext()) {
Object key = it.next();
Object value = it.getValue();
it.setValue(newValue);
}
$Revision: 1.7 $ $Date: 2004/02/18 01:15:42 $ 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).
|
getKey
public Object getKey()
Gets the current key, which is the key returned by the last call
to next()
.
getValue
public Object getValue()
Gets the current value, which is the value associated with the last key
returned by next()
.
hasNext
public boolean hasNext()
Checks to see if there are more entries still to be iterated.
true
if the iterator has more elements
next
public Object next()
Gets the next key from the Map
.
- 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()
.
setValue
public Object setValue(Object value)
Sets the value associated with the current key (optional operation).
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.