Java集合-TreeSet（一）

TreeSet集合源码解析

源码

package java.util;

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    /**
     * 支持map
     */
    private transient NavigableMap<E,Object> m;

    // 与后台映射中的对象关联的虚拟值。
    private static final Object PRESENT = new Object();

    /**
     * 构建由指定map支持的集合。
     */
    TreeSet(NavigableMap<E,Object> m) {
        this.m = m;
    }

    /**
     * 构造一个新的空树集，根据其元素的自然排序进行排序。插入到集合中的所有元素都必须实现可比较的接口。
     */
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }

    /**
     *构造一个新的空树集，按指定的比较器进行排序。所有的元素插入到设置必须由指定的比较器可相互比较
     */
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }

    /**
     * 构造一个包含指定集合中元素的新树集，根据其元素的自然顺序进行排序。插入到集合中的所有元素都必须实现可比较的接口。
     */
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }

    /**
     *构造一个包含相同元素的新树集，并使用与指定排序集相同的顺序。
     */
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }

    /**
     * 以递增顺序返回集合中元素的迭代器。
     */
    public Iterator<E> iterator() {
        return m.navigableKeySet().iterator();
    }

    /**
     * 以递减顺序返回集合中元素的迭代器。
     */
    public Iterator<E> descendingIterator() {
        return m.descendingKeySet().iterator();
    }

    /**
     * 递减顺序的tree集合
     */
    public NavigableSet<E> descendingSet() {
        return new TreeSet<>(m.descendingMap());
    }

    /**
     * set大小
     */
    public int size() {
        return m.size();
    }

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

    /**
     * 如果该集合包含指定元素，则返回true。
     */
    public boolean contains(Object o) {
        return m.containsKey(o);
    }

    /**
     * 如果尚未存在，则将指定元素添加到该集合中。
     */
    public boolean add(E e) {
        return m.put(e, PRESENT)==null;
    }

    /**
     * 如果该集合存在，则从该集合中移除指定元素。
     */
    public boolean remove(Object o) {
        return m.remove(o)==PRESENT;
    }

    /**
     * 从该集合中移除所有元素。本集将此调用后返回的是空的。
     */
    public void clear() {
        m.clear();
    }

    /**
     *将指定集合中的所有元素添加到该集合中。
     */
    public  boolean addAll(Collection<? extends E> c) {
        // Use linear-time version if applicable
        if (m.size()==0 && c.size() > 0 &&
            c instanceof SortedSet &&
            m instanceof TreeMap) {
            SortedSet<? extends E> set = (SortedSet<? extends E>) c;
            TreeMap<E,Object> map = (TreeMap<E, Object>) m;
            Comparator<? super E> cc = (Comparator<? super E>) set.comparator();
            Comparator<? super E> mc = map.comparator();
            if (cc==mc || (cc != null && cc.equals(mc))) {
                map.addAllForTreeSet(set, PRESENT);
                return true;
            }
        }
        return super.addAll(c);
    }

    /**
     * 返回从这个集合的元素范围从fromelement到toelement部分。
     * 如果fromelement和toelement相等，返回的集合是空的，除非frominclusive toinclusive都是true的。
     */
    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
                                  E toElement,   boolean toInclusive) {
        return new TreeSet<>(m.subMap(fromElement, fromInclusive,
                                       toElement,   toInclusive));
    }

    /**
     * 返回从这个集合的元素都小于等于toelement。
     */
    public NavigableSet<E> headSet(E toElement, boolean inclusive) {
        return new TreeSet<>(m.headMap(toElement, inclusive));
    }

    /**
     *返回从这个集合的元素大于等于 fromelement
     */
    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
        return new TreeSet<>(m.tailMap(fromElement, inclusive));
    }

    /**
     * 返回从这个集合的元素范围从fromelement，包容的部分toelement，
     * 如果fromelement和toelement相等，返回的集合是空的。
     */
    public SortedSet<E> subSet(E fromElement, E toElement) {
        return subSet(fromElement, true, toElement, false);
    }

    /**
     * 返回从这个集合的元素是严格小于toelement部分。
     */
    public SortedSet<E> headSet(E toElement) {
        return headSet(toElement, false);
    }

    /**
     * 返回从这个集合的元素都大于或等于fromelement部分。
     */
    public SortedSet<E> tailSet(E fromElement) {
        return tailSet(fromElement, true);
    }

    public Comparator<? super E> comparator() {
        return m.comparator();
    }

    public E first() {
        return m.firstKey();
    }

    public E last() {
        return m.lastKey();
    }

    // NavigableSet API methods

    /**
     * 返回该集合中的最大元素，小于给定元素，如果没有元素，则返回null。
     */
    public E lower(E e) {
        return m.lowerKey(e);
    }

    /**
     * 返回该集合中小于或等于给定元素的最大元素，如果没有这样的元素，则返回null。
     */
    public E floor(E e) {
        return m.floorKey(e);
    }

    /**
     * 返回大于或等于给定键的最小键，如果没有这样的键，则返回null。
     */
    public E ceiling(E e) {
        return m.ceilingKey(e);
    }

    /**
     * 返回该集合中的最小元素，比给定元素严格，如果没有这样的元素，则返回null。
     */
    public E higher(E e) {
        return m.higherKey(e);
    }

    /**
     * 检索并删除第一个（最小）元素，如果该集合为空，则返回null。
     */
    public E pollFirst() {
        Map.Entry<E,?> e = m.pollFirstEntry();
        return (e == null) ? null : e.getKey();
    }

    /**
     * 检索并删除最后一个（最大）元素，如果该集合为空，则返回null。
     */
    public E pollLast() {
        Map.Entry<E,?> e = m.pollLastEntry();
        return (e == null) ? null : e.getKey();
    }

    public Object clone() {
        TreeSet<E> clone = null;
        try {
            clone = (TreeSet<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }

        clone.m = new TreeMap<>(m);
        return clone;
    }

    /**
     *序列化
     */
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        // Write out any hidden stuff
        s.defaultWriteObject();

        // Write out Comparator
        s.writeObject(m.comparator());

        // Write out size
        s.writeInt(m.size());

        // Write out all elements in the proper order.
        for (E e : m.keySet())
            s.writeObject(e);
    }

    /**
     * 反序列化
     */
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden stuff
        s.defaultReadObject();

        // Read in Comparator
        Comparator<? super E> c = (Comparator<? super E>) s.readObject();

        // Create backing TreeMap
        TreeMap<E,Object> tm;
        if (c==null)
            tm = new TreeMap<>();
        else
            tm = new TreeMap<>(c);
        m = tm;

        // Read in size
        int size = s.readInt();

        tm.readTreeSet(size, s, PRESENT);
    }

    private static final long serialVersionUID = -2479143000061671589L;
}

TreeSet的底层实现是TreeMap，取出其Key作为唯一的set集合，