Class FixedSizeSortedMap
- java.lang.Object
-
- org.apache.commons.collections.map.AbstractMapDecorator
-
- org.apache.commons.collections.map.AbstractSortedMapDecorator
-
- org.apache.commons.collections.map.FixedSizeSortedMap
-
- All Implemented Interfaces:
java.io.Serializable
,java.util.Map
,java.util.SortedMap
,BoundedMap
@Deprecated(since="2021-04-30") public class FixedSizeSortedMap extends AbstractSortedMapDecorator implements java.util.SortedMap, BoundedMap, java.io.Serializable
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.Decorates anotherSortedMap
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
Collections.synchronizedSortedMap(java.util.SortedMap<K, V>)
. 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 java.util.SortedMap
decorate(java.util.SortedMap map)
Deprecated.Factory method to create a fixed size sorted map.java.util.Set
entrySet()
Deprecated.java.util.SortedMap
headMap(java.lang.Object toKey)
Deprecated.boolean
isFull()
Deprecated.Returns true if this map is full and no new elements can be added.java.util.Set
keySet()
Deprecated.int
maxSize()
Deprecated.Gets the maximum size of the map (the bound).java.lang.Object
put(java.lang.Object key, java.lang.Object value)
Deprecated.void
putAll(java.util.Map mapToCopy)
Deprecated.java.lang.Object
remove(java.lang.Object key)
Deprecated.java.util.SortedMap
subMap(java.lang.Object fromKey, java.lang.Object toKey)
Deprecated.java.util.SortedMap
tailMap(java.lang.Object fromKey)
Deprecated.java.util.Collection
values()
Deprecated.-
Methods inherited from class org.apache.commons.collections.map.AbstractSortedMapDecorator
comparator, firstKey, lastKey
-
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString
-
-
-
-
Method Detail
-
decorate
public static java.util.SortedMap decorate(java.util.SortedMap map)
Deprecated.Factory method to create a fixed size sorted map.- Parameters:
map
- the map to decorate, must not be null- Throws:
java.lang.IllegalArgumentException
- if map is null
-
put
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
Deprecated.- Specified by:
put
in interfacejava.util.Map
- Overrides:
put
in classAbstractMapDecorator
-
putAll
public void putAll(java.util.Map mapToCopy)
Deprecated.- Specified by:
putAll
in interfacejava.util.Map
- Overrides:
putAll
in classAbstractMapDecorator
-
clear
public void clear()
Deprecated.- Specified by:
clear
in interfacejava.util.Map
- Overrides:
clear
in classAbstractMapDecorator
-
remove
public java.lang.Object remove(java.lang.Object key)
Deprecated.- Specified by:
remove
in interfacejava.util.Map
- Overrides:
remove
in classAbstractMapDecorator
-
entrySet
public java.util.Set entrySet()
Deprecated.- Specified by:
entrySet
in interfacejava.util.Map
- Specified by:
entrySet
in interfacejava.util.SortedMap
- Overrides:
entrySet
in classAbstractMapDecorator
-
keySet
public java.util.Set keySet()
Deprecated.- Specified by:
keySet
in interfacejava.util.Map
- Specified by:
keySet
in interfacejava.util.SortedMap
- Overrides:
keySet
in classAbstractMapDecorator
-
values
public java.util.Collection values()
Deprecated.- Specified by:
values
in interfacejava.util.Map
- Specified by:
values
in interfacejava.util.SortedMap
- Overrides:
values
in classAbstractMapDecorator
-
subMap
public java.util.SortedMap subMap(java.lang.Object fromKey, java.lang.Object toKey)
Deprecated.- Specified by:
subMap
in interfacejava.util.SortedMap
- Overrides:
subMap
in classAbstractSortedMapDecorator
-
headMap
public java.util.SortedMap headMap(java.lang.Object toKey)
Deprecated.- Specified by:
headMap
in interfacejava.util.SortedMap
- Overrides:
headMap
in classAbstractSortedMapDecorator
-
tailMap
public java.util.SortedMap tailMap(java.lang.Object fromKey)
Deprecated.- Specified by:
tailMap
in interfacejava.util.SortedMap
- Overrides:
tailMap
in classAbstractSortedMapDecorator
-
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
-
-