K
- the type of the keys in this mapV
- the type of the values in this mappublic final class UnmodifiableOrderedMap<K,V> extends AbstractOrderedMapDecorator<K,V> implements Unmodifiable, java.io.Serializable
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.
Modifier and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization version
|
map
Modifier | Constructor and Description |
---|---|
private |
UnmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
void |
clear() |
java.util.Set<java.util.Map.Entry<K,V>> |
entrySet() |
java.util.Set<K> |
keySet() |
OrderedMapIterator<K,V> |
mapIterator()
Obtains a
MapIterator 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) |
private void |
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.
|
V |
remove(java.lang.Object key) |
static <K,V> OrderedMap<K,V> |
unmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)
Factory method to create an unmodifiable sorted map.
|
java.util.Collection<V> |
values() |
private void |
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.
|
decorated, firstKey, lastKey, nextKey, previousKey
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
containsKey, containsValue, get, isEmpty, size
private static final long serialVersionUID
private UnmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)
map
- the map to decorate, must not be nulljava.lang.NullPointerException
- if map is nullpublic static <K,V> OrderedMap<K,V> unmodifiableOrderedMap(OrderedMap<? extends K,? extends V> map)
K
- the key typeV
- the value typemap
- the map to decorate, must not be nulljava.lang.NullPointerException
- if map is nullprivate void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the output streamjava.io.IOException
- if an error occurs while writing to the streamprivate void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- the input streamjava.io.IOException
- if an error occurs while reading from the streamjava.lang.ClassNotFoundException
- if an object read from the stream can not be loadedpublic OrderedMapIterator<K,V> mapIterator()
AbstractIterableMap
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 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); }
mapIterator
in interface IterableGet<K,V>
mapIterator
in interface OrderedMap<K,V>
mapIterator
in class AbstractOrderedMapDecorator<K,V>
public void clear()
public V put(K key, V value)
Put
put
in interface java.util.Map<K,V>
put
in interface Put<K,V>
put
in class AbstractMapDecorator<K,V>
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keykey
, or
null
if there was no mapping for key
.
(A null
return can also indicate that the map
previously associated null
with key
,
if the implementation supports null
values.)Map.put(Object, Object)
public V remove(java.lang.Object key)
remove
in interface java.util.Map<K,V>
remove
in interface Get<K,V>
remove
in class AbstractMapDecorator<K,V>
key
- key whose mapping is to be removed from the mapkey
, or
null
if there was no mapping for key
.Map.remove(Object)
public java.util.Set<K> keySet()