Android APIs
public class

IdentityHashMap

extends AbstractMap<K, V>
implements Map<K, V> Serializable Cloneable
java.lang.Object
   ↳ java.util.AbstractMap<K, V>
     ↳ java.util.IdentityHashMap<K, V>

Class Overview

IdentityHashMap is a variant on HashMap which tests equality by reference instead of equality by value. Basically, keys and values are compared for equality by checking if their references are equal rather than by calling the "equals" function.

Note: This class intentionally violates the general contract of Map's on comparing objects by their equals method.

IdentityHashMap uses open addressing (linear probing in particular) for collision resolution. This is different from HashMap which uses Chaining.

Like HashMap, IdentityHashMap is not thread safe, so access by multiple threads must be synchronized by an external mechanism such as Collections.synchronizedMap.

Summary

Public Constructors
IdentityHashMap()
Creates an IdentityHashMap with default expected maximum size.
IdentityHashMap(int maxSize)
Creates an IdentityHashMap with the specified maximum size parameter.
IdentityHashMap(Map<? extends K, ? extends V> map)
Creates an IdentityHashMap using the given map as initial values.
Public Methods
void clear()
Removes all elements from this map, leaving it empty.
Object clone()
Returns a new IdentityHashMap with the same mappings and size as this one.
boolean containsKey(Object key)
Returns whether this map contains the specified key.
boolean containsValue(Object value)
Returns whether this map contains the specified value.
Set<Entry<K, V>> entrySet()
Returns a set containing all of the mappings in this map.
boolean equals(Object object)
Compares this map with other objects.
V get(Object key)
Returns the value of the mapping with the specified key.
boolean isEmpty()
Returns whether this IdentityHashMap has no elements.
Set<K> keySet()
Returns a set of the keys contained in this map.
V put(K key, V value)
Maps the specified key to the specified value.
void putAll(Map<? extends K, ? extends V> map)
Copies all the mappings in the specified map to this map.
V remove(Object key)
Removes the mapping with the specified key from this map.
int size()
Returns the number of mappings in this IdentityHashMap.
Collection<V> values()
Returns a collection of the values contained in this map.
[Expand]
Inherited Methods
From class java.util.AbstractMap
From class java.lang.Object
From interface java.util.Map

Public Constructors

public IdentityHashMap ()

Added in API level 1

Creates an IdentityHashMap with default expected maximum size.

public IdentityHashMap (int maxSize)

Added in API level 1

Creates an IdentityHashMap with the specified maximum size parameter.

Parameters
maxSize int: The estimated maximum number of entries that will be put in this map.

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

Added in API level 1

Creates an IdentityHashMap using the given map as initial values.

Parameters
map Map: A map of (key,value) pairs to copy into the IdentityHashMap.

Public Methods

public void clear ()

Added in API level 1

Removes all elements from this map, leaving it empty.

See also:

public Object clone ()

Added in API level 1

Returns a new IdentityHashMap with the same mappings and size as this one.

Returns
Object a shallow copy of this IdentityHashMap.

See also:

public boolean containsKey (Object key)

Added in API level 1

Returns whether this map contains the specified key.

Parameters
key Object: the key to search for.
Returns
boolean true if this map contains the specified key, false otherwise.

public boolean containsValue (Object value)

Added in API level 1

Returns whether this map contains the specified value.

Parameters
value Object: the value to search for.
Returns
boolean true if this map contains the specified value, false otherwise.

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

Added in API level 1

Returns a set containing all of the mappings in this map. Each mapping is an instance of Map.Entry. As the set is backed by this map, changes in one will be reflected in the other.

Returns
Set<Entry<K, V>> a set of the mappings.

public boolean equals (Object object)

Added in API level 1

Compares this map with other objects. This map is equal to another map is it represents the same set of mappings. With this map, two mappings are the same if both the key and the value are equal by reference. When compared with a map that is not an IdentityHashMap, the equals method is neither necessarily symmetric (a.equals(b) implies b.equals(a)) nor transitive (a.equals(b) and b.equals(c) implies a.equals(c)).

Parameters
object Object: the object to compare to.
Returns
boolean whether the argument object is equal to this object.

public V get (Object key)

Added in API level 1

Returns the value of the mapping with the specified key.

Parameters
key Object: the key.
Returns
V the value of the mapping with the specified key.

public boolean isEmpty ()

Added in API level 1

Returns whether this IdentityHashMap has no elements.

Returns
boolean true if this IdentityHashMap has no elements, false otherwise.

See also:

public Set<K> keySet ()

Added in API level 1

Returns a set of the keys contained in this map. The set is backed by this map so changes to one are reflected by the other. The set does not support adding.

Returns
Set<K> a set of the keys.

public V put (K key, V value)

Added in API level 1

Maps the specified key to the specified value.

Parameters
key K: the key.
value V: the value.
Returns
V the value of any previous mapping with the specified key or null if there was no such mapping.

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

Added in API level 1

Copies all the mappings in the specified map to this map. These mappings will replace all mappings that this map had for any of the keys currently in the given map.

Parameters
map Map: the map to copy mappings from.
Throws
NullPointerException if map is null.

public V remove (Object key)

Added in API level 1

Removes the mapping with the specified key from this map.

Parameters
key Object: the key of the mapping to remove.
Returns
V the value of the removed mapping, or null if no mapping for the specified key was found.

public int size ()

Added in API level 1

Returns the number of mappings in this IdentityHashMap.

Returns
int the number of mappings in this IdentityHashMap.

public Collection<V> values ()

Added in API level 1

Returns a collection of the values contained in this map. The collection is backed by this map so changes to one are reflected by the other. The collection supports remove, removeAll, retainAll and clear operations, and it does not support add or addAll operations.

This method returns a collection which is the subclass of AbstractCollection. The iterator method of this subclass returns a "wrapper object" over the iterator of map's entrySet(). The size method wraps the map's size method and the contains method wraps the map's containsValue method.

The collection is created when this method is called for the first time and returned in response to all subsequent calls. This method may return different collections when multiple concurrent calls occur, since no synchronization is performed.

Returns
Collection<V> a collection of the values contained in this map.