org.apache.commons.collections.map
public class FixedSizeSortedMap extends AbstractSortedMapDecorator implements SortedMap, BoundedMap, 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 java.util.Collections#synchronizedSortedMap. This class may throw exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
Since: Commons Collections 3.0
Version: $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $
Constructor Summary | |
---|---|
protected | FixedSizeSortedMap(SortedMap map)
Constructor that wraps (not copies).
|
Method Summary | |
---|---|
void | clear() |
static SortedMap | decorate(SortedMap map)
Factory method to create a fixed size sorted map.
|
Set | entrySet() |
protected SortedMap | getSortedMap()
Gets the map being decorated.
|
SortedMap | headMap(Object toKey) |
boolean | isFull() |
Set | keySet() |
int | maxSize() |
Object | put(Object key, Object value) |
void | putAll(Map mapToCopy) |
Object | remove(Object key) |
SortedMap | subMap(Object fromKey, Object toKey) |
SortedMap | tailMap(Object fromKey) |
Collection | values() |
Parameters: map the map to decorate, must not be null
Throws: IllegalArgumentException if map is null
Parameters: map the map to decorate, must not be null
Throws: IllegalArgumentException if map is null
Returns: the decorated map