Class FixedSizeMap
- All Implemented Interfaces:
Serializable,Map,BoundedMap
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.
- Since:
- Commons Collections 3.0
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Deprecated.static MapDeprecated.Factory method to create a fixed size map.entrySet()Deprecated.booleanisFull()Deprecated.Returns true if this map is full and no new elements can be added.keySet()Deprecated.intmaxSize()Deprecated.Gets the maximum size of the map (the bound).Deprecated.voidDeprecated.Deprecated.values()Deprecated.Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringMethods 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 Details
-
decorate
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
Deprecated.- Specified by:
putin interfaceMap- Overrides:
putin classAbstractMapDecorator
-
putAll
Deprecated.- Specified by:
putAllin interfaceMap- Overrides:
putAllin classAbstractMapDecorator
-
clear
public void clear()Deprecated.- Specified by:
clearin interfaceMap- Overrides:
clearin classAbstractMapDecorator
-
remove
Deprecated.- Specified by:
removein interfaceMap- Overrides:
removein classAbstractMapDecorator
-
entrySet
Deprecated.- Specified by:
entrySetin interfaceMap- Overrides:
entrySetin classAbstractMapDecorator
-
keySet
Deprecated.- Specified by:
keySetin interfaceMap- Overrides:
keySetin classAbstractMapDecorator
-
values
Deprecated.- Specified by:
valuesin interfaceMap- Overrides:
valuesin classAbstractMapDecorator
-
isFull
public boolean isFull()Deprecated.Description copied from interface:BoundedMapReturns true if this map is full and no new elements can be added.- Specified by:
isFullin interfaceBoundedMap- Returns:
trueif the map is full
-
maxSize
public int maxSize()Deprecated.Description copied from interface:BoundedMapGets the maximum size of the map (the bound).- Specified by:
maxSizein interfaceBoundedMap- Returns:
- the maximum number of elements the map can hold
-