K - the type of the keys in this mapV - the type of the values in this mappublic class FixedSizeMap<K,V> extends AbstractMapDecorator<K,V> implements BoundedMap<K,V>, Serializable
Map to fix the size, preventing add/remove.
Any action that would change the size of the map is disallowed. The put method is allowed to change the value associated with an existing key however.
If trying to remove or clear the map, an UnsupportedOperationException is thrown. If trying to put a new mapping into the map, an IllegalArgumentException is thrown. This is because the put method can succeed if the mapping's key already exists in the map, so the put method is not always unsupported.
Note that FixedSizeMap is not synchronized and is not thread-safe.
If you wish to use this map from multiple threads concurrently, you must use
appropriate synchronization. The simplest approach is to wrap this map
using Collections.synchronizedMap(Map). This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
| Modifier | Constructor and Description |
|---|---|
protected |
FixedSizeMap(Map<K,V> map)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear() |
Set<Map.Entry<K,V>> |
entrySet() |
static <K,V> FixedSizeMap<K,V> |
fixedSizeMap(Map<K,V> map)
Factory method to create a fixed size map.
|
boolean |
isFull()
Returns true if this map is full and no new elements can be added.
|
Set<K> |
keySet() |
int |
maxSize()
Gets the maximum size of the map (the bound).
|
V |
put(K key,
V value)
Note that the return type is Object, rather than V as in the Map interface.
|
void |
putAll(Map<? extends K,? extends V> mapToCopy) |
V |
remove(Object key) |
Collection<V> |
values() |
containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, size, toStringmapIteratorclone, finalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, sizemapIteratorcontainsKey, containsValue, get, isEmpty, sizeprotected FixedSizeMap(Map<K,V> map)
map - the map to decorate, must not be nullNullPointerException - if map is nullpublic static <K,V> FixedSizeMap<K,V> fixedSizeMap(Map<K,V> map)
K - the key typeV - the value typemap - the map to decorate, must not be nullNullPointerException - if map is nullpublic V put(K key, V value)
Putput in interface 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 void clear()
public V remove(Object key)
remove in interface 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 Collection<V> values()
public boolean isFull()
BoundedMapisFull in interface BoundedMap<K,V>true if the map is fullpublic int maxSize()
BoundedMapmaxSize in interface BoundedMap<K,V>Copyright © 2001–2019 The Apache Software Foundation. All rights reserved.