HashSet (Java 2 Platform SE 5.0) (original) (raw)

java.util

Class HashSet

java.lang.Object extended by java.util.AbstractCollection java.util.AbstractSet java.util.HashSet

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, Set

Direct Known Subclasses:

JobStateReasons, LinkedHashSet

public class HashSet

extends AbstractSet

implements Set, Cloneable, Serializable

This class implements the Set interface, backed by a hash table (actually a HashMap instance). It makes no guarantees as to the iteration order of the set; in particular, it does not guarantee that the order will remain constant over time. This class permits the null element.

This class offers constant time performance for the basic operations (add, remove, contains and size), assuming the hash function disperses the elements properly among the buckets. Iterating over this set requires time proportional to the sum of the HashSet instance's size (the number of elements) plus the "capacity" of the backing HashMap instance (the number of buckets). Thus, it's very important not to set the initial capacity too high (or the load factor too low) if iteration performance is important.

Note that this implementation is not synchronized. If multiple threads access a set concurrently, and at least one of the threads modifies the set, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the set. If no such object exists, the set should be "wrapped" using theCollections.synchronizedSet method. This is best done at creation time, to prevent accidental unsynchronized access to the HashSet instance:

 Set s = Collections.synchronizedSet(new HashSet(...));

The iterators returned by this class's iterator method are_fail-fast_: if the set is modified at any time after the iterator is created, in any way except through the iterator's own remove method, the Iterator throws 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.

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.

This class is a member of the Java Collections Framework.

Since:

1.2

Constructor Summary
HashSet() Constructs a new, empty set; the backing HashMap instance has default initial capacity (16) and load factor (0.75).
HashSet(Collection<? extends E> c) Constructs a new set containing the elements in the specified collection.
HashSet(int initialCapacity) Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and default load factor, which is0.75.
[HashSet](../../java/util/HashSet.html#HashSet%28int, float%29)(int initialCapacity, float loadFactor) Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and the specified load factor.

Method Summary
boolean	add(E o) Adds the specified element to this set if it is not already present.
void	clear() Removes all of the elements from this set.
Object	clone() Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.
boolean	contains(Object o) Returns true if this set contains the specified element.
boolean	isEmpty() Returns true if this set contains no elements.
Iterator<E>	iterator() Returns an iterator over the elements in this set.
boolean	remove(Object o) Removes the specified element from this set if it is present.
int	size() Returns the number of elements in this set (its cardinality).

Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Constructor Detail

HashSet

public HashSet()

Constructs a new, empty set; the backing HashMap instance has default initial capacity (16) and load factor (0.75).

HashSet

public HashSet(Collection<? extends E> c)

Constructs a new set containing the elements in the specified collection. The HashMap is created with default load factor (0.75) and an initial capacity sufficient to contain the elements in the specified collection.

Parameters:

c - the collection whose elements are to be placed into this set.

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if the specified collection is null.

HashSet

public HashSet(int initialCapacity, float loadFactor)

Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and the specified load factor.

Parameters:

initialCapacity - the initial capacity of the hash map.

loadFactor - the load factor of the hash map.

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the initial capacity is less than zero, or if the load factor is nonpositive.

HashSet

public HashSet(int initialCapacity)

Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and default load factor, which is0.75.

Parameters:

initialCapacity - the initial capacity of the hash table.

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if the initial capacity is less than zero.

Method Detail

iterator

public Iterator<E> iterator()

Returns an iterator over the elements in this set. The elements are returned in no particular order.

Specified by:

[iterator](../../java/lang/Iterable.html#iterator%28%29) in interface [Iterable](../../java/lang/Iterable.html "interface in java.lang")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[iterator](../../java/util/Collection.html#iterator%28%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[iterator](../../java/util/Set.html#iterator%28%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[iterator](../../java/util/AbstractCollection.html#iterator%28%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Returns:

an Iterator over the elements in this set.

See Also:

ConcurrentModificationException

size

public int size()

Returns the number of elements in this set (its cardinality).

Specified by:

[size](../../java/util/Collection.html#size%28%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[size](../../java/util/Set.html#size%28%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[size](../../java/util/AbstractCollection.html#size%28%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Returns:

the number of elements in this set (its cardinality).

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

[isEmpty](../../java/util/Collection.html#isEmpty%28%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[isEmpty](../../java/util/Set.html#isEmpty%28%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Overrides:

[isEmpty](../../java/util/AbstractCollection.html#isEmpty%28%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Returns:

true if this set contains no elements.

contains

public boolean contains(Object o)

Returns true if this set contains the specified element.

Specified by:

[contains](../../java/util/Collection.html#contains%28java.lang.Object%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[contains](../../java/util/Set.html#contains%28java.lang.Object%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Overrides:

[contains](../../java/util/AbstractCollection.html#contains%28java.lang.Object%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Parameters:

o - element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

add

public boolean add(E o)

Adds the specified element to this set if it is not already present.

Specified by:

[add](../../java/util/Collection.html#add%28E%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[add](../../java/util/Set.html#add%28E%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Overrides:

[add](../../java/util/AbstractCollection.html#add%28E%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Parameters:

o - element to be added to this set.

Returns:

true if the set did not already contain the specified element.

remove

public boolean remove(Object o)

Removes the specified element from this set if it is present.

Specified by:

[remove](../../java/util/Collection.html#remove%28java.lang.Object%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[remove](../../java/util/Set.html#remove%28java.lang.Object%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Overrides:

[remove](../../java/util/AbstractCollection.html#remove%28java.lang.Object%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Parameters:

o - object to be removed from this set, if present.

Returns:

true if the set contained the specified element.

clear

public void clear()

Removes all of the elements from this set.

Specified by:

[clear](../../java/util/Collection.html#clear%28%29) in interface [Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Specified by:

[clear](../../java/util/Set.html#clear%28%29) in interface [Set](../../java/util/Set.html "interface in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

Overrides:

[clear](../../java/util/AbstractCollection.html#clear%28%29) in class [AbstractCollection](../../java/util/AbstractCollection.html "class in java.util")<[E](../../java/util/HashSet.html "type parameter in HashSet")>

clone

public Object clone()

Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.

Overrides:

[clone](../../java/lang/Object.html#clone%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a shallow copy of this set.

See Also:

Cloneable

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.