org.apache.commons.collections.map
Class FixedSizeSortedMap

java.lang.Object
  extended by org.apache.commons.collections.map.AbstractMapDecorator
      extended by org.apache.commons.collections.map.AbstractSortedMapDecorator
          extended by org.apache.commons.collections.map.FixedSizeSortedMap
All Implemented Interfaces:
Serializable, Map, SortedMap, BoundedMap

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 Collections.synchronizedSortedMap(java.util.SortedMap). 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
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
 
Constructor Summary
protected FixedSizeSortedMap(SortedMap map)
          Constructor that wraps (not copies).
 
Method Summary
 void clear()
           
static SortedMap decorate(SortedMap map)
          Factory method to create a fixed size sorted map.
 Set entrySet()
           
protected  SortedMap getSortedMap()
          Gets the map being decorated.
 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()
           
 
Methods inherited from class org.apache.commons.collections.map.AbstractSortedMapDecorator
comparator, firstKey, lastKey
 
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.SortedMap
comparator, firstKey, lastKey
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, isEmpty, size
 

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

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

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.

Overrides:
getSortedMap in class AbstractSortedMapDecorator
Returns:
the decorated map

put

public Object put(Object key,
                  Object value)
Specified by:
put in interface Map
Overrides:
put in class AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)
Specified by:
putAll in interface Map
Overrides:
putAll in class AbstractMapDecorator

clear

public void clear()
Specified by:
clear in interface Map
Overrides:
clear in class AbstractMapDecorator

remove

public Object remove(Object key)
Specified by:
remove in interface Map
Overrides:
remove in class AbstractMapDecorator

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map
Specified by:
entrySet in interface SortedMap
Overrides:
entrySet in class AbstractMapDecorator

keySet

public Set keySet()
Specified by:
keySet in interface Map
Specified by:
keySet in interface SortedMap
Overrides:
keySet in class AbstractMapDecorator

values

public Collection values()
Specified by:
values in interface Map
Specified by:
values in interface SortedMap
Overrides:
values in class AbstractMapDecorator

subMap

public SortedMap subMap(Object fromKey,
                        Object toKey)
Specified by:
subMap in interface SortedMap
Overrides:
subMap in class AbstractSortedMapDecorator

headMap

public SortedMap headMap(Object toKey)
Specified by:
headMap in interface SortedMap
Overrides:
headMap in class AbstractSortedMapDecorator

tailMap

public SortedMap tailMap(Object fromKey)
Specified by:
tailMap in interface SortedMap
Overrides:
tailMap in class AbstractSortedMapDecorator

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
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 interface BoundedMap
Returns:
the maximum number of elements the map can hold


Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.