public class FixedSizeSortedMap<K,V> extends AbstractSortedMapDecorator<K,V> implements BoundedMap<K,V>, Serializable
SortedMap to fix the size blocking 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 FixedSizeSortedMap 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.synchronizedSortedMap(java.util.SortedMap<K, V>). This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
AbstractSortedMapDecorator.SortedMapIterator<K,V>| Modifier | Constructor and Description |
|---|---|
protected |
FixedSizeSortedMap(SortedMap<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> FixedSizeSortedMap<K,V> |
fixedSizeSortedMap(SortedMap<K,V> map)
Factory method to create a fixed size sorted map.
|
protected SortedMap<K,V> |
getSortedMap()
Gets the map being decorated.
|
SortedMap<K,V> |
headMap(K toKey) |
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) |
SortedMap<K,V> |
subMap(K fromKey,
K toKey) |
SortedMap<K,V> |
tailMap(K fromKey) |
Collection<V> |
values() |
comparator, decorated, firstKey, lastKey, mapIterator, nextKey, previousKeycontainsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitcontainsKey, containsValue, equals, get, hashCode, isEmpty, sizemapIteratorcontainsKey, containsValue, get, isEmpty, sizeprotected FixedSizeSortedMap(SortedMap<K,V> map)
map - the map to decorate, must not be nullIllegalArgumentException - if map is nullpublic static <K,V> FixedSizeSortedMap<K,V> fixedSizeSortedMap(SortedMap<K,V> map)
K - the key typeV - the value typemap - the map to decorate, must not be nullIllegalArgumentException - if map is nullprotected SortedMap<K,V> getSortedMap()
public V put(K key, V value)
Putpublic void clear()
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–2013 The Apache Software Foundation. All rights reserved.