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:
- IterableMap, Map, Serializable, Unmodifiable
- public final class UnmodifiableMap
- extends AbstractMapDecorator
- implements IterableMap, Unmodifiable, 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
- Version:
- $Revision: 1.10 $ $Date: 2004/04/09 10:32:25 $
- Author:
- Stephen Colebourne
- See Also:
- Serialized Form
decorate
public static Map decorate(Map map)
- Factory method to create an unmodifiable map.
- Parameters:
map - the map to decorate, must not be null
- Throws:
IllegalArgumentException - if map is null
clear
public void clear()
- Specified by:
clear in interface Map- Overrides:
clear in class AbstractMapDecorator
put
public Object put(Object key,
Object value)
- Specified by:
put in interface Map- Overrides:
put in class AbstractMapDecorator
putAll
public void putAll(Map mapToCopy)
- Specified by:
putAll in interface Map- Overrides:
putAll in class AbstractMapDecorator
remove
public Object remove(Object key)
- Specified by:
remove in interface 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 Set entrySet()
- Specified by:
entrySet in interface Map- Overrides:
entrySet in class AbstractMapDecorator
keySet
public Set keySet()
- Specified by:
keySet in interface Map- Overrides:
keySet in class AbstractMapDecorator
values
public Collection values()
- Specified by:
values in interface Map- Overrides:
values in class AbstractMapDecorator
Copyright © 2001-2005 Apache Software Foundation. All Rights Reserved.