org.apache.commons.collections.map
Class FixedSizeMap
- Map, BoundedMap, Map, Serializable
public class FixedSizeMap
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.
$Revision: 1.8 $ $Date: 2004/05/07 23:58:33 $- Stephen Colebourne
- Paul Jack
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()
|
clear , containsKey , containsValue , entrySet , equals , get , getMap , hashCode , isEmpty , keySet , put , putAll , remove , size , toString , values |
FixedSizeMap
protected FixedSizeMap(Map map)
Constructor that wraps (not copies).
map
- the map to decorate, must not be null
decorate
public static Map decorate(Map map)
Factory method to create a fixed size map.
map
- the map to decorate, must not be null
isFull
public boolean isFull()
Returns true if this map is full and no new elements can be added.
- isFull in interface BoundedMap
maxSize
public int maxSize()
Gets the maximum size of the map (the bound).
- maxSize in interface BoundedMap
- the maximum number of elements the map can hold
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.