com.google.common.collect
Class ForwardingMap<K,V>

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>

Direct Known Subclasses:

EnumBiMap, EnumHashBiMap, ForwardingSortedMap, HashBiMap

public abstract class ForwardingMap<K,V>
extends ForwardingObject
implements Map<K,V>

A map which forwards all its method calls to another map. Subclasses should override one or more methods to change or add behavior of the backing map as desired per the decorator pattern.

Author:

Kevin Bourrillion

See Also:

ForwardingObject, Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

protected

ForwardingMap(Map<K,V> delegate)

Method Summary

void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected Map<K,V>	delegate() Returns the backing delegate object.
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)
V	get(Object key)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
V	remove(Object object)
int	size()
Collection<V>	values()

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingMap

protected ForwardingMap(Map<K,V> delegate)

Method Detail

delegate

protected Map<K,V> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate object. This method should be overridden to specify the correct return type. For example:

  @SuppressWarnings("unchecked")
  @Override protected Foo delegate() {
    return (Foo) super.delegate();
  }

This method should always return the same delegate instance that was passed to the constructor.

Overrides:

delegate in class ForwardingObject

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

remove

public V remove(Object object)

Specified by:

remove in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object