public class

FixedSizeSortedMap

extends AbstractSortedMapDecorator
implements Serializable SortedMap<K, V> BoundedMap
java.lang.Object
   ↳ org.apache.commons.collections.map.AbstractMapDecorator
     ↳ org.apache.commons.collections.map.AbstractSortedMapDecorator
       ↳ org.apache.commons.collections.map.FixedSizeSortedMap

Class Overview

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 synchronizedSortedMap(SortedMap). This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.map.AbstractMapDecorator
Protected Constructors
FixedSizeSortedMap(SortedMap map)
Constructor that wraps (not copies).
Public Methods
void clear()
static SortedMap decorate(SortedMap map)
Factory method to create a fixed size sorted map.
Set entrySet()
SortedMap headMap(Object toKey)
boolean isFull()
Returns true if this map is full and no new elements can be added.
Set keySet()
int maxSize()
Gets the maximum size of the map (the bound).
Object put(Object key, Object value)
void putAll(Map mapToCopy)
Object remove(Object key)
SortedMap subMap(Object fromKey, Object toKey)
SortedMap tailMap(Object fromKey)
Collection values()
Protected Methods
SortedMap getSortedMap()
Gets the map being decorated.
[Expand]
Inherited Methods
From class org.apache.commons.collections.map.AbstractSortedMapDecorator
From class org.apache.commons.collections.map.AbstractMapDecorator
From class java.lang.Object
From interface java.util.Map
From interface java.util.SortedMap
From interface org.apache.commons.collections.BoundedMap

Protected Constructors

protected FixedSizeSortedMap (SortedMap map)

Constructor that wraps (not copies).

Parameters
map the map to decorate, must not be null
Throws
IllegalArgumentException if map is null

Public Methods

public void clear ()

public static SortedMap decorate (SortedMap map)

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

public Set entrySet ()

public SortedMap headMap (Object toKey)

public boolean isFull ()

Returns true if this map is full and no new elements can be added.

Returns
  • true if the map is full

public Set keySet ()

public int maxSize ()

Gets the maximum size of the map (the bound).

Returns
  • the maximum number of elements the map can hold

public Object put (Object key, Object value)

public void putAll (Map mapToCopy)

public Object remove (Object key)

public SortedMap subMap (Object fromKey, Object toKey)

public SortedMap tailMap (Object fromKey)

public Collection values ()

Protected Methods

protected SortedMap getSortedMap ()

Gets the map being decorated.

Returns
  • the decorated map