HashSet源码

package java.util;

import java.io.InvalidObjectException;
import sun.misc.SharedSecrets;

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
{
    static final long serialVersionUID = -5024744406713321676L;

    private transient HashMap<E,Object> map;

    // 要与背景映射中的对象关联的虚拟值，默认的value
    private static final Object PRESENT = new Object();

    /* 默认初始容量(16)和加载因子(0.75) */
    public HashSet() {
        map = new HashMap<>();
    }

    /**构造一个新集，其中包含指定的集合中的元素。使用默认负载因子*(0.75)创建的，初始容量足以包含指定集合中的元素。*/
    public HashSet(Collection<? extends E> c) {
        map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
        addAll(c);
    }

    /**用指定的初始容量和指定的加载因子初始化*/
    public HashSet(int initialCapacity, float loadFactor) {
        map = new HashMap<>(initialCapacity, loadFactor);
    }

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

    /**构造一个新的空链接哈希集。(此包私有构造函数仅由LinkedHashSet使用。)哈希映射实例是具有指定初始容量和指定负载系数的链接哈希映射。dummy是为了将此构造函数与其他int、float构造函数区分开来。 */
    HashSet(int initialCapacity, float loadFactor, boolean dummy) {
        map = new LinkedHashMap<>(initialCapacity, loadFactor);
    }

    /**返回此集合中元素的迭代器。元素不按特定顺序返回。 */
    public Iterator<E> iterator() {
        return map.keySet().iterator();
    }

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

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

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

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

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

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

    /**返回此HasSet实例的浅拷贝：元素本身未被克隆。 */
    @SuppressWarnings("unchecked")
    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(e);
        }
    }

    /**将此HashSet实例的状态保存到流中(即序列化它)。*/
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        
        s.defaultWriteObject();
        s.writeInt(map.capacity());
        s.writeFloat(map.loadFactor());
        s.writeInt(map.size());

        // 按照适当的顺序写出所有的元素。
        for (E e : map.keySet())
            s.writeObject(e);
    }

    /**反序列化实例 */
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        
        s.defaultReadObject();

        // 读取容量并验证非负值.
        int capacity = s.readInt();
        if (capacity < 0) {
            throw new InvalidObjectException("Illegal capacity: " + capacity);
        }

        // 读取负载因子并验证是否为正和非空。
        float loadFactor = s.readFloat();
        if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
            throw new InvalidObjectException("Illegal load factor: " +
                                             loadFactor);
        }

        // 读取大小并验证非负性。
        int size = s.readInt();
        if (size < 0) {
            throw new InvalidObjectException("Illegal size: " +
                                             size);
        }
        // 根据大小和负载系数设置容量，以确保
        // HashMap是至少25%的满，但不超过最大的容量。
        capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f), HashMap.MAXIMUM_CAPACITY);

		//在添加第一个元素时，构建备份映射将懒加载一个数组，因此在构建之前检查它。
		//调用HashMap.tableSizeFor来计算实际的分配大小。检查Map.Entry[].class，
		//因为它是最接近实际创建的公共类型。

        SharedSecrets.getJavaOISAccess()
                     .checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(capacity));

        // Create backing HashMap
        map = (((HashSet<?>)this) instanceof LinkedHashSet ?
               new LinkedHashMap<E,Object>(capacity, loadFactor) :
               new HashMap<E,Object>(capacity, loadFactor));

        // Read in all elements in the proper order.
        for (int i=0; i<size; i++) {
            @SuppressWarnings("unchecked")
                E e = (E) s.readObject();
            map.put(e, PRESENT);
        }
    }

    public Spliterator<E> spliterator() {
        return new HashMap.KeySpliterator<E,Object>(map, 0, -1, 0, 0);
    }
}