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> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serialization versionFields inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
map
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FixedSizeSortedMap
(SortedMap<K, V> map) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
entrySet()
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.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).Note that the return type is Object, rather than V as in the Map interface.void
private void
Read the map in using a custom routine.values()
private void
Write the map out using a custom routine.Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
comparator, decorated, firstKey, lastKey, mapIterator, nextKey, previousKey
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, size
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
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialization version- See Also:
-
-
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
-
getSortedMap
Gets the map being decorated.- Returns:
- the decorated map
-
writeObject
Write the map out using a custom routine.- Parameters:
out
- the output stream- Throws:
IOException
- if an error occurs while writing to the stream
-
readObject
Read the map in using a custom routine.- Parameters:
in
- the input stream- Throws:
IOException
- if an error occurs while reading from the streamClassNotFoundException
- if an object read from the stream can not be loaded
-
put
Description copied from interface:Put
Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.- Specified by:
put
in interfaceMap<K,
V> - Specified by:
put
in interfacePut<K,
V> - Overrides:
put
in 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
, ornull
if there was no mapping forkey
. (Anull
return can also indicate that the map previously associatednull
withkey
, if the implementation supportsnull
values.) - See Also:
-
putAll
-
clear
public void clear() -
remove
- Specified by:
remove
in interfaceGet<K,
V> - Specified by:
remove
in interfaceMap<K,
V> - Overrides:
remove
in classAbstractMapDecorator<K,
V> - Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. - See Also:
-
entrySet
-
keySet
-
values
-
subMap
-
headMap
-
tailMap
-
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<K,
V> - 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<K,
V> - Returns:
- the maximum number of elements the map can hold
-