Module java.base
Package java.util

Class HashSet<E>

  • Type Parameters:
    E - the type of elements maintained by this set
    All Implemented Interfaces:
    Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>
    Direct Known Subclasses:
    JobStateReasons, LinkedHashSet

    public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, 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 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.

    Since:
    1.2
    See Also:
    Collection, Set, TreeSet, HashMap, Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      HashSet​()
      Constructs a new, empty set; the backing HashMap instance has default initial capacity (16) and load factor (0.75).
      HashSet​(int initialCapacity)
      Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and default load factor (0.75).
      HashSet​(int initialCapacity, float loadFactor)
      Constructs a new, empty set; the backing HashMap instance has the specified initial capacity and the specified load factor.
      HashSet​(Collection<? extends E> c)
      Constructs a new set containing the elements in the specified collection.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(E e)
      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).
      Spliterator<E> spliterator​()
      Creates a late-binding and fail-fast Spliterator over the elements in this set.