public final class


extends AbstractMapDecorator
implements Serializable IterableMap Unmodifiable

Class Overview

Decorates another Map to ensure it can't be altered.

This class is Serializable from Commons Collections 3.1.


Inherited Fields
From class
Public Methods
void clear()
static Map decorate(Map map)
Factory method to create an unmodifiable map.
Set entrySet()
Set keySet()
MapIterator mapIterator()
Obtains a MapIterator over the map.
Object put(Object key, Object value)
void putAll(Map mapToCopy)
Object remove(Object key)
Collection values()
Inherited Methods
From class
From class java.lang.Object
From interface java.util.Map
From interface org.apache.commons.collections.IterableMap

Public Methods

public void clear ()

public static Map decorate (Map map)

Factory method to create an unmodifiable map.

map the map to decorate, must not be null
IllegalArgumentException if map is null

public Set entrySet ()

public Set keySet ()

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 =;
   Object value = it.getValue();

  • a map iterator

public Object put (Object key, Object value)

public void putAll (Map mapToCopy)

public Object remove (Object key)

public Collection values ()