Android APIs
public class

Hashtable

extends Dictionary<K, V>
implements Map<K, V> Cloneable Serializable
java.lang.Object
   ↳ java.util.Dictionary<K, V>
     ↳ java.util.Hashtable<K, V>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Hashtable is a synchronized implementation of Map. All optional operations are supported.

Neither keys nor values can be null. (Use HashMap or LinkedHashMap if you need null keys or values.)

See also:

Summary

Public Constructors
Hashtable()
Constructs a new Hashtable using the default capacity and load factor.
Hashtable(int capacity)
Constructs a new Hashtable using the specified capacity and the default load factor.
Hashtable(int capacity, float loadFactor)
Constructs a new Hashtable using the specified capacity and load factor.
Hashtable(Map<? extends K, ? extends V> map)
Constructs a new instance of Hashtable containing the mappings from the specified map.
Public Methods
void clear()
Removes all key/value pairs from this Hashtable, leaving the size zero and the capacity unchanged.
Object clone()
Returns a new Hashtable with the same key/value pairs, capacity and load factor.
boolean contains(Object value)
Returns true if this Hashtable contains the specified object as the value of at least one of the key/value pairs.
boolean containsKey(Object key)
Returns true if this Hashtable contains the specified object as a key of one of the key/value pairs.
boolean containsValue(Object value)
Searches this Hashtable for the specified value.
Enumeration<V> elements()
Returns an enumeration on the values of this Hashtable.
Set<Entry<K, V>> entrySet()
Returns a set of the mappings contained in this Hashtable.
boolean equals(Object object)
Compares this Hashtable with the specified object and indicates if they are equal.
V get(Object key)
Returns the value associated with the specified key in this Hashtable.
int hashCode()
Returns an integer hash code for this object.
boolean isEmpty()
Returns true if this Hashtable has no key/value pairs.
Set<K> keySet()
Returns a set of the keys contained in this Hashtable.
Enumeration<K> keys()
Returns an enumeration on the keys of this Hashtable instance.
V put(K key, V value)
Associate the specified value with the specified key in this Hashtable.
void putAll(Map<? extends K, ? extends V> map)
Copies every mapping to this Hashtable from the specified map.
V remove(Object key)
Removes the key/value pair with the specified key from this Hashtable.
int size()
Returns the number of key/value pairs in this Hashtable.
String toString()
Returns the string representation of this Hashtable.
Collection<V> values()
Returns a collection of the values contained in this Hashtable.
Protected Methods
void rehash()
Increases the capacity of this Hashtable.
[Expand]
Inherited Methods
From class java.util.Dictionary
From class java.lang.Object
From interface java.util.Map

Public Constructors

public Hashtable ()

Added in API level 1

Constructs a new Hashtable using the default capacity and load factor.

public Hashtable (int capacity)

Added in API level 1

Constructs a new Hashtable using the specified capacity and the default load factor.

Parameters
capacity int: the initial capacity.

public Hashtable (int capacity, float loadFactor)

Added in API level 1

Constructs a new Hashtable using the specified capacity and load factor.

Parameters
capacity int: the initial capacity.
loadFactor float: the initial load factor.

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

Added in API level 1

Constructs a new instance of Hashtable containing the mappings from the specified map.

Parameters
map Map: the mappings to add.

Public Methods

public void clear ()

Added in API level 1

Removes all key/value pairs from this Hashtable, leaving the size zero and the capacity unchanged.

See also:

public Object clone ()

Added in API level 1

Returns a new Hashtable with the same key/value pairs, capacity and load factor.

Returns
Object a shallow copy of this Hashtable.

See also:

public boolean contains (Object value)

Added in API level 1

Returns true if this Hashtable contains the specified object as the value of at least one of the key/value pairs.

Parameters
value Object: the object to look for as a value in this Hashtable.
Returns
boolean true if object is a value in this Hashtable, false otherwise.

public boolean containsKey (Object key)

Added in API level 1

Returns true if this Hashtable contains the specified object as a key of one of the key/value pairs.

Parameters
key Object: the object to look for as a key in this Hashtable.
Returns
boolean true if object is a key in this Hashtable, false otherwise.

public boolean containsValue (Object value)

Added in API level 1

Searches this Hashtable for the specified value.

Parameters
value Object: the object to search for.
Returns
boolean true if value is a value of this Hashtable, false otherwise.

public Enumeration<V> elements ()

Added in API level 1

Returns an enumeration on the values of this Hashtable. The results of the Enumeration may be affected if the contents of this Hashtable are modified.

Returns
Enumeration<V> an enumeration of the values of this Hashtable.

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

Added in API level 1

Returns a set of the mappings contained in this Hashtable. Each element in the set is a Map.Entry. The set is backed by this Hashtable so changes to one are reflected by the other. The set does not support adding.

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

public boolean equals (Object object)

Added in API level 1

Compares this Hashtable with the specified object and indicates if they are equal. In order to be equal, object must be an instance of Map and contain the same key/value pairs.

Parameters
object Object: the object to compare with this object.
Returns
boolean true if the specified object is equal to this Map, false otherwise.

See also:

public V get (Object key)

Added in API level 1

Returns the value associated with the specified key in this Hashtable.

Parameters
key Object: the key of the value returned.
Returns
V the value associated with the specified key, or null if the specified key does not exist.

See also:

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public boolean isEmpty ()

Added in API level 1

Returns true if this Hashtable has no key/value pairs.

Returns
boolean true if this Hashtable has no key/value pairs, false otherwise.

See also:

public Set<K> keySet ()

Added in API level 1

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

Returns
Set<K> a set of the keys.

public Enumeration<K> keys ()

Added in API level 1

Returns an enumeration on the keys of this Hashtable instance. The results of the enumeration may be affected if the contents of this Hashtable are modified.

Returns
Enumeration<K> an enumeration of the keys of this Hashtable.

public V put (K key, V value)

Added in API level 1

Associate the specified value with the specified key in this Hashtable. If the key already exists, the old value is replaced. The key and value cannot be null.

Parameters
key K: the key to add.
value V: the value to add.
Returns
V the old value associated with the specified key, or null if the key did not exist.

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

Added in API level 1

Copies every mapping to this Hashtable from the specified map.

Parameters
map Map: the map to copy mappings from.

public V remove (Object key)

Added in API level 1

Removes the key/value pair with the specified key from this Hashtable.

Parameters
key Object: the key to remove.
Returns
V the value associated with the specified key, or null if the specified key did not exist.

public int size ()

Added in API level 1

Returns the number of key/value pairs in this Hashtable.

Returns
int the number of key/value pairs in this Hashtable.

See also:

public String toString ()

Added in API level 1

Returns the string representation of this Hashtable.

Returns
String the string representation of this Hashtable.

public Collection<V> values ()

Added in API level 1

Returns a collection of the values contained in this Hashtable. The collection is backed by this Hashtable so changes to one are reflected by the other. The collection does not support adding.

Returns
Collection<V> a collection of the values.

Protected Methods

protected void rehash ()

Added in API level 1

Increases the capacity of this Hashtable. This method is called when the size of this Hashtable exceeds the load factor.