public class FixedSizeMap extends AbstractMapDecorator implements java.util.Map, BoundedMap, java.io.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 and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization version
|
map
Modifier | Constructor and Description |
---|---|
protected |
FixedSizeMap(java.util.Map map)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
void |
clear() |
static java.util.Map |
decorate(java.util.Map map)
Factory method to create a fixed size map.
|
java.util.Set |
entrySet() |
boolean |
isFull()
Returns true if this map is full and no new elements can be added.
|
java.util.Set |
keySet() |
int |
maxSize()
Gets the maximum size of the map (the bound).
|
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value) |
void |
putAll(java.util.Map mapToCopy) |
private void |
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.
|
java.lang.Object |
remove(java.lang.Object key) |
java.util.Collection |
values() |
private void |
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.
|
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString
private static final long serialVersionUID
protected FixedSizeMap(java.util.Map map)
map
- the map to decorate, must not be nulljava.lang.IllegalArgumentException
- if map is nullpublic static java.util.Map decorate(java.util.Map map)
map
- the map to decorate, must not be nulljava.lang.IllegalArgumentException
- if map is nullprivate void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the output streamjava.io.IOException
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- the input streamjava.io.IOException
java.lang.ClassNotFoundException
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
put
in class AbstractMapDecorator
public void putAll(java.util.Map mapToCopy)
putAll
in interface java.util.Map
putAll
in class AbstractMapDecorator
public void clear()
clear
in interface java.util.Map
clear
in class AbstractMapDecorator
public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map
remove
in class AbstractMapDecorator
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class AbstractMapDecorator
public java.util.Set keySet()
keySet
in interface java.util.Map
keySet
in class AbstractMapDecorator
public java.util.Collection values()
values
in interface java.util.Map
values
in class AbstractMapDecorator
public boolean isFull()
BoundedMap
isFull
in interface BoundedMap
true
if the map is fullpublic int maxSize()
BoundedMap
maxSize
in interface BoundedMap