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

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

All Implemented Interfaces:

java.util.Map.Entry<K,V>

public abstract class ForwardingMapEntry<K,V>
extends java.lang.Object
implements java.util.Map.Entry<K,V>

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

Unlike most Forwarding classes, this class does not implement Serializable, since it usually decorates a map entry that shouldn't be serialized.

Author:

Mike Bostock

See Also:

ForwardingObject

Constructor Summary

protected

ForwardingMapEntry(java.util.Map.Entry<K,V> delegate) Constructs a forwarding map entry that forwards to the provided delegate.

Method Summary

protected java.util.Map.Entry<K,V>	delegate() Returns the backing delegate object.
boolean	equals(java.lang.Object obj)
K	getKey()
V	getValue()
int	hashCode()
V	setValue(V value)
java.lang.String	toString() Returns the string representation generated by the delegate's toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingMapEntry

protected ForwardingMapEntry(java.util.Map.Entry<K,V> delegate)

Constructs a forwarding map entry that forwards to the provided delegate.

Method Detail

delegate

protected java.util.Map.Entry<K,V> delegate()

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.

getKey

public K getKey()

Specified by:

getKey in interface java.util.Map.Entry<K,V>

getValue

public V getValue()

Specified by:

getValue in interface java.util.Map.Entry<K,V>

setValue

public V setValue(V value)

Specified by:

setValue in interface java.util.Map.Entry<K,V>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map.Entry<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map.Entry<K,V>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns the string representation generated by the delegate's toString method.

Overrides:

toString in class java.lang.Object