java.util
public class: Hashtable [javadoc |
source]
java.lang.Object
java.util.Dictionary<K, V>
java.util.Hashtable
All Implemented Interfaces:
Cloneable, Map, java$io$Serializable
Direct Known Subclasses:
NoneProvider, UIDefaults, BasicDefaults, Properties, MultiUIDefaults, Provider, MultiUIDefaults, AuthProvider
This class implements a hash table, 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
performance: initial capacity and load factor. The
capacity is the number of buckets in the hash table, and the
initial capacity is simply the capacity at the time the hash table
is created. Note that the hash table is open: in the case of a "hash
collision", a single bucket stores multiple entries, which must be searched
sequentially. The load factor is a measure of how full the hash
table is allowed to get before its capacity is automatically increased.
The initial capacity and load factor parameters are merely hints to
the implementation. The exact details as to when and whether the rehash
method is invoked are implementation-dependent.
Generally, the default load factor (.75) offers a good tradeoff between
time and space costs. Higher values decrease the space overhead but
increase the time cost to look up an entry (which is reflected in most
Hashtable operations, including get and put).
The initial capacity controls a tradeoff between wasted space and the
need for rehash
operations, which are time-consuming.
No rehash
operations will ever occur if the initial
capacity is greater than the maximum number of entries the
Hashtable will contain divided by its load factor. However,
setting the initial capacity too high can waste space.
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:
{@code
Hashtable numbers
= new Hashtable();
numbers.put("one", 1);
numbers.put("two", 2);
numbers.put("three", 3);}
To retrieve a number, use the following code:
{@code
Integer n = numbers.get("two");
if (n != null) {
System.out.println("two = " + n);
}}
The iterators returned by the iterator method of the collections
returned by all of this class'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 method, 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 elements methods are
not fail-fast.
Note that the fail-fast behavior of an iterator cannot be guaranteed
as it is, generally speaking, impossible to make any hard guarantees in the
presence of unsynchronized concurrent modification. Fail-fast iterators
throw ConcurrentModificationException on a best-effort basis.
Therefore, it would be wrong to write a program that depended on this
exception for its correctness: the fail-fast behavior of iterators
should be used only to detect bugs.
As of the Java 2 platform v1.2, this class was retrofitted to
implement the Map interface, making it a member of the
Java Collections Framework. Unlike the new collection
implementations, {@code Hashtable} is synchronized. If a
thread-safe implementation is not needed, it is recommended to use
HashMap in place of {@code Hashtable}. If a thread-safe
highly-concurrent implementation is desired, then it is recommended
to use java.util.concurrent.ConcurrentHashMap in place of
{@code Hashtable}.
Also see:
- Object#equals(java.lang.Object)
- Object#hashCode()
- Hashtable#rehash()
- Collection
- Map
- HashMap
- TreeMap
- author:
Arthur
- van Hoff
- author:
Josh
- Bloch
- author:
Neal
- Gafter
- since:
JDK1.0
-
Constructor: |
public Hashtable() {
this(11, 0.75f);
}
Constructs a new, empty hashtable with a default initial capacity (11)
and load factor (0.75). |
public Hashtable(int initialCapacity) {
this(initialCapacity, 0.75f);
}
Constructs a new, empty hashtable with the specified initial capacity
and default load factor (0.75). Parameters:
initialCapacity - the initial capacity of the hashtable.
Throws:
IllegalArgumentException - if the initial capacity is less
than zero.
- exception:
IllegalArgumentException - if the initial capacity is less
than zero.
|
public Hashtable(Map<? extends K, ? extends V> t) {
this(Math.max(2*t.size(), 11), 0.75f);
putAll(t);
}
Constructs a new hashtable with the same mappings as the given
Map. The hashtable is created with an initial capacity sufficient to
hold the mappings in the given Map and a default load factor (0.75). Parameters:
t - the map whose mappings are to be placed in this map.
Throws:
NullPointerException - if the specified map is null.
- since:
1.2 -
|
public Hashtable(int initialCapacity,
float loadFactor) {
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
if (loadFactor < = 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal Load: "+loadFactor);
if (initialCapacity==0)
initialCapacity = 1;
this.loadFactor = loadFactor;
table = new Entry[initialCapacity];
threshold = (int)(initialCapacity * 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 - the load factor of the hashtable.
Throws:
IllegalArgumentException - if the initial capacity is less
than zero, or if the load factor is nonpositive.
- exception:
IllegalArgumentException - if the initial capacity is less
than zero, or if the load factor is nonpositive.
|
Method from java.util.Hashtable Summary: |
---|
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keySet, keys, put, putAll, rehash, remove, size, toString, values |
Methods from java.lang.Object: |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method from java.util.Hashtable Detail: |
public synchronized void clear() {
Entry tab[] = table;
modCount++;
for (int index = tab.length; --index >= 0; )
tab[index] = null;
count = 0;
}
Clears this hashtable so that it contains no keys. |
public synchronized Object clone() {
try {
Hashtable< K,V > t = (Hashtable< K,V >) super.clone();
t.table = new Entry[table.length];
for (int i = table.length ; i-- > 0 ; ) {
t.table[i] = (table[i] != null)
? (Entry< K,V >) table[i].clone() : null;
}
t.keySet = null;
t.entrySet = null;
t.values = null;
t.modCount = 0;
return t;
} catch (CloneNotSupportedException e) {
// this shouldn't happen, since we are Cloneable
throw new InternalError();
}
}
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. |
public synchronized boolean contains(Object value) {
if (value == null) {
throw new NullPointerException();
}
Entry tab[] = table;
for (int i = tab.length ; i-- > 0 ;) {
for (Entry< K,V > e = tab[i] ; e != null ; e = e.next) {
if (e.value.equals(value)) {
return true;
}
}
}
return false;
}
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). |
public synchronized boolean containsKey(Object key) {
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry< K,V > e = tab[index] ; e != null ; e = e.next) {
if ((e.hash == hash) && e.key.equals(key)) {
return true;
}
}
return false;
}
Tests if the specified object is a key in this hashtable. |
public boolean containsValue(Object value) {
return contains(value);
}
|
public synchronized Enumeration<V> elements() {
return this.< V >getEnumeration(VALUES);
}
Returns an enumeration of the values in this hashtable.
Use the Enumeration methods on the returned object to fetch the elements
sequentially. |
public Set<K, V> entrySet() {
if (entrySet==null)
entrySet = Collections.synchronizedSet(new EntrySet(), this);
return entrySet;
}
Returns a Set view of the mappings contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation, or through the
setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. The set
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Set.remove, removeAll, retainAll and
clear operations. It does not support the
add or addAll operations. |
public synchronized boolean equals(Object o) {
if (o == this)
return true;
if (!(o instanceof Map))
return false;
Map< K,V > t = (Map< K,V >) o;
if (t.size() != size())
return false;
try {
Iterator< Map.Entry< K,V > > i = entrySet().iterator();
while (i.hasNext()) {
Map.Entry< K,V > e = i.next();
K key = e.getKey();
V value = e.getValue();
if (value == null) {
if (!(t.get(key)==null && t.containsKey(key)))
return false;
} else {
if (!value.equals(t.get(key)))
return false;
}
}
} catch (ClassCastException unused) {
return false;
} catch (NullPointerException unused) {
return false;
}
return true;
}
Compares the specified Object with this Map for equality,
as per the definition in the Map interface. |
public synchronized V get(Object key) {
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry< K,V > e = tab[index] ; e != null ; e = e.next) {
if ((e.hash == hash) && e.key.equals(key)) {
return e.value;
}
}
return null;
}
Returns the value to which the specified key is mapped,
or {@code null} if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
{@code k} to a value {@code v} such that {@code (key.equals(k))},
then this method returns {@code v}; otherwise it returns
{@code null}. (There can be at most one such mapping.) |
public synchronized int hashCode() {
/*
* This code detects the recursion caused by computing the hash code
* of a self-referential hash table and prevents the stack overflow
* that would otherwise result. This allows certain 1.1-era
* applets with self-referential hash tables to work. This code
* abuses the loadFactor field to do double-duty as a hashCode
* in progress flag, so as not to worsen the space performance.
* A negative load factor indicates that hash code computation is
* in progress.
*/
int h = 0;
if (count == 0 || loadFactor < 0)
return h; // Returns zero
loadFactor = -loadFactor; // Mark hashCode computation in progress
Entry[] tab = table;
for (int i = 0; i < tab.length; i++)
for (Entry e = tab[i]; e != null; e = e.next)
h += e.key.hashCode() ^ e.value.hashCode();
loadFactor = -loadFactor; // Mark hashCode computation complete
return h;
}
Returns the hash code value for this Map as per the definition in the
Map interface. |
public synchronized boolean isEmpty() {
return count == 0;
}
Tests if this hashtable maps no keys to values. |
public Set<K> keySet() {
if (keySet == null)
keySet = Collections.synchronizedSet(new KeySet(), this);
return keySet;
}
Returns a Set view of the keys contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations. |
public synchronized Enumeration<K> keys() {
return this.< K >getEnumeration(KEYS);
}
Returns an enumeration of the keys in this hashtable. |
public synchronized V put(K key,
V value) {
// Make sure the value is not null
if (value == null) {
throw new NullPointerException();
}
// Makes sure the key is not already in the hashtable.
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry< K,V > e = tab[index] ; e != null ; e = e.next) {
if ((e.hash == hash) && e.key.equals(key)) {
V old = e.value;
e.value = value;
return old;
}
}
modCount++;
if (count >= threshold) {
// Rehash the table if the threshold is exceeded
rehash();
tab = table;
index = (hash & 0x7FFFFFFF) % tab.length;
}
// Creates the new entry.
Entry< K,V > e = tab[index];
tab[index] = new Entry< >(hash, key, value, e);
count++;
return null;
}
|
public synchronized void putAll(Map<? extends K, ? extends V> t) {
for (Map.Entry< ? extends K, ? extends V > e : t.entrySet())
put(e.getKey(), e.getValue());
}
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. |
protected void rehash() {
int oldCapacity = table.length;
Entry[] oldMap = table;
// overflow-conscious code
int newCapacity = (oldCapacity < < 1) + 1;
if (newCapacity - MAX_ARRAY_SIZE > 0) {
if (oldCapacity == MAX_ARRAY_SIZE)
// Keep running with MAX_ARRAY_SIZE buckets
return;
newCapacity = MAX_ARRAY_SIZE;
}
Entry[] newMap = new Entry[newCapacity];
modCount++;
threshold = (int)(newCapacity * loadFactor);
table = newMap;
for (int i = oldCapacity ; i-- > 0 ;) {
for (Entry< K,V > old = oldMap[i] ; old != null ; ) {
Entry< K,V > e = old;
old = old.next;
int index = (e.hash & 0x7FFFFFFF) % newCapacity;
e.next = newMap[index];
newMap[index] = e;
}
}
}
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. |
public synchronized V remove(Object key) {
Entry tab[] = table;
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % tab.length;
for (Entry< K,V > e = tab[index], prev = null ; e != null ; prev = e, e = e.next) {
if ((e.hash == hash) && e.key.equals(key)) {
modCount++;
if (prev != null) {
prev.next = e.next;
} else {
tab[index] = e.next;
}
count--;
V oldValue = e.value;
e.value = null;
return oldValue;
}
}
return null;
}
Removes the key (and its corresponding value) from this
hashtable. This method does nothing if the key is not in the hashtable. |
public synchronized int size() {
return count;
}
Returns the number of keys in this hashtable. |
public synchronized String toString() {
int max = size() - 1;
if (max == -1)
return "{}";
StringBuilder sb = new StringBuilder();
Iterator< Map.Entry< K,V > > it = entrySet().iterator();
sb.append('{');
for (int i = 0; ; i++) {
Map.Entry< K,V > e = it.next();
K key = e.getKey();
V value = e.getValue();
sb.append(key == this ? "(this Map)" : key.toString());
sb.append('=');
sb.append(value == this ? "(this Map)" : value.toString());
if (i == max)
return sb.append('}').toString();
sb.append(", ");
}
}
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. |
public Collection<V> values() {
if (values==null)
values = Collections.synchronizedCollection(new ValueCollection(),
this);
return values;
}
Returns a Collection view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations. |