## org.apache.commons.collections
Interface IterableMap

All Superinterfaces:
  Map

All Known Subinterfaces:
  BidiMap, OrderedBidiMap, OrderedMap, SortedBidiMap

All Known Implementing Classes:
  AbstractBidiMapDecorator, AbstractDualBidiMap, AbstractHashedMap, AbstractLinkedMap, AbstractOrderedBidiMapDecorator, AbstractOrderedMapDecorator, AbstractSortedBidiMapDecorator, DualTreeBidiMap, Flat3Map, ListOrderedMap, MultiKeyMap, SingletonMap, TreeBidiMap, UnmodifiableMap

public interface IterableMap
extends Map

Defines a map that can be iterated directly without needing to create an entry set.

A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or cast to Map Entry objects.

     IterableMap map = new HashedMap();
     MapIterator it = map.mapIterator();
     while (it.hasNext()) {
       Object key = it.next();
       Object value = it.getValue();
       it.setValue("newValue");
     }

Since:
  Commons Collections 3.0
Version:
  $Revision: 1.4 $ $Date: 2004/02/18 01:15:43 $
Author:
  Stephen Colebourne

Nested Class Summary

Nested classes inherited from class java.util.Map
`Map.Entry`

Method Summary
`MapIterator` `mapIterator()` Obtains a `MapIterator` over the map.

Methods inherited from interface java.util.Map
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values`

Method Detail

### mapIterator

    public MapIterator mapIterator()

  Obtains a `MapIterator` over the map.

  A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or cast to Map Entry objects.

       IterableMap map = new HashedMap();
       MapIterator it = map.mapIterator();
       while (it.hasNext()) {
         Object key = it.next();
         Object value = it.getValue();
         it.setValue("newValue");
       }

  Returns:
    a map iterator

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