Class | Tree | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Class java.util.Hashtable

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable

public class Hashtable
extends java.util.Dictionary
implements java.util.Map, java.lang.Cloneable, java.io.Serializable
This class implements a hashtable, which maps keys to values. Any non-null object can be used as a key or as a value.

To successfully store and retrieve objects from a hashtable, the objects used as keys must implement the hashCode method and the equals method.

An instance of Hashtable has two parameters that affect its efficiency: its capacity and its load factor. The load factor should be between 0.0 and 1.0. When the number of entries in the hashtable exceeds the product of the load factor and the current capacity, the capacity is increased by calling the rehash method. Larger load factors use memory more efficiently, at the expense of larger expected time per lookup.

If many entries are to be made into a Hashtable, creating it with a sufficiently large capacity may allow the entries to be inserted more efficiently than letting it perform automatic rehashing as needed to grow the table.

This example creates a hashtable of numbers. It uses the names of the numbers as keys:

     Hashtable numbers = new Hashtable();
     numbers.put("one", new Integer(1));
     numbers.put("two", new Integer(2));
     numbers.put("three", new Integer(3));
 

To retrieve a number, use the following code:

     Integer n = (Integer)numbers.get("two");
     if (n != null) {
         System.out.println("two = " + n);
     }
 

As of JDK1.2, this class has been retrofitted to implement Map, so that it becomes a part of Java's collection framework. Unlike the new collection implementations, Vector is synchronized.

The Iterators returned by the iterator and listIterator methods of the Collections returned by all of Hashtable's "collection view methods" are fail-fast: if the Hashtable is structurally modified at any time after the Iterator is created, in any way except through the Iterator's own remove or add methods, the Iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the Iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future. The Enumerations returned by Hashtable's keys and values methods are not fail-fast.

Since:
JDK1.0
Version:
1.65, 05/06/98
See Also:
equals(java.lang.Object), hashCode(), rehash(), java.util.Collection, java.util.Map, java.util.HashMap, TreeMap, Serialized Form

Inner Class Summary
static  Hashtable.Entry
          Hashtable collision list.
Hashtable.EntrySet
           
Hashtable.Enumerator
          A hashtable enumerator class.
Hashtable.KeySet
           
Hashtable.ValueCollection
           
 
Field Summary
int count
          The total number of entries in the hash table.
static int ENTRIES
           
java.util.Set entrySet
           
java.util.Set keySet
           
static int KEYS
           
float loadFactor
          The load factor for the hashtable.
int modCount
          The number of times this Hashtable has been structurally modified Structural modifications are those that change the number of entries in the Hashtable or otherwise modify its internal structure (e.g.
static long serialVersionUID
          use serialVersionUID from JDK 1.0.2 for interoperability
Hashtable.Entry[] table
          The hash table data.
int threshold
          The table is rehashed when its size exceeds this threshold.
java.util.Collection values
           
static int VALUES
           
 
Constructor Summary
Hashtable(int initialCapacity, float loadFactor)
          Constructs a new, empty hashtable with the specified initial capacity and the specified load factor.
Hashtable(int initialCapacity)
          Constructs a new, empty hashtable with the specified initial capacity and default load factor, which is 0.75.
Hashtable()
          Constructs a new, empty hashtable with a default capacity and load factor, which is 0.75.
Hashtable(java.util.Map t)
          Constructs a new hashtable with the same mappings as the given Map.
 
Method Summary
void clear()
          Clears this hashtable so that it contains no keys.
java.lang.Object clone()
          Creates a shallow copy of this hashtable.
boolean contains(java.lang.Object value)
          Tests if some key maps into the specified value in this hashtable.
boolean containsKey(java.lang.Object key)
          Tests if the specified object is a key in this hashtable.
boolean containsValue(java.lang.Object value)
          Returns true if this Hashtable maps one or more keys to this value.
java.util.Enumeration elements()
          Returns an enumeration of the values in this hashtable.
java.util.Set entrySet()
          Returns a Set view of the entries contained in this Hashtable.
boolean equals(java.lang.Object o)
          Compares the specified Object with this Map for equality, as per the definition in the Map interface.
java.lang.Object get(java.lang.Object key)
          Returns the value to which the specified key is mapped in this hashtable.
int hashCode()
          Returns the hash code value for this Map as per the definition in the Map interface.
boolean isEmpty()
          Tests if this hashtable maps no keys to values.
java.util.Set keySet()
          Returns a Set view of the keys contained in this Hashtable.
java.util.Enumeration keys()
          Returns an enumeration of the keys in this hashtable.
void putAll(java.util.Map t)
          Copies all of the mappings from the specified Map to this Hashtable These mappings will replace any mappings that this Hashtable had for any of the keys currently in the specified Map.
java.lang.Object put(java.lang.Object key, java.lang.Object value)
          Maps the specified key to the specified value in this hashtable.
void readObject(java.io.ObjectInputStream s)
          Reconstitute the Hashtable from a stream (i.e.
void rehash()
          Increases the capacity of and internally reorganizes this hashtable, in order to accommodate and access its entries more efficiently.
java.lang.Object remove(java.lang.Object key)
          Removes the key (and its corresponding value) from this hashtable.
int size()
          Returns the number of keys in this hashtable.
java.lang.String toString()
          Returns a string representation of this Hashtable object in the form of a set of entries, enclosed in braces and separated by the ASCII characters "" (comma and space).
java.util.Collection values()
          Returns a Collection view of the values contained in this Hashtable.
void writeObject(java.io.ObjectOutputStream s)
          Save the state of the Hashtable to a stream (i.e.
 
Methods inherited from class java.util.Dictionary
elements, get, isEmpty, keys, put, remove, size
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notifyAll, notify, registerNatives, toString, wait, wait, wait
 

Field Detail

table

private transient Hashtable.Entry[] table
The hash table data.

count

private transient int count
The total number of entries in the hash table.

threshold

private int threshold
The table is rehashed when its size exceeds this threshold. (The value of this field is (int)(capacity * loadFactor).)

loadFactor

private float loadFactor
The load factor for the hashtable.

modCount

private transient int modCount
The number of times this Hashtable has been structurally modified Structural modifications are those that change the number of entries in the Hashtable or otherwise modify its internal structure (e.g., rehash). This field is used to make iterators on Collection-views of the Hashtable fail-fast. (See ConcurrentModificationException).

serialVersionUID

private static final long serialVersionUID
use serialVersionUID from JDK 1.0.2 for interoperability

keySet

private transient java.util.Set keySet

entrySet

private transient java.util.Set entrySet

values

private transient java.util.Collection values

KEYS

private static final int KEYS

VALUES

private static final int VALUES

ENTRIES

private static final int ENTRIES
Constructor Detail

Hashtable

public Hashtable(int initialCapacity,
                 float loadFactor)
Constructs a new, empty hashtable with the specified initial capacity and the specified load factor.
Parameters:
initialCapacity - the initial capacity of the hashtable.
loadFactor - a number between 0.0 and 1.0.
Throws:
java.lang.IllegalArgumentException - if the initial capacity is less than zero, if the load factor is less than or equal to zero, or if the load factor is greater than one.

Hashtable

public Hashtable(int initialCapacity)
Constructs a new, empty hashtable with the specified initial capacity and default load factor, which is 0.75.
Parameters:
initialCapacity - the initial capacity of the hashtable.
Throws:
java.lang.IllegalArgumentException - if the initial capacity is less than zero

Hashtable

public Hashtable()
Constructs a new, empty hashtable with a default capacity and load factor, which is 0.75.

Hashtable

public Hashtable(java.util.Map t)
Constructs a new hashtable with the same mappings as the given Map. The hashtable is created with a capacity of thrice the number of entries in the given Map or 11 (whichever is greater), and a default load factor.
Method Detail

size

public int size()
Returns the number of keys in this hashtable.
Specified by:
size() in interface java.util.Map
Returns:
the number of keys in this hashtable.
Overrides:
size in class java.util.Dictionary

isEmpty

public boolean isEmpty()
Tests if this hashtable maps no keys to values.
Specified by:
isEmpty() in interface java.util.Map
Returns:
true if this hashtable maps no keys to values; false otherwise.
Overrides:
isEmpty in class java.util.Dictionary

keys

public java.util.Enumeration keys()
Returns an enumeration of the keys in this hashtable.
Returns:
an enumeration of the keys in this hashtable.
Overrides:
keys in class java.util.Dictionary
See Also:
java.util.Enumeration, elements(), keySet(), java.util.Map

elements

public java.util.Enumeration elements()
Returns an enumeration of the values in this hashtable. Use the Enumeration methods on the returned object to fetch the elements sequentially.
Returns:
an enumeration of the values in this hashtable.
Overrides:
elements in class java.util.Dictionary
See Also:
java.util.Enumeration, keys(), values(), java.util.Map

contains

public boolean contains(java.lang.Object value)
Tests if some key maps into the specified value in this hashtable. This operation is more expensive than the containsKey method.

Note that this method is identical in functionality to containsValue, (which is part of the Map interface in the collections framework).

Parameters:
value - a value to search for.
Returns:
true if and only if some key maps to the value argument in this hashtable as determined by the equals method; false otherwise.
Throws:
NullPointerException - if the value is null.
See Also:
containsKey(Object), containsValue(Object), java.util.Map


containsValue

public boolean containsValue(java.lang.Object value)
Returns true if this Hashtable maps one or more keys to this value.

Note that this method is identical in functionality to contains (which predates the Map interface).

Specified by:
containsValue(java.lang.Object) in interface java.util.Map
Parameters:
value - value whose presence in this Hashtable is to be tested.
See Also:
java.util.Map


containsKey

public boolean containsKey(java.lang.Object key)
Tests if the specified object is a key in this hashtable.
Specified by:
containsKey(java.lang.Object) in interface java.util.Map
Parameters:
key - possible key.
Returns:
true if and only if the specified object is a key in this hashtable, as determined by the equals method; false otherwise.
See Also:
contains(Object)

get

public java.lang.Object get(java.lang.Object key)
Returns the value to which the specified key is mapped in this hashtable.
Specified by:
get(java.lang.Object) in interface java.util.Map
Parameters:
key - a key in the hashtable.
Returns:
the value to which the key is mapped in this hashtable; null if the key is not mapped to any value in this hashtable.
Overrides:
get in class java.util.Dictionary
See Also:
put(Object, Object)

rehash

protected void rehash()
Increases the capacity of and internally reorganizes this hashtable, in order to accommodate and access its entries more efficiently. This method is called automatically when the number of keys in the hashtable exceeds this hashtable's capacity and load factor.

put

public java.lang.Object put(java.lang.Object key,
                  java.lang.Object value)
Maps the specified key to the specified value in this hashtable. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:
put(java.lang.Object, java.lang.Object) in interface java.util.Map
Parameters:
key - the hashtable key.
value - the value.
Returns:
the previous value of the specified key in this hashtable, or null if it did not have one.
Throws:
NullPointerException - if the key or value is null.
Overrides:
put in class java.util.Dictionary
See Also:
equals(Object), get(Object)


remove

public java.lang.Object remove(java.lang.Object key)
Removes the key (and its corresponding value) from this hashtable. This method does nothing if the key is not in the hashtable.
Specified by:
remove(java.lang.Object) in interface java.util.Map
Parameters:
key - the key that needs to be removed.
Returns:
the value to which the key had been mapped in this hashtable, or null if the key did not have a mapping.
Overrides:
remove in class java.util.Dictionary

putAll

public void putAll(java.util.Map t)
Copies all of the mappings from the specified Map to this Hashtable These mappings will replace any mappings that this Hashtable had for any of the keys currently in the specified Map.
Specified by:
putAll(java.util.Map) in interface java.util.Map

clear

public void clear()
Clears this hashtable so that it contains no keys.
Specified by:
clear() in interface java.util.Map

clone

public java.lang.Object clone()
Creates a shallow copy of this hashtable. All the structure of the hashtable itself is copied, but the keys and values are not cloned. This is a relatively expensive operation.
Returns:
a clone of the hashtable.
Overrides:
clone in class java.lang.Object

toString

public java.lang.String toString()
Returns a string representation of this Hashtable object in the form of a set of entries, enclosed in braces and separated by the ASCII characters "" (comma and space). Each entry is rendered as the key, an equals sign =, and the associated element, where the toString method is used to convert the key and element to strings.

Overrides to toString method of Object.

Returns:
a string representation of this hashtable.
Overrides:
toString in class java.lang.Object


keySet

public java.util.Set keySet()
Returns a Set view of the keys contained in this Hashtable. The Set is backed by the Hashtable, so changes to the Hashtable are reflected in the Set, and vice-versa. The Set supports element removal (which removes the corresponding entry from the Hashtable), but not element addition.
Specified by:
keySet() in interface java.util.Map

entrySet

public java.util.Set entrySet()
Returns a Set view of the entries contained in this Hashtable. Each element in this collection is a Map.Entry. The Set is backed by the Hashtable, so changes to the Hashtable are reflected in the Set, and vice-versa. The Set supports element removal (which removes the corresponding entry from the Hashtable) via its Iterator, but not element addition or "direct" element removal.
Specified by:
entrySet() in interface java.util.Map
See Also:
java.util.Map.Entry

values

public java.util.Collection values()
Returns a Collection view of the values contained in this Hashtable. The Collection is backed by the Hashtable, so changes to the Hashtable are reflected in the Collection, and vice-versa. The Collection supports element removal (which removes the corresponding entry from the Hashtable) via its Iterator, but not element addition or "direct" element removal.
Specified by:
values() in interface java.util.Map

equals

public boolean equals(java.lang.Object o)
Compares the specified Object with this Map for equality, as per the definition in the Map interface.
Specified by:
equals(java.lang.Object) in interface java.util.Map
Returns:
true if the specified Object is equal to this Map.
Overrides:
equals in class java.lang.Object
See Also:
equals(Object)

hashCode

public int hashCode()
Returns the hash code value for this Map as per the definition in the Map interface.
Specified by:
hashCode() in interface java.util.Map
Overrides:
hashCode in class java.lang.Object
See Also:
hashCode()

writeObject

private void writeObject(java.io.ObjectOutputStream s)
                 throws IOException
Save the state of the Hashtable to a stream (i.e., serialize it).

readObject

private void readObject(java.io.ObjectInputStream s)
                throws IOException,
                       java.lang.ClassNotFoundException
Reconstitute the Hashtable from a stream (i.e., deserialize it).

Class | Tree | Index | Help
PREV CLASS | NEXT CLASS FRAMES  | NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD