org.apache.commons.collections
Class ProxyMap

java.lang.Object
  |
  +--org.apache.commons.collections.ProxyMap

public abstract class ProxyMap

extends Object

implements Map

This Map wraps another Map implementation, using the wrapped instance for its default implementation. This class is used as a framework on which to build to extensions for its wrapped Map object which would be unavailable or inconvenient via sub-classing (but usable via composition).

An example use case is where the wrapped Map needs synchronization (to make it thread-safe), but the Map returned by Collections.synchronizedMap(map) hides part of map's public interface.

Since:

2.0

Author:

Daniel Rall

Inner classes inherited from class java.util.Map

Map.Entry

Field Summary

protected Map

map The Map used for default implementations.

Constructor Summary

ProxyMap(Map map)
Creates a new instance acting as a representative for the specified Map.

Method Summary

void	clear() Invokes the underlying Map.clear() method.
boolean	containsKey(Object key) Invokes the underlying Map.containsKey(Object) method.
boolean	containsValue(Object value) Invokes the underlying Map.containsValue(Object) method.
Set	entrySet() Invokes the underlying Map.entrySet() method.
boolean	equals(Object m) Invokes the underlying Map.equals(Object) method.
Object	get(Object key) Invokes the underlying Map.get(Object) method.
int	hashCode() Invokes the underlying Map.hashCode() method.
boolean	isEmpty() Invokes the underlying Map.isEmpty() method.
Set	keySet() Invokes the underlying Map.keySet() method.
Object	put(Object key, Object value) Invokes the underlying Map.put(Object,Object) method.
void	putAll(Map t) Invokes the underlying Map.putAll(Map) method.
Object	remove(Object key) Invokes the underlying Map.remove(Object) method.
int	size() Invokes the underlying Map.size() method.
Collection	values() Invokes the underlying Map.values() method.

Methods inherited from class java.lang.Object

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

Field Detail

map

protected Map map

The Map used for default implementations.

Constructor Detail

ProxyMap

public ProxyMap(Map map)

Creates a new instance acting as a representative for the specified Map.

Parameters:

map - The Map to whose operations to wrap.

Method Detail

clear

public void clear()

Invokes the underlying Map.clear() method.

Specified by:

clear in interface Map

containsKey

public boolean containsKey(Object key)

Invokes the underlying Map.containsKey(Object) method.

Specified by:

containsKey in interface Map

containsValue

public boolean containsValue(Object value)

Invokes the underlying Map.containsValue(Object) method.

Specified by:

containsValue in interface Map

entrySet

public Set entrySet()

Invokes the underlying Map.entrySet() method.

Specified by:

entrySet in interface Map

equals

public boolean equals(Object m)

Invokes the underlying Map.equals(Object) method.

Specified by:

equals in interface Map

Overrides:

equals in class Object

get

public Object get(Object key)

Invokes the underlying Map.get(Object) method.

Specified by:

get in interface Map

hashCode

public int hashCode()

Invokes the underlying Map.hashCode() method.

Specified by:

hashCode in interface Map

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Invokes the underlying Map.isEmpty() method.

Specified by:

isEmpty in interface Map

keySet

public Set keySet()

Invokes the underlying Map.keySet() method.

Specified by:

keySet in interface Map

put

public Object put(Object key,
                  Object value)

Invokes the underlying Map.put(Object,Object) method.

Specified by:

put in interface Map

putAll

public void putAll(Map t)

Invokes the underlying Map.putAll(Map) method.

Specified by:

putAll in interface Map

remove

public Object remove(Object key)

Invokes the underlying Map.remove(Object) method.

Specified by:

remove in interface Map

size

public int size()

Invokes the underlying Map.size() method.

Specified by:

size in interface Map

values

public Collection values()

Invokes the underlying Map.values() method.

Specified by:

values in interface Map