Android
java.util
public abstract class

java.util.AbstractMap<K, V>

java.lang.Object
java.util.AbstractMap<K, V> Map<K, V>

AbstractMap is an abstract implementation of the Map interface. This Implementation does not support adding. A subclass must implement the abstract method entrySet().

Known Direct Subclasses
Known Indirect Subclasses

Summary

Protected Constructors

            AbstractMap()
Constructs a new instance of this AbstractMap.

Public Methods

          void  clear()
Removes all elements from this Map, leaving it empty.
          boolean  containsKey(Object key)
Searches this Map for the specified key.
          boolean  containsValue(Object value)
Searches this Map for the specified value.
abstract          Set<Entry<K, V>>  entrySet()
Returns a set view of the mappings contained in this map.
          boolean  equals(Object object)
Compares the specified object to this Map and answer if they are equal.
          get(Object key)
Returns the value of the mapping with the specified key.
          int  hashCode()
Returns an integer hash code for the receiver.
          boolean  isEmpty()
Returns if this Map has no elements, a size of zero.
          Set<K>  keySet()
Returns a Set of the keys contained in this Map.
          put(K key, V value)
Maps the specified key to the specified value.
          void  putAll(Map<? extends K, ? extends V> map)
Copies every mapping in the specified Map to this Map.
          remove(Object key)
Removes a mapping with the specified key from this Map.
          int  size()
Returns the number of elements in this Map.
          String  toString()
Returns the string representation of this Map.
          Collection<V>  values()
Returns a collection of the values contained in this map.

Protected Methods

          Object  clone()
Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
Methods inherited from class java.lang.Object
Methods inherited from interface java.util.Map

Details

Protected Constructors

protected AbstractMap()

Constructs a new instance of this AbstractMap.

Public Methods

public void clear()

Removes all elements from this Map, leaving it empty.

Throws

UnsupportedOperationException when removing from this Map is not supported

See Also

public boolean containsKey(Object key)

Searches this Map for the specified key.

Parameters

key the object to search for

Returns

  • true if key is a key of this Map, false otherwise

public boolean containsValue(Object value)

Searches this Map for the specified value.

Parameters

value the object to search for

Returns

  • true if value is a value of this Map, false otherwise

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

Returns a set view of the mappings contained in this map. Each element in this set is a Map.Entry. The set is backed by the map so changes to one are reflected by the other. (If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined.) The set supports remove, removeAll, retainAll and clear operations, and it does not support add or addAll operations.

Returns

  • a set of the mappings contained in this map

public boolean equals(Object object)

Compares the specified object to this Map and answer if they are equal. The object must be an instance of Map and contain the same key/value pairs.

Parameters

object the object to compare with this object

Returns

  • true if the specified object is equal to this Map, false otherwise

See Also

public V get(Object key)

Returns the value of the mapping with the specified key.

Parameters

key the key

Returns

  • the value of the mapping with the specified key

public int hashCode()

Returns an integer hash code for the receiver. Objects which are equal answer the same value for this method.

Returns

  • the receiver's hash

See Also

public boolean isEmpty()

Returns if this Map has no elements, a size of zero.

Returns

  • true if this Map has no elements, false otherwise

See Also

public Set<K> keySet()

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

  • a Set of the keys

public V put(K key, V value)

Maps the specified key to the specified value.

Parameters

key the key
value the value

Returns

  • the value of any previous mapping with the specified key or null if there was no mapping

Throws

UnsupportedOperationException when adding to this Map is not supported
ClassCastException when the class of the key or value is inappropriate for this Map
IllegalArgumentException when the key or value cannot be added to this Map
NullPointerException when the key or value is null and this Map does not support null keys or values

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

Copies every mapping in the specified Map to this Map.

Parameters

map the Map to copy mappings from

Throws

UnsupportedOperationException when adding to this Map is not supported
ClassCastException when the class of a key or value is inappropriate for this Map
IllegalArgumentException when a key or value cannot be added to this Map
NullPointerException when a key or value is null and this Map does not support null keys or values

public V remove(Object key)

Removes a mapping with the specified key from this Map.

Parameters

key the key of the mapping to remove

Returns

  • the value of the removed mapping or null if key is not a key in this Map

Throws

UnsupportedOperationException when removing from this Map is not supported

public int size()

Returns the number of elements in this Map.

Returns

  • the number of elements in this Map

public String toString()

Returns the string representation of this Map.

Returns

  • the string representation of this Map

public Collection<V> values()

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 at first time and returned in response to all subsequent calls. This method may return different Collection when multiple calls to this method, since it has no synchronization performed.

Returns

  • a collection of the values contained in this map

Protected Methods

protected Object clone()

Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.

Returns

  • Object a shallow copy of this object.

Throws

CloneNotSupportedException if the receiver's class does not implement the interface Cloneable.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48