org.apache.commons.collections.map

Class FixedSizeSortedMap

public class FixedSizeSortedMap extends AbstractSortedMapDecorator implements SortedMap, BoundedMap, 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 java.util.Collections#synchronizedSortedMap. 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: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $

Author: Stephen Colebourne Paul Jack

Constructor Summary
protected FixedSizeSortedMap(SortedMap map)
Constructor that wraps (not copies).
Method Summary
voidclear()
static SortedMapdecorate(SortedMap map)
Factory method to create a fixed size sorted map.
SetentrySet()
protected SortedMapgetSortedMap()
Gets the map being decorated.
SortedMapheadMap(Object toKey)
booleanisFull()
SetkeySet()
intmaxSize()
Objectput(Object key, Object value)
voidputAll(Map mapToCopy)
Objectremove(Object key)
SortedMapsubMap(Object fromKey, Object toKey)
SortedMaptailMap(Object fromKey)
Collectionvalues()

Constructor Detail

FixedSizeSortedMap

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

Method Detail

clear

public void clear()

decorate

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

entrySet

public Set entrySet()

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.

Returns: the decorated map

headMap

public SortedMap headMap(Object toKey)

isFull

public boolean isFull()

keySet

public Set keySet()

maxSize

public int maxSize()

put

public Object put(Object key, Object value)

putAll

public void putAll(Map mapToCopy)

remove

public Object remove(Object key)

subMap

public SortedMap subMap(Object fromKey, Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)

values

public Collection values()
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.