java.util: public class: HashSet

java.util
public class: HashSet [javadoc | source]

java.lang.Object
   java.util.AbstractCollection<E>
      java.util.AbstractSet<E>
         java.util.HashSet

All Implemented Interfaces:
Set, Cloneable, Serializable, Collection

Direct Known Subclasses:
LinkedHashSet, JobStateReasons

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 hash 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 the Collections.synchronizedSet method. This is best done at creation time, to prevent accidental unsynchronized access to the set:

  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.

Parameters:

- the type of elements maintained by this set

Also see:

author: Josh - Bloch

author: Neal - Gafter

since: 1.2 -

Field Summary
static final long	serialVersionUID

Constructor:

Constructor:
public HashSet() { map = new HashMap< >(); } Constructs a new, empty set; the backing `HashMap` instance has default initial capacity (16) and load factor (0.75).
public HashSet(Collection<? extends E> c) { map = new HashMap< >(Math.max((int) (c.size()/.75f) + 1, 16)); addAll(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` - if the specified collection is null
public HashSet(int initialCapacity) { map = new HashMap< >(initialCapacity); } Constructs a new, empty set; the backing `HashMap` instance has the specified initial capacity and default load factor (0.75). Parameters: `initialCapacity` - the initial capacity of the hash table Throws: `IllegalArgumentException` - if the initial capacity is less than zero
public HashSet(int initialCapacity, float loadFactor) { map = new HashMap< >(initialCapacity, 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` - if the initial capacity is less than zero, or if the load factor is nonpositive
HashSet(int initialCapacity, float loadFactor, boolean dummy) { map = new LinkedHashMap< >(initialCapacity, loadFactor); } Constructs a new, empty linked hash set. (This package private constructor is only used by LinkedHashSet.) The backing HashMap instance is a LinkedHashMap with 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 `dummy` - ignored (distinguishes this constructor from other int, float constructor.) Throws: `IllegalArgumentException` - if the initial capacity is less than zero, or if the load factor is nonpositive

 public HashSet() {
        map = new HashMap<  >();
}

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

 public HashSet(Collection<? extends E> c) {
        map = new HashMap<  >(Math.max((int) (c.size()/.75f) + 1, 16));
        addAll(c);
}

HashMap

Parameters:

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

Throws:

NullPointerException - if the specified collection is null

 public HashSet(int initialCapacity) {
        map = new HashMap<  >(initialCapacity);
}

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

Parameters:

initialCapacity - the initial capacity of the hash table

Throws:

IllegalArgumentException - if the initial capacity is less than zero

 public HashSet(int initialCapacity,
    float loadFactor) {
        map = new HashMap<  >(initialCapacity, 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 - if the initial capacity is less than zero, or if the load factor is nonpositive

 HashSet(int initialCapacity,
    float loadFactor,
    boolean dummy) {
        map = new LinkedHashMap<  >(initialCapacity, loadFactor);
}

Constructs a new, empty linked hash set. (This package private constructor is only used by LinkedHashSet.) The backing HashMap instance is a LinkedHashMap with 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

dummy - ignored (distinguishes this constructor from other int, float constructor.)

Throws:

IllegalArgumentException - if the initial capacity is less than zero, or if the load factor is nonpositive

Method from java.util.HashSet Summary:
add, clear, clone, contains, isEmpty, iterator, remove, size

Methods from java.util.AbstractSet:
equals, hashCode, removeAll

Methods from java.util.AbstractCollection:
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.util.HashSet Detail:
public boolean add(E e) { return map.put(e, PRESENT)==null; } Adds the specified element to this set if it is not already present. More formally, adds the specified element `e` to this set if this set contains no element `e2` such that `(e==null ? e2==null : e.equals(e2))`. If this set already contains the element, the call leaves the set unchanged and returns `false`.
public void clear() { map.clear(); } Removes all of the elements from this set. The set will be empty after this call returns.
public Object clone() { try { HashSet< E > newSet = (HashSet< E >) super.clone(); newSet.map = (HashMap< E, Object >) map.clone(); return newSet; } catch (CloneNotSupportedException e) { throw new InternalError(); } } Returns a shallow copy of this `HashSet` instance: the elements themselves are not cloned.
public boolean contains(Object o) { return map.containsKey(o); } Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `(o==null ? e==null : o.equals(e))`.
public boolean isEmpty() { return map.isEmpty(); } Returns `true` if this set contains no elements.
public Iterator<E> iterator() { return map.keySet().iterator(); } Returns an iterator over the elements in this set. The elements are returned in no particular order.
public boolean remove(Object o) { return map.remove(o)==PRESENT; } Removes the specified element from this set if it is present. More formally, removes an element `e` such that `(o==null ? e==null : o.equals(e))`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)
public int size() { return map.size(); } Returns the number of elements in this set (its cardinality).

Method from java.util.HashSet Detail:

 public boolean add(E e) {
        return map.put(e, PRESENT)==null;
}

e

e2

(e==null ? e2==null : e.equals(e2))

false

 public  void clear() {
        map.clear();
}

Removes all of the elements from this set. The set will be empty after this call returns.

 public Object clone() {
        try {
            HashSet< E > newSet = (HashSet< E >) super.clone();
            newSet.map = (HashMap< E, Object >) map.clone();
            return newSet;
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }
}

HashSet

 public boolean contains(Object o) {
        return map.containsKey(o);
}

true

e

(o==null ? e==null : o.equals(e))

 public boolean isEmpty() {
        return map.isEmpty();
}

true

 public Iterator<E> iterator() {
        return map.keySet().iterator();
}

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

 public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
}

e

(o==null ? e==null : o.equals(e))

true

 public int size() {
        return map.size();
}

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