org.restlet.util
Class WrapperMap<K,V>

java.lang.Object
  org.restlet.util.WrapperMap<K,V>

All Implemented Interfaces:

Map<K,V>

public class WrapperMap<K,V>
extends Object
implements Map<K,V>

Map wrapper. Modifiable map that delegates all methods to a wrapped map. This allows an easy subclassing.

Author:

Jerome Louvel

See Also:

The decorator (aka wrapper) pattern, Collections, List

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

WrapperMap()
Constructor.

WrapperMap(Map<K,V> delegate)
Constructor.

Method Summary

void	clear() Removes all mappings from this Map.
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
Set<Map.Entry<K,V>>	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(Object o) Compares the specified object with this map for equality.
V	get(Object key) Returns the value to which this map maps the specified key.
protected Map<K,V>	getDelegate() Returns the delegate list.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
Set<K>	keySet() Returns a set view of the keys contained in this map.
V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(Map<? extends K,? extends V> t) Copies all of the mappings from the specified map to this map (optional operation).
V	remove(Object key) Removes the mapping for this key from this map if it is present (optional operation).
int	size() Returns the number of key-value mappings in this map.
Collection<V>	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapperMap

public WrapperMap()

Constructor.

WrapperMap

public WrapperMap(Map<K,V> delegate)

Constructor.

Parameters:

delegate - The delegate list.

Method Detail

clear

public void clear()

Removes all mappings from this Map.

Specified by:

clear in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface Map<K,V>

Parameters:

key - The key to look up.

Returns:

True if this map contains a mapping for the specified key.

containsValue

public boolean containsValue(Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Map<K,V>

Parameters:

value - The value to look up

Returns:

True if this map maps one or more keys to the specified value.

entrySet

public Set<Map.Entry<K,V>> entrySet()

Returns a set view of the mappings contained in this map.

Specified by:

entrySet in interface Map<K,V>

Returns:

A set view of the mappings contained in this map.

equals

public boolean equals(Object o)

Compares the specified object with this map for equality.

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

Parameters:

o - Object to be compared for equality with this map.

Returns:

True if the specified object is equal to this map.

get

public V get(Object key)

Returns the value to which this map maps the specified key.

Specified by:

get in interface Map<K,V>

Parameters:

key - Key whose associated value is to be returned.

Returns:

The value to which this map maps the specified key, or null if the map contains no mapping for this key.

getDelegate

protected Map<K,V> getDelegate()

Returns the delegate list.

Returns:

The delegate list.

hashCode

public int hashCode()

Returns the hash code value for this map.

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

Returns:

The hash code value for this map.

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface Map<K,V>

Returns:

True if this map contains no key-value mappings.

keySet

public Set<K> keySet()

Returns a set view of the keys contained in this map.

Specified by:

keySet in interface Map<K,V>

Returns:

A set view of the keys contained in this map.

put

public V put(K key,
             V value)

Associates the specified value with the specified key in this map (optional operation).

Specified by:

put in interface Map<K,V>

Parameters:

key - Key with which the specified value is to be associated.

value - Value to be associated with the specified key.

Returns:

The previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.

putAll

public void putAll(Map<? extends K,? extends V> t)

Copies all of the mappings from the specified map to this map (optional operation).

Specified by:

putAll in interface Map<K,V>

Parameters:

t - Mappings to be stored in this map.

remove

public V remove(Object key)

Removes the mapping for this key from this map if it is present (optional operation).

Specified by:

remove in interface Map<K,V>

Parameters:

key - Key whose mapping is to be removed from the map.

Returns:

The previous value associated with specified key, or null if there was no mapping for key.

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface Map<K,V>

Returns:

The number of key-value mappings in this map.

values

public Collection<V> values()

Returns a collection view of the values contained in this map.

Specified by:

values in interface Map<K,V>

Returns:

A collection view of the values contained in this map.