|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMapEntry<K,V>
@GwtCompatible public abstract class ForwardingMapEntry<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.
Warning: The methods of ForwardingMapEntry
forward
indiscriminately to the methods of the delegate. For example,
overriding getValue()
alone will not change the behavior of
equals(java.lang.Object)
, which can lead to unexpected behavior. In this case, you
should override equals
as well, either providing your own
implementation, or delegating to the provided standardEquals
method.
Each of the standard
methods, where appropriate, use Objects.equal(java.lang.Object, java.lang.Object)
to test equality for both keys and values. This may not be
the desired behavior for map implementations that use non-standard notions of
key equality, such as the entry of a SortedMap
whose comparator is
not consistent with equals
.
The standard
methods are not guaranteed to be thread-safe, even
when all of the methods that they depend on are thread-safe.
Constructor Summary | |
---|---|
protected |
ForwardingMapEntry()
Constructor for use by subclasses. |
Method Summary | |
---|---|
protected abstract java.util.Map.Entry<K,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to. |
boolean |
equals(java.lang.Object object)
|
K |
getKey()
|
V |
getValue()
|
int |
hashCode()
|
V |
setValue(V value)
|
protected boolean |
standardEquals(java.lang.Object object)
A sensible definition of equals(Object) in terms of getKey() and getValue() . |
protected int |
standardHashCode()
A sensible definition of hashCode() in terms of getKey()
and getValue() . |
protected java.lang.String |
standardToString()
A sensible definition of ForwardingObject.toString() in terms of getKey() and getValue() . |
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 |
---|
protected ForwardingMapEntry()
Method Detail |
---|
protected abstract java.util.Map.Entry<K,V> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.
delegate
in class ForwardingObject
public K getKey()
getKey
in interface java.util.Map.Entry<K,V>
public V getValue()
getValue
in interface java.util.Map.Entry<K,V>
public V setValue(V value)
setValue
in interface java.util.Map.Entry<K,V>
public boolean equals(@Nullable java.lang.Object object)
equals
in interface java.util.Map.Entry<K,V>
equals
in class java.lang.Object
public int hashCode()
hashCode
in interface java.util.Map.Entry<K,V>
hashCode
in class java.lang.Object
@Beta protected boolean standardEquals(@Nullable java.lang.Object object)
equals(Object)
in terms of getKey()
and getValue()
. If you override either of these
methods, you may wish to override equals(Object)
to forward to
this implementation.
@Beta protected int standardHashCode()
hashCode()
in terms of getKey()
and getValue()
. If you override either of these methods, you may
wish to override hashCode()
to forward to this implementation.
@Beta protected java.lang.String standardToString()
ForwardingObject.toString()
in terms of getKey()
and getValue()
. If you override either of these
methods, you may wish to override equals(java.lang.Object)
to forward to this
implementation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |