public final class UnmodifiableMap extends AbstractMapDecorator implements IterableMap, Unmodifiable, java.io.Serializable
Map
to ensure it can't be altered.
This class is Serializable from Commons Collections 3.1.
Modifier and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization version
|
map
Modifier | Constructor and Description |
---|---|
private |
UnmodifiableMap(java.util.Map map)
Constructor that wraps (not copies).
|
Modifier and Type | Method and 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) |
private void |
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.
|
java.lang.Object |
remove(java.lang.Object key) |
java.util.Collection |
values() |
private void |
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.
|
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString
private static final long serialVersionUID
private UnmodifiableMap(java.util.Map map)
map
- the map to decorate, must not be nulljava.lang.IllegalArgumentException
- if map is nullpublic static java.util.Map decorate(java.util.Map map)
map
- the map to decorate, must not be nulljava.lang.IllegalArgumentException
- if map is nullprivate void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the output streamjava.io.IOException
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- the input streamjava.io.IOException
java.lang.ClassNotFoundException
public void clear()
clear
in interface java.util.Map
clear
in class AbstractMapDecorator
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
put
in class AbstractMapDecorator
public void putAll(java.util.Map mapToCopy)
putAll
in interface java.util.Map
putAll
in class AbstractMapDecorator
public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map
remove
in class AbstractMapDecorator
public MapIterator mapIterator()
IterableMap
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"); }
mapIterator
in interface IterableMap
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class AbstractMapDecorator
public java.util.Set keySet()
keySet
in interface java.util.Map
keySet
in class AbstractMapDecorator
public java.util.Collection values()
values
in interface java.util.Map
values
in class AbstractMapDecorator