org.apache.commons.collections.map
Class AbstractMapDecorator

java.lang.Object
  org.apache.commons.collections.map.AbstractMapDecorator

All Implemented Interfaces:

java.util.Map

Direct Known Subclasses:

AbstractBidiMapDecorator, AbstractOrderedMapDecorator, AbstractSortedMapDecorator, DefaultedMap, FixedSizeMap, LazyMap, ListOrderedMap, MultiValueMap, PredicatedMap, TransformedMap, UnmodifiableMap

public abstract class AbstractMapDecorator
extends java.lang.Object
implements java.util.Map

Provides a base decorator that enables additional functionality to be added to a Map via decoration.

Methods are forwarded directly to the decorated map.

This implementation does not perform any special processing with entrySet(), keySet() or values(). Instead it simply returns the set/collection from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Daniel Rall, Stephen Colebourne

Nested Class Summary

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

java.util.Map.Entry

Field Summary

protected java.util.Map

map The map to decorate

Constructor Summary

protected	AbstractMapDecorator() Constructor only used in deserialization, do not use otherwise.
	AbstractMapDecorator(java.util.Map map) Constructor that wraps (not copies).

Method Summary

void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set	entrySet()
boolean	equals(java.lang.Object object)
java.lang.Object	get(java.lang.Object key)
protected java.util.Map	getMap() Gets the map being decorated.
int	hashCode()
boolean	isEmpty()
java.util.Set	keySet()
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)
int	size()
java.lang.String	toString()
java.util.Collection	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

map

protected transient java.util.Map map

The map to decorate

Constructor Detail

AbstractMapDecorator

protected AbstractMapDecorator()

Constructor only used in deserialization, do not use otherwise.

Since:

Commons Collections 3.1

AbstractMapDecorator

public AbstractMapDecorator(java.util.Map map)

Constructor that wraps (not copies).

Parameters:

map - the map to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if the collection is null

Method Detail

getMap

protected java.util.Map getMap()

Gets the map being decorated.

Returns:

the decorated map

clear

public void clear()

Specified by:

clear in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

entrySet

public java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map

putAll

public void putAll(java.util.Map mapToCopy)

Specified by:

putAll in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

size

public int size()

Specified by:

size in interface java.util.Map

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object