Top Description Constructors Methods
com.google.common.collect

pack-priv abstract Class AbstractMapEntry<K extends @Nullable Object, V extends @Nullable Object>

extends Object
implements Map.Entry<K extends @Nullable Object, V extends @Nullable Object>
Class Inheritance
All Implemented Interfaces
java.util.Map.Entry
Known Direct Subclasses
com.google.common.collect.CompactHashMap.MapEntry, com.google.common.collect.ImmutableEntry, com.google.common.collect.LinkedListMultimap.Node, com.google.common.collect.MapMakerInternalMap.WriteThroughEntry, com.google.common.collect.TreeRangeMap.RangeMapEntry
Annotations
@GwtCompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtCompatible, com.google.common.base.Objects, java.util.Map.Entry, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable
Implementation of the equals, hashCode, and toString methods of Entry.
Author
Jared Levy

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractMapEntry()

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
object to be compared for equality with this map entry
object)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Compares the specified object with this entry for equality.
public abstract K
getKey()

Redeclares java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.
public abstract V
getValue()

Redeclares java.util.Map.Entry.getValue.

Returns the value corresponding to this entry.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry.
public V
setValue(V
new value to be stored in this entry
value)

Implements java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation).
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the form {key}={value}.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Constructor Detail

AbstractMapEntryback to summary
pack-priv AbstractMapEntry()

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Doc from java.util.Map.Entry.equals.

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries e1 and e2 represent the same mapping if

    (e1.getKey()==null ?
     e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
    (e1.getValue()==null ?
     e2.getValue()==null : e1.getValue().equals(e2.getValue()))
This ensures that the equals method works properly across different implementations of the Map.Entry interface.
Parameters
object:Object

object to be compared for equality with this map entry

Returns:boolean

true if the specified object is equal to this map entry

Annotations
@Override
getKeyback to summary
public abstract K getKey()

Redeclares java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:K

the key corresponding to this entry

Annotations
@Override
@ParametricNullness
getValueback to summary
public abstract V getValue()

Redeclares java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:V

the value corresponding to this entry

Annotations
@Override
@ParametricNullness
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Doc from java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry. The hash code of a map entry e is defined to be: 

    (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
    (e.getValue()==null ? 0 : e.getValue().hashCode())
This ensures that e1.equals(e2) implies that e1.hashCode()==e2.hashCode() for any two Entries e1 and e2, as required by the general contract of Object.hashCode.
Returns:int

the hash code value for this map entry

Annotations
@Override
setValueback to summary
public V setValue(V value)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters
value:V

new value to be stored in this entry

Returns:V

old value corresponding to the entry

Annotations
@Override
@ParametricNullness
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of the form {key}={value}.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override