org.apache.commons.collections.map

Class FixedSizeSortedMap

Implemented Interfaces:
Map, Serializable, 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.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.8 $ $Date: 2004/06/03 22:26:52 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

Field Summary

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

map

Constructor Summary

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()
Set
keySet()
int
maxSize()
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, getSortedMap, headMap, lastKey, subMap, tailMap

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

clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Constructor Details

FixedSizeSortedMap

protected FixedSizeSortedMap(SortedMap map)
Constructor that wraps (not copies).
Parameters:
map - the map to decorate, must not be null

Method Details

clear

public void clear()
Overrides:
clear in interface AbstractMapDecorator

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

entrySet

public Set entrySet()
Overrides:
entrySet in interface AbstractMapDecorator

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.
Overrides:
getSortedMap in interface AbstractSortedMapDecorator
Returns:
the decorated map

headMap

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

isFull

public boolean isFull()
Specified by:
isFull in interface BoundedMap

keySet

public Set keySet()
Overrides:
keySet in interface AbstractMapDecorator

maxSize

public int maxSize()
Specified by:
maxSize in interface BoundedMap

put

public Object put(Object key,
                  Object value)
Overrides:
put in interface AbstractMapDecorator

putAll

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

remove

public Object remove(Object key)
Overrides:
remove in interface AbstractMapDecorator

subMap

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

tailMap

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

values

public Collection values()
Overrides:
values in interface AbstractMapDecorator

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