IterableMap

implements Map<K, V>

org.apache.commons.collections.IterableMap

Known Indirect Subclasses

AbstractBidiMapDecorator, AbstractDualBidiMap, AbstractHashedMap, AbstractLinkedMap, AbstractOrderedBidiMapDecorator, AbstractOrderedMapDecorator, AbstractReferenceMap, AbstractSortedBidiMapDecorator, BidiMap, CaseInsensitiveMap, DualHashBidiMap, DualTreeBidiMap, Flat3Map, HashedMap, IdentityMap, and 16 others.

AbstractBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to a BidiMap via decoration.
AbstractDualBidiMap	Abstract `BidiMap` implemented using two maps.
AbstractHashedMap	An abstract implementation of a hash-based map which provides numerous points for subclasses to override.
AbstractLinkedMap	An abstract implementation of a hash-based map that links entries to create an ordered map and which provides numerous points for subclasses to override.
AbstractOrderedBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap via decoration.
AbstractOrderedMapDecorator	Provides a base decorator that enables additional functionality to be added to an OrderedMap via decoration.
AbstractReferenceMap	An abstract implementation of a hash-based map that allows the entries to be removed by the garbage collector.
AbstractSortedBidiMapDecorator	Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.
BidiMap	Defines a map that allows bidirectional lookup between key and values.
CaseInsensitiveMap	A case-insensitive `Map`.
DualHashBidiMap	Implementation of `BidiMap` that uses two `HashMap` instances.
DualTreeBidiMap	Implementation of `BidiMap` that uses two `TreeMap` instances.
Flat3Map	A `Map` implementation that stores data in simple fields until the size is greater than 3.
HashedMap	A `Map` implementation that is a general purpose alternative to `HashMap`.
IdentityMap	A `Map` implementation that matches keys and values based on `==` not `equals()`.
LRUMap	A `Map` implementation with a fixed maximum size which removes the least recently used entry if an entry is added when full.
LinkedMap	A `Map` implementation that maintains the order of the entries.
ListOrderedMap	Decorates a `Map` to ensure that the order of addition is retained using a `List` to maintain order.
MultiKeyMap	A `Map` implementation that uses multiple keys to map the value.
OrderedBidiMap	Defines a map that allows bidirectional lookup between key and values and retains and provides access to an ordering.
OrderedMap	Defines a map that maintains order and allows both forward and backward iteration through that order.
ReferenceIdentityMap	A `Map` implementation that allows mappings to be removed by the garbage collector and matches keys and values based on `==` not `equals()`.
ReferenceMap	A `Map` implementation that allows mappings to be removed by the garbage collector.
SingletonMap	A `Map` implementation that holds a single item and is fixed size.
SortedBidiMap	Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.
TreeBidiMap	Red-Black tree-based implementation of BidiMap where all objects added implement the `Comparable` interface.
UnmodifiableBidiMap	Decorates another `BidiMap` to ensure it can't be altered.
UnmodifiableMap	Decorates another `Map` to ensure it can't be altered.
UnmodifiableOrderedBidiMap	Decorates another `OrderedBidiMap` to ensure it can't be altered.
UnmodifiableOrderedMap	Decorates another `OrderedMap` to ensure it can't be altered.
UnmodifiableSortedBidiMap	Decorates another `SortedBidiMap` to ensure it can't be altered.

Class Overview

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");
 }

Summary

Public Methods
abstract MapIterator	mapIterator() Obtains a `MapIterator` over the map.

[Expand]

Inherited Methods

From interface java.util.Map

abstract void	clear()
abstract boolean	containsKey(Object arg0)
abstract boolean	containsValue(Object arg0)
abstract Set<Entry<K, V>>	entrySet()
abstract boolean	equals(Object arg0)
abstract V	get(Object arg0)
abstract int	hashCode()
abstract boolean	isEmpty()
abstract Set<K>	keySet()
abstract V	put(K arg0, V arg1)
abstract void	putAll(Map<? extends K, ? extends V> arg0)
abstract V	remove(Object arg0)
abstract int	size()
abstract Collection<V>	values()

Public Methods

public abstract 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

Interfaces