Class FixedSizeSortedMap<K,V>
- Type Parameters:
K- the type of the keys in this mapV- the type of the values in this map
- All Implemented Interfaces:
Serializable,Map<K,,V> SortedMap<K,,V> BoundedMap<K,,V> Get<K,,V> IterableGet<K,,V> IterableMap<K,,V> IterableSortedMap<K,,V> OrderedMap<K,,V> Put<K,V>
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:
- 3.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
AbstractSortedMapDecorator.SortedMapIterator<K,V> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFixedSizeSortedMap(SortedMap<K, V> map) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Removes all of the mappings from this map.entrySet()Gets a set view of the mappings contained in this map.static <K,V> FixedSizeSortedMap <K, V> fixedSizeSortedMap(SortedMap<K, V> map) Factory method to create a fixed size sorted map.Gets the map being decorated.booleanisFull()Returns true if this map is full and no new elements can be added.keySet()Gets a view of the keys contained in this map.intmaxSize()Gets the maximum size of the map (the bound).Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.Remove a key-value mappings.values()Gets a a collection view of the values contained in this map.Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
comparator, decorated, firstKey, lastKey, mapIterator, nextKey, previousKeyMethods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, sizeMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
-
Constructor Details
-
FixedSizeSortedMap
Constructor that wraps (not copies).- Parameters:
map- the map to decorate, must not be null- Throws:
NullPointerException- if map is null
-
-
Method Details
-
fixedSizeSortedMap
Factory method to create a fixed size sorted map.- Type Parameters:
K- the key typeV- the value type- Parameters:
map- the map to decorate, must not be null- Returns:
- a new fixed size sorted map
- Throws:
NullPointerException- if map is null- Since:
- 4.0
-
clear
-
entrySet
Description copied from interface:GetGets a set view of the mappings contained in this map. -
getSortedMap
-
headMap
-
isFull
Description copied from interface:BoundedMapReturns true if this map is full and no new elements can be added.- Specified by:
isFullin interfaceBoundedMap<K,V> - Returns:
trueif the map is full
-
keySet
Description copied from interface:GetGets a view of the keys contained in this map. -
maxSize
Description copied from interface:BoundedMapGets the maximum size of the map (the bound).- Specified by:
maxSizein interfaceBoundedMap<K,V> - Returns:
- the maximum number of elements the map can hold
-
put
Description copied from interface:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.
- Specified by:
putin interfaceMap<K,V> - Specified by:
putin interfacePut<K,V> - Overrides:
putin classAbstractMapDecorator<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified key- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.) - See Also:
-
putAll
Description copied from interface:PutCopies all of the mappings from the specified map to this map. -
remove
Description copied from interface:GetRemove a key-value mappings.- Specified by:
removein interfaceGet<K,V> - Specified by:
removein interfaceMap<K,V> - Overrides:
removein classAbstractMapDecorator<K,V> - Parameters:
key- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. - See Also:
-
subMap
-
tailMap
-
values
Description copied from interface:GetGets a a collection view of the values contained in this map.
-