Class UnmodifiableMap<K,V>
- java.lang.Object
-
- org.apache.commons.collections4.map.AbstractIterableMap<K,V>
-
- org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
-
- org.apache.commons.collections4.map.UnmodifiableMap<K,V>
-
- All Implemented Interfaces:
java.io.Serializable
,java.util.Map<K,V>
,Get<K,V>
,IterableGet<K,V>
,IterableMap<K,V>
,Put<K,V>
,Unmodifiable
public final class UnmodifiableMap<K,V> extends AbstractMapDecorator<K,V> implements Unmodifiable, java.io.Serializable
Decorates anotherMap
to ensure it can't be altered.This class is Serializable from Commons Collections 3.1.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
- Version:
- $Id: UnmodifiableMap.java 1686855 2015-06-22 13:00:27Z tn $
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
java.util.Set<java.util.Map.Entry<K,V>>
entrySet()
java.util.Set<K>
keySet()
MapIterator<K,V>
mapIterator()
Obtains aMapIterator
over the map.V
put(K key, V value)
Note that the return type is Object, rather than V as in the Map interface.void
putAll(java.util.Map<? extends K,? extends V> mapToCopy)
V
remove(java.lang.Object key)
static <K,V>
java.util.Map<K,V>unmodifiableMap(java.util.Map<? extends K,? extends V> map)
Factory method to create an unmodifiable map.java.util.Collection<V>
values()
-
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, size, toString
-
-
-
-
Method Detail
-
unmodifiableMap
public static <K,V> java.util.Map<K,V> unmodifiableMap(java.util.Map<? extends K,? extends V> map)
Factory method to create an unmodifiable map.- Type Parameters:
K
- the key typeV
- the value type- Parameters:
map
- the map to decorate, must not be null- Returns:
- a new unmodifiable map
- Throws:
java.lang.NullPointerException
- if map is null- Since:
- 4.0
-
clear
public void clear()
-
put
public V put(K key, V value)
Description copied from interface:Put
Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.
-
remove
public V remove(java.lang.Object key)
-
mapIterator
public MapIterator<K,V> mapIterator()
Description copied from class:AbstractIterableMap
Obtains aMapIterator
over the map.A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects.
IterableMap
map = new HashedMap (); MapIterator it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); } - Specified by:
mapIterator
in interfaceIterableGet<K,V>
- Overrides:
mapIterator
in classAbstractIterableMap<K,V>
- Returns:
- a map iterator
-
keySet
public java.util.Set<K> keySet()
-
-