org.apache.commons.collections.map
public class FixedSizeMap extends AbstractMapDecorator implements Map, BoundedMap, 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 java.util.Collections#synchronizedMap(Map). 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 | FixedSizeMap(Map map)
Constructor that wraps (not copies).
|
Method Summary | |
---|---|
void | clear() |
static Map | decorate(Map map)
Factory method to create a fixed size map.
|
Set | entrySet() |
boolean | isFull() |
Set | keySet() |
int | maxSize() |
Object | put(Object key, Object value) |
void | putAll(Map mapToCopy) |
Object | remove(Object key) |
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