Class UnmodifiableSortedMap<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.AbstractSortedMapDecorator<K,V>
org.apache.commons.collections4.map.UnmodifiableSortedMap<K,V>
- Type Parameters:
K- the type of the keys in this mapV- the type of the values in this map
- All Implemented Interfaces:
Serializable,Map<K,,V> SortedMap<K,,V> Get<K,,V> IterableGet<K,,V> IterableMap<K,,V> IterableSortedMap<K,,V> OrderedMap<K,,V> Put<K,,V> Unmodifiable
public final class UnmodifiableSortedMap<K,V>
extends AbstractSortedMapDecorator<K,V>
implements Unmodifiable, Serializable
Decorates another
SortedMap 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
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
AbstractSortedMapDecorator.SortedMapIterator<K,V> -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Comparator<? super K>entrySet()firstKey()Gets the first key currently in this map.keySet()lastKey()Gets the last key currently in this map.Note that the return type is Object, rather than V as in the Map interface.voidstatic <K,V> SortedMap<K, V> unmodifiableSortedMap(SortedMap<K, ? extends V> map) Factory method to create an unmodifiable sorted map.values()Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
decorated, mapIterator, nextKey, previousKeyMethods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, sizeMethods 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
-
unmodifiableSortedMap
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 unmodifiable sorted map
- Throws:
NullPointerException- if map is null- Since:
- 4.0
-
clear
-
comparator
- Specified by:
comparatorin interfaceSortedMap<K,V> - Overrides:
comparatorin classAbstractSortedMapDecorator<K,V>
-
entrySet
-
firstKey
Description copied from interface:OrderedMapGets the first key currently in this map. -
headMap
-
keySet
-
lastKey
Description copied from interface:OrderedMapGets the last key currently in this map. -
put
Description copied from interface:PutNote that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.- Specified by:
putin interfaceMap<K,V> - Specified by:
putin interfacePut<K,V> - Overrides:
putin classAbstractMapDecorator<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified key- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.) - See Also:
-
putAll
-
remove
- Specified by:
removein interfaceGet<K,V> - Specified by:
removein interfaceMap<K,V> - Overrides:
removein classAbstractMapDecorator<K,V> - Parameters:
key- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. - See Also:
-
subMap
-
tailMap
-
values
-