org.apache.commons.collections.map
Class FixedSizeSortedMap<K,V>

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

All Implemented Interfaces:

Serializable, Map<K,V>, SortedMap<K,V>, BoundedMap<K,V>

public class FixedSizeSortedMap<K,V>
extends AbstractSortedMapDecorator<K,V>
implements SortedMap<K,V>, BoundedMap<K,V>, 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.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:35:48 $

Author:

Stephen Colebourne, Matt Hall, John Watkinson, Paul Jack

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

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<K,V> map) Constructor that wraps (not copies).

Method Summary

void	clear()
static <K,V> SortedMap<K,V>	decorate(SortedMap<K,V> map) Factory method to create a fixed size sorted map.
Set<Map.Entry<K,V>>	entrySet()
protected SortedMap<K,V>	getSortedMap() Gets the map being decorated.
SortedMap<K,V>	headMap(K toKey)
boolean	isFull() Returns true if this map is full and no new elements can be added.
Set<K>	keySet()
int	maxSize() Gets the maximum size of the map (the bound).
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> mapToCopy)
V	remove(Object key)
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)
Collection<V>	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

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, isEmpty, size

Constructor Detail

FixedSizeSortedMap

protected FixedSizeSortedMap(SortedMap<K,V> 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 <K,V> SortedMap<K,V> decorate(SortedMap<K,V> 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<K,V> getSortedMap()

Gets the map being decorated.

Overrides:

getSortedMap in class AbstractSortedMapDecorator<K,V>

Returns:

the decorated map

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMapDecorator<K,V>

putAll

public void putAll(Map<? extends K,? extends V> mapToCopy)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMapDecorator<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMapDecorator<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMapDecorator<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class AbstractMapDecorator<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMapDecorator<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMapDecorator<K,V>

subMap

public SortedMap<K,V> subMap(K fromKey,
                             K toKey)

Specified by:

subMap in interface SortedMap<K,V>

Overrides:

subMap in class AbstractSortedMapDecorator<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

Overrides:

headMap in class AbstractSortedMapDecorator<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K,V>

Overrides:

tailMap 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

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