Class FixedSizeSortedMap
- All Implemented Interfaces:
Serializable
,Map
,SequencedMap
,SortedMap
,BoundedMap
SortedMap
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
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Stephen Colebourne, Paul Jack
- See Also:
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
static SortedMap
Factory method to create a fixed size sorted map.entrySet()
protected SortedMap
Gets the map being decorated.boolean
isFull()
Returns true if this map is full and no new elements can be added.keySet()
int
maxSize()
Gets the maximum size of the map (the bound).void
values()
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, getMap, hashCode, isEmpty, size, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
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
Methods inherited from interface java.util.SequencedMap
firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues
-
Constructor Details
-
FixedSizeSortedMap
Constructor that wraps (not copies).- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if map is null
-
-
Method Details
-
decorate
Factory method to create a fixed size sorted map.- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if map is null
-
getSortedMap
Gets the map being decorated.- Overrides:
getSortedMap
in classAbstractSortedMapDecorator
- Returns:
- the decorated map
-
put
- Specified by:
put
in interfaceMap
- Overrides:
put
in classAbstractMapDecorator
-
putAll
- Specified by:
putAll
in interfaceMap
- Overrides:
putAll
in classAbstractMapDecorator
-
clear
public void clear()- Specified by:
clear
in interfaceMap
- Overrides:
clear
in classAbstractMapDecorator
-
remove
- Specified by:
remove
in interfaceMap
- Overrides:
remove
in classAbstractMapDecorator
-
entrySet
-
keySet
-
values
-
subMap
- Specified by:
subMap
in interfaceSortedMap
- Overrides:
subMap
in classAbstractSortedMapDecorator
-
headMap
- Specified by:
headMap
in interfaceSortedMap
- Overrides:
headMap
in classAbstractSortedMapDecorator
-
tailMap
- Specified by:
tailMap
in interfaceSortedMap
- Overrides:
tailMap
in classAbstractSortedMapDecorator
-
isFull
public boolean isFull()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()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
-