UnmodifiableSortedMap ("The Adobe AEM Quickstart and Web Application.")

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>

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>, java.util.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, java.io.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:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`java.util.Comparator<? super K>`	`comparator()`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`K`	`firstKey()` Gets the first key currently in this map.
`java.util.SortedMap<K,V>`	`headMap(K toKey)`
`java.util.Set<K>`	`keySet()`
`K`	`lastKey()` Gets the last key currently in this 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)`
`java.util.SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`java.util.SortedMap<K,V>`	`tailMap(K fromKey)`
`static <K,V> java.util.SortedMap<K,V>`	`unmodifiableSortedMap(java.util.SortedMap<K,? extends V> map)` Factory method to create an unmodifiable sorted map.
`java.util.Collection<V>`	`values()`

Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
mapIterator, 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
getClass, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, size

- Method Detail
  - unmodifiableSortedMap
```
public static <K,V> java.util.SortedMap<K,V> unmodifiableSortedMap(java.util.SortedMap<K,? extends V> map)
```
    Factory method to create an unmodifiable sorted map.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Parameters:
    
    map - the map to decorate, must not be null
    
    Returns:
    
    a new unmodifiable sorted map
    
    Throws:
    
    java.lang.NullPointerException - if map is null
    
    Since:
    
    4.0
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
    
    Specified by:
    
    clear in interface Put<K,V>
    
    Overrides:
    
    clear in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.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.
    
    Specified by:
    
    put in interface java.util.Map<K,V>
    
    Specified by:
    
    put in interface Put<K,V>
    
    Overrides:
    
    put in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.put(Object, Object)
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> mapToCopy)
```
    Specified by:
    
    putAll in interface java.util.Map<K,V>
    
    Specified by:
    
    putAll in interface Put<K,V>
    
    Overrides:
    
    putAll in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.putAll(Map)
  - remove
```
public V remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<K,V>
    
    Specified by:
    
    remove in interface Get<K,V>
    
    Overrides:
    
    remove in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.remove(Object)
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K,V>
    
    Specified by:
    
    entrySet in interface java.util.SortedMap<K,V>
    
    Specified by:
    
    entrySet in interface Get<K,V>
    
    Overrides:
    
    entrySet in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.entrySet()
  - keySet
```
public java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<K,V>
    
    Specified by:
    
    keySet in interface Get<K,V>
    
    Overrides:
    
    keySet in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.keySet()
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<K,V>
    
    Specified by:
    
    values in interface Get<K,V>
    
    Overrides:
    
    values in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.values()
  - firstKey
```
public K firstKey()
```
    Description copied from interface: OrderedMap
    
    Gets the first key currently in this map.
    
    Specified by:
    
    firstKey in interface java.util.SortedMap<K,V>
    
    Specified by:
    
    firstKey in interface OrderedMap<K,V>
    
    Overrides:
    
    firstKey in class AbstractSortedMapDecorator<K,V>
    
    Returns:
    
    the first key currently in this map
  - lastKey
```
public K lastKey()
```
    Description copied from interface: OrderedMap
    
    Gets the last key currently in this map.
    
    Specified by:
    
    lastKey in interface java.util.SortedMap<K,V>
    
    Specified by:
    
    lastKey in interface OrderedMap<K,V>
    
    Overrides:
    
    lastKey in class AbstractSortedMapDecorator<K,V>
    
    Returns:
    
    the last key currently in this map
  - comparator
```
public java.util.Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    comparator in class AbstractSortedMapDecorator<K,V>
  - subMap
```
public java.util.SortedMap<K,V> subMap(K fromKey,
                                       K toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    subMap in class AbstractSortedMapDecorator<K,V>
  - headMap
```
public java.util.SortedMap<K,V> headMap(K toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    headMap in class AbstractSortedMapDecorator<K,V>
  - tailMap
```
public java.util.SortedMap<K,V> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    tailMap in class AbstractSortedMapDecorator<K,V>

Class UnmodifiableSortedMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator

Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface org.apache.commons.collections4.Get

Method Detail

unmodifiableSortedMap

clear

put

putAll

remove

entrySet

keySet

values

firstKey

lastKey

comparator

subMap

headMap

tailMap