java.lang.Object
- org.apache.commons.collections4.map.AbstractIterableMap<K,V>
- - org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
  - - org.apache.commons.collections4.map.AbstractSortedMapDecorator<K,V>
    - - org.apache.commons.collections4.map.FixedSizeSortedMap<K,V>

Type Parameters:

K - the type of the keys in this map

V - the type of the values in this map

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>, java.util.SortedMap<K,V>, BoundedMap<K,V>, Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, IterableSortedMap<K,V>, OrderedMap<K,V>, Put<K,V>
```
public class FixedSizeSortedMap<K,V>
extends AbstractSortedMapDecorator<K,V>
implements BoundedMap<K,V>, java.io.Serializable
```
Decorates another 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:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator
  AbstractSortedMapDecorator.SortedMapIterator<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors
Modifier Constructor Description

protected FixedSizeSortedMap(java.util.SortedMap<K,V> map)
Constructor that wraps (not copies).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`	Removes all of the mappings from this map.
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`	Gets a set view of the mappings contained in this map.
`static <K,V> FixedSizeSortedMap<K,V>`	`fixedSizeSortedMap(java.util.SortedMap<K,V> map)`	Factory method to create a fixed size sorted map.
`protected java.util.SortedMap<K,V>`	`getSortedMap()`	Gets the map being decorated.
`java.util.SortedMap<K,V>`	`headMap(K toKey)`
`boolean`	`isFull()`	Returns true if this map is full and no new elements can be added.
`java.util.Set<K>`	`keySet()`	Gets a view of the keys contained in this map.
`int`	`maxSize()`	Gets the maximum size of the map (the bound).
`V`	`put(K key, V value)`	Associates the specified value with the specified key in this map.
`void`	`putAll(java.util.Map<? extends K,? extends V> mapToCopy)`	Copies all of the mappings from the specified map to this map.
`V`	`remove(java.lang.Object key)`	Remove a key-value mappings.
`java.util.SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`java.util.SortedMap<K,V>`	`tailMap(K fromKey)`
`java.util.Collection<V>`	`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, 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

- Constructor Detail
  - FixedSizeSortedMap
```
protected FixedSizeSortedMap(java.util.SortedMap<K,V> map)
```
    Constructor that wraps (not copies).
    
    Parameters:
    
    map - the map to decorate, must not be null
    
    Throws:
    
    java.lang.NullPointerException - if map is null
- Method Detail
  - fixedSizeSortedMap
```
public static <K,V> FixedSizeSortedMap<K,V> fixedSizeSortedMap(java.util.SortedMap<K,V> map)
```
    Factory method to create a fixed size sorted map.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Parameters:
    
    map - the map to decorate, must not be null
    
    Returns:
    
    a new fixed size sorted map
    
    Throws:
    
    java.lang.NullPointerException - if map is null
    
    Since:
    
    4.0
  - clear
```
public void clear()
```
    Description copied from interface: Put
    
    Removes all of the mappings from this map.
    
    Specified by:
    
    clear in interface java.util.Map<K,V>
    
    Specified by:
    
    clear in interface Put<K,V>
    
    Overrides:
    
    clear in class AbstractMapDecorator<K,V>
    
    See Also:
    
    Map.clear()
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Description copied from interface: Get
    
    Gets a set view of the mappings contained in this map.
    
    Specified by:
    
    entrySet in interface Get<K,V>
    
    Specified by:
    
    entrySet in interface java.util.Map<K,V>
    
    Specified by:
    
    entrySet in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    entrySet in class AbstractMapDecorator<K,V>
    
    Returns:
    
    a set view of the mappings contained in this map.
    
    See Also:
    
    Map.entrySet()
  - getSortedMap
```
protected java.util.SortedMap<K,V> getSortedMap()
```
    Gets the map being decorated.
    
    Returns:
    
    the decorated map
  - headMap
```
public java.util.SortedMap<K,V> headMap(K toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    headMap in class AbstractSortedMapDecorator<K,V>
  - 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 interface BoundedMap<K,V>
    
    Returns:
    
    true if the map is full
  - keySet
```
public java.util.Set<K> keySet()
```
    Description copied from interface: Get
    
    Gets a view of the keys contained in this map.
    
    Specified by:
    
    keySet in interface Get<K,V>
    
    Specified by:
    
    keySet in interface java.util.Map<K,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    keySet in class AbstractMapDecorator<K,V>
    
    Returns:
    
    a set view of the keys contained in this map
    
    See Also:
    
    Map.keySet()
  - maxSize
```
public int maxSize()
```
    Description copied from interface: BoundedMap
    
    Gets the maximum size of the map (the bound).
    
    Specified by:
    
    maxSize in interface BoundedMap<K,V>
    
    Returns:
    
    the maximum number of elements the map can hold
  - put
```
public V put(K key,
             V value)
```
    Description copied from interface: Put
    
    Associates 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:
    
    put in interface java.util.Map<K,V>
    
    Specified by:
    
    put in interface Put<K,V>
    
    Overrides:
    
    put in class AbstractMapDecorator<K,V>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)
    
    See Also:
    
    Map.put(Object, Object)
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> mapToCopy)
```
    Description copied from interface: Put
    
    Copies all of the mappings from the specified map to this map.
    
    Specified by:
    
    putAll in interface java.util.Map<K,V>
    
    Specified by:
    
    putAll in interface Put<K,V>
    
    Overrides:
    
    putAll in class AbstractMapDecorator<K,V>
    
    Parameters:
    
    mapToCopy - mappings to be stored in this map
    
    See Also:
    
    Map.putAll(Map)
  - remove
```
public V remove(java.lang.Object key)
```
    Description copied from interface: Get
    
    Remove a key-value mappings.
    
    Specified by:
    
    remove in interface Get<K,V>
    
    Specified by:
    
    remove in interface java.util.Map<K,V>
    
    Overrides:
    
    remove in class AbstractMapDecorator<K,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the map
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
    
    See Also:
    
    Map.remove(Object)
  - subMap
```
public java.util.SortedMap<K,V> subMap(K fromKey,
                                             K toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    subMap in class AbstractSortedMapDecorator<K,V>
  - tailMap
```
public java.util.SortedMap<K,V> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    tailMap in class AbstractSortedMapDecorator<K,V>
  - values
```
public java.util.Collection<V> values()
```
    Description copied from interface: Get
    
    Gets a a collection view of the values contained in this map.
    
    Specified by:
    
    values in interface Get<K,V>
    
    Specified by:
    
    values in interface java.util.Map<K,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<K,V>
    
    Overrides:
    
    values in class AbstractMapDecorator<K,V>
    
    Returns:
    
    a collection view of the values contained in this map.
    
    See Also:
    
    Map.values()

Class FixedSizeSortedMap<K,​V>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator

Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.collections4.Get

Methods inherited from interface java.util.Map

Constructor Detail

FixedSizeSortedMap

Method Detail

fixedSizeSortedMap

clear

entrySet

getSortedMap

headMap

isFull

keySet

maxSize

put

putAll

remove

subMap

tailMap

values

Class FixedSizeSortedMap<K,V>