net.infonode.util.collection.map.base
Interface ConstMapIterator

All Known Subinterfaces:
MapIterator
All Known Implementing Classes:
ChangeNotifyMapWrapper.Iterator, ConstVectorMap.ConstIterator, EmptyIterator, MapAdapter.Iterator

public interface ConstMapIterator

An iterator for a map. The iterator points to a map entry when it's created so next() shouldn't be called at the start of the iteration.

Here's an example on how to iterate over a map: for (ConstIterator iterator = map.constIterator(); iterator.atEntry(); iterator.next()) { Object key = iterator.getKey(); Object value = iterator.getValue(); ... }

Version:
$Revision: 1.3 $
Author:
$Author: jesper $

Method Summary
 boolean atEntry()
          Returns true if the iterator points to an entry in the map.
 java.lang.Object getKey()
          Returns the key at the current map entry.
 java.lang.Object getValue()
          Returns the value at the current map entry.
 void next()
          Advance the iterator to the next entry.
 

Method Detail

getKey

java.lang.Object getKey()
Returns the key at the current map entry.

Returns:
the key at the current map entry

getValue

java.lang.Object getValue()
Returns the value at the current map entry.

Returns:
the value at the current map entry

next

void next()
Advance the iterator to the next entry.


atEntry

boolean atEntry()
Returns true if the iterator points to an entry in the map.

Returns:
true if the iterator points to an entry in the map