org.apache.commons.collections.map

Class FixedSizeMap

Implemented Interfaces:
Map, BoundedMap, Map, Serializable

public class FixedSizeMap
extends AbstractMapDecorator
implements Map, BoundedMap, Serializable

Decorates another Map to fix the size, preventing 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/05/07 23:58:33 $
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

FixedSizeMap(Map map)
Constructor that wraps (not copies).

Method Summary

void
clear()
static Map
decorate(Map map)
Factory method to create a fixed size map.
Set
entrySet()
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)
Collection
values()

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

FixedSizeMap

protected FixedSizeMap(Map 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 Map decorate(Map map)
Factory method to create a fixed size map.
Parameters:
map - the map to decorate, must not be null

entrySet

public Set entrySet()
Overrides:
entrySet in interface AbstractMapDecorator

isFull

public boolean isFull()
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

keySet

public Set keySet()
Overrides:
keySet in interface AbstractMapDecorator

maxSize

public int maxSize()
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

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

values

public Collection values()
Overrides:
values in interface AbstractMapDecorator

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