Package org.apache.commons.collections.map

Class UnmodifiableMap

java.lang.Object

org.apache.commons.collections.map.AbstractMapDecorator

org.apache.commons.collections.map.UnmodifiableMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map, IterableMap, Unmodifiable

public final class UnmodifiableMap
extends AbstractMapDecorator
implements IterableMap, Unmodifiable, java.io.Serializable

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

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
void	clear()
static java.util.Map	decorate(java.util.Map map)	Factory method to create an unmodifiable map.
java.util.Set	entrySet()
java.util.Set	keySet()
MapIterator	mapIterator()	Obtains a MapIterator over the map.
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map mapToCopy)
java.lang.Object	remove(java.lang.Object key)
java.util.Collection	values()

Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Method Detail

decorate

public static java.util.Map decorate(java.util.Map map)

Factory method to create an unmodifiable map.

Parameters:

map - the map to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if map is null

clear

public void clear()

Specified by:

clear in interface java.util.Map

Overrides:

clear in class AbstractMapDecorator

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map

Overrides:

put in class AbstractMapDecorator

putAll

public void putAll(java.util.Map mapToCopy)

Specified by:

putAll in interface java.util.Map

Overrides:

putAll in class AbstractMapDecorator

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

Overrides:

remove in class AbstractMapDecorator

mapIterator

public MapIterator mapIterator()

Description copied from interface: IterableMap

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

Specified by:

mapIterator in interface IterableMap

Returns:

a map iterator

entrySet

public java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

Overrides:

entrySet in class AbstractMapDecorator

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

Overrides:

keySet in class AbstractMapDecorator

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

Overrides:

values in class AbstractMapDecorator