Class UnmodifiableOrderedMap<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.AbstractOrderedMapDecorator<K,V>
org.apache.commons.collections4.map.UnmodifiableOrderedMap<K,V>
- All Implemented Interfaces:
Serializable
,Map<K,
,V> Get<K,
,V> IterableGet<K,
,V> IterableMap<K,
,V> OrderedMap<K,
,V> Put<K,
,V> Unmodifiable
public final class UnmodifiableOrderedMap<K,V>
extends AbstractOrderedMapDecorator<K,V>
implements Unmodifiable, Serializable
Decorates another
OrderedMap
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: UnmodifiableOrderedMap.java 1686855 2015-06-22 13:00:27Z tn $
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
entrySet()
keySet()
Obtains aMapIterator
over the map.Note that the return type is Object, rather than V as in the Map interface.void
static <K,
V> OrderedMap<K, V> unmodifiableOrderedMap
(OrderedMap<? extends K, ? extends V> map) Factory method to create an unmodifiable sorted map.values()
Methods inherited from class org.apache.commons.collections4.map.AbstractOrderedMapDecorator
decorated, firstKey, lastKey, nextKey, previousKey
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, size
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 Details
-
unmodifiableOrderedMap
public static <K,V> OrderedMap<K,V> unmodifiableOrderedMap(OrderedMap<? extends K, ? extends V> map) Factory method to create an unmodifiable sorted map.- Type Parameters:
K
- the key typeV
- the value type- Parameters:
map
- the map to decorate, must not be null- Returns:
- a new ordered map
- Throws:
NullPointerException
- if map is null- Since:
- 4.0
-
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<String,Integer> map = new HashedMap<String,Integer>(); MapIterator<String,Integer> 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> - Specified by:
mapIterator
in interfaceOrderedMap<K,
V> - Overrides:
mapIterator
in classAbstractOrderedMapDecorator<K,
V> - Returns:
- a map iterator
-
clear
public void clear() -
put
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. -
putAll
-
remove
-
entrySet
-
keySet
-
values
-