Class FixedSizeMap
- java.lang.Object
-
- org.apache.commons.collections.map.AbstractMapDecorator
-
- org.apache.commons.collections.map.FixedSizeMap
-
- All Implemented Interfaces:
Serializable
,Map
,BoundedMap
@Deprecated(since="2021-04-30") public class FixedSizeMap extends AbstractMapDecorator implements Map, BoundedMap, Serializable
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.Decorates anotherMap
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.
- Since:
- Commons Collections 3.0
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clear()
Deprecated.static Map
decorate(Map map)
Deprecated.Factory method to create a fixed size map.Set
entrySet()
Deprecated.boolean
isFull()
Deprecated.Returns true if this map is full and no new elements can be added.Set
keySet()
Deprecated.int
maxSize()
Deprecated.Gets the maximum size of the map (the bound).Object
put(Object key, Object value)
Deprecated.void
putAll(Map mapToCopy)
Deprecated.Object
remove(Object key)
Deprecated.Collection
values()
Deprecated.-
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
-
-
-
-
Method Detail
-
decorate
public static Map decorate(Map map)
Deprecated.Factory method to create a fixed size map.- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if map is null
-
put
public Object put(Object key, Object value)
Deprecated.- Specified by:
put
in interfaceMap
- Overrides:
put
in classAbstractMapDecorator
-
putAll
public void putAll(Map mapToCopy)
Deprecated.- Specified by:
putAll
in interfaceMap
- Overrides:
putAll
in classAbstractMapDecorator
-
clear
public void clear()
Deprecated.- Specified by:
clear
in interfaceMap
- Overrides:
clear
in classAbstractMapDecorator
-
remove
public Object remove(Object key)
Deprecated.- Specified by:
remove
in interfaceMap
- Overrides:
remove
in classAbstractMapDecorator
-
entrySet
public Set entrySet()
Deprecated.- Specified by:
entrySet
in interfaceMap
- Overrides:
entrySet
in classAbstractMapDecorator
-
keySet
public Set keySet()
Deprecated.- Specified by:
keySet
in interfaceMap
- Overrides:
keySet
in classAbstractMapDecorator
-
values
public Collection values()
Deprecated.- Specified by:
values
in interfaceMap
- Overrides:
values
in classAbstractMapDecorator
-
isFull
public boolean isFull()
Deprecated.Description copied from interface:BoundedMap
Returns true if this map is full and no new elements can be added.- Specified by:
isFull
in interfaceBoundedMap
- Returns:
true
if the map is full
-
maxSize
public int maxSize()
Deprecated.Description copied from interface:BoundedMap
Gets the maximum size of the map (the bound).- Specified by:
maxSize
in interfaceBoundedMap
- Returns:
- the maximum number of elements the map can hold
-
-