⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.map

Class FixedSizeMap

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
   |
   +--org.apache.commons.collections.map.FixedSizeMap

All Implemented Interfaces:
Map, Map, BoundedMap


public class FixedSizeMap
extends AbstractMapDecorator
implements Map, BoundedMap

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.

Since:
Commons Collections 3.0
Authors:
Stephen Colebourne
Paul Jack

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()

Set

keySet()

int

maxSize()

Object

put(Object key, Object value)

void

putAll(Map mapToCopy)

Object

remove(Object key)

Collection

values()

Constructor Details

FixedSizeMap

protected FixedSizeMap(Map map)

Constructor that wraps (not copies).

Parameters:
map - the map to decorate, must not be null
Throws:
- if map is null

Method Details

clear

public void clear()


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
Throws:
- if map is null

entrySet

public Set entrySet()


isFull

public boolean isFull()


keySet

public Set keySet()


maxSize

public int maxSize()


put

public Object put(Object key, Object value)

Parameters:
key
value

putAll

public void putAll(Map mapToCopy)

Parameters:
mapToCopy

remove

public Object remove(Object key)

Parameters:
key

values

public Collection values()