Class FixedSizeSortedMap
- All Implemented Interfaces:
Serializable,Map,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) $
- See Also:
-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final longSerialization versionFields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()static SortedMapFactory method to create a fixed size sorted map.entrySet()protected SortedMapGets the map being decorated.booleanisFull()Returns true if this map is full and no new elements can be added.keySet()intmaxSize()Gets the maximum size of the map (the bound).voidprivate voidRead the map in using a custom routine.values()private voidWrite the map out using a custom routine.Methods inherited from class org.apache.commons.collections.map.AbstractSortedMapDecorator
comparator, firstKey, lastKeyMethods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, sizeMethods inherited from interface java.util.SortedMap
comparator, firstKey, lastKey
-
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:
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:
getSortedMapin classAbstractSortedMapDecorator- Returns:
- the decorated map
-
writeObject
Write the map out using a custom routine.- Throws:
IOException
-
readObject
Read the map in using a custom routine.- Throws:
IOExceptionClassNotFoundException
-
put
- Specified by:
putin interfaceMap- Overrides:
putin classAbstractMapDecorator
-
putAll
- Specified by:
putAllin interfaceMap- Overrides:
putAllin classAbstractMapDecorator
-
clear
public void clear()- Specified by:
clearin interfaceMap- Overrides:
clearin classAbstractMapDecorator
-
remove
- Specified by:
removein interfaceMap- Overrides:
removein classAbstractMapDecorator
-
entrySet
-
keySet
-
values
-
subMap
- Specified by:
subMapin interfaceSortedMap- Overrides:
subMapin classAbstractSortedMapDecorator
-
headMap
- Specified by:
headMapin interfaceSortedMap- Overrides:
headMapin classAbstractSortedMapDecorator
-
tailMap
- Specified by:
tailMapin interfaceSortedMap- Overrides:
tailMapin classAbstractSortedMapDecorator
-
isFull
public boolean isFull()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()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
-