|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.map.AbstractMapDecorator
org.apache.commons.collections.map.FixedSizeMap
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.
Note that FixedSizeMap is not synchronized and is not thread-safe.
If you wish to use this map from multiple threads concurrently, you must use
appropriate synchronization. The simplest approach is to wrap this map
using Collections.synchronizedMap(Map). This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
|---|
map |
| Constructor Summary | |
|---|---|
protected |
FixedSizeMap(java.util.Map map)
Constructor that wraps (not copies). |
| Method Summary | |
|---|---|
void |
clear()
|
static java.util.Map |
decorate(java.util.Map map)
Factory method to create a fixed size map. |
java.util.Set |
entrySet()
|
boolean |
isFull()
Returns true if this map is full and no new elements can be added. |
java.util.Set |
keySet()
|
int |
maxSize()
Gets the maximum size of the map (the bound). |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
|
void |
putAll(java.util.Map mapToCopy)
|
java.lang.Object |
remove(java.lang.Object key)
|
java.util.Collection |
values()
|
| 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 |
| Constructor Detail |
|---|
protected FixedSizeMap(java.util.Map map)
map - the map to decorate, must not be null
java.lang.IllegalArgumentException - if map is null| Method Detail |
|---|
public static java.util.Map decorate(java.util.Map map)
map - the map to decorate, must not be null
java.lang.IllegalArgumentException - if map is null
public java.lang.Object put(java.lang.Object key,
java.lang.Object value)
put in interface java.util.Mapput in class AbstractMapDecoratorpublic void putAll(java.util.Map mapToCopy)
putAll in interface java.util.MapputAll in class AbstractMapDecoratorpublic void clear()
clear in interface java.util.Mapclear in class AbstractMapDecoratorpublic java.lang.Object remove(java.lang.Object key)
remove in interface java.util.Mapremove in class AbstractMapDecoratorpublic java.util.Set entrySet()
entrySet in interface java.util.MapentrySet in class AbstractMapDecoratorpublic java.util.Set keySet()
keySet in interface java.util.MapkeySet in class AbstractMapDecoratorpublic java.util.Collection values()
values in interface java.util.Mapvalues in class AbstractMapDecoratorpublic boolean isFull()
BoundedMap
isFull in interface BoundedMaptrue if the map is fullpublic int maxSize()
BoundedMap
maxSize in interface BoundedMap
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||