Java集合源碼分析（六）TreeSet<E>，javatreeset

Java集合源碼分析（六）TreeSet<E>，javatreeset
TreeSet簡介

　　TreeSet 是一個有序的集合，它的作用是提供有序的Set集合。它繼承於AbstractSet抽象類別，實現了NavigableSet<E>, Cloneable, java.io.Serializable介面。
　　TreeSet 繼承於AbstractSet，所以它是一個Set集合，具有Set的屬性和方法。
　　TreeSet 實現了NavigableSet介面，意味著它支援一系列的導航方法。比如尋找與指定目標最匹配項。
　　TreeSet 實現了Cloneable介面，意味著它能被複製。
　　TreeSet 實現了java.io.Serializable介面，意味著它支援序列化。

　　TreeSet是基於TreeMap實現的。TreeSet中的元素支援2種排序方式：自然排序 或者 根據建立TreeSet 時提供的 Comparator 進行排序。這取決於使用的構造方法。
　　TreeSet為基本操作（add、remove 和 contains）提供受保證的 log(n) 時間開銷。
　　另外，TreeSet是非同步的。 它的iterator 方法返回的迭代器是fail-fast的。

TreeSet的建構函式

// 預設建構函式。使用該建構函式，TreeSet中的元素按照自然排序進行排列。TreeSet()// 建立的TreeSet包含collectionTreeSet(Collection<? extends E> collection)// 指定TreeSet的比較子TreeSet(Comparator<? super E> comparator)// 建立的TreeSet包含setTreeSet(SortedSet<E> set)

TreeSet的API

boolean                   add(E object)boolean                   addAll(Collection<? extends E> collection)void                      clear()Object                    clone()boolean                   contains(Object object)E                         first()boolean                   isEmpty()E                         last()E                         pollFirst()E                         pollLast()E                         lower(E e)E                         floor(E e)E                         ceiling(E e)E                         higher(E e)boolean                   remove(Object object)int                       size()Comparator<? super E>     comparator()Iterator<E>               iterator()Iterator<E>               descendingIterator()SortedSet<E>              headSet(E end)NavigableSet<E>           descendingSet()NavigableSet<E>           headSet(E end, boolean endInclusive)SortedSet<E>              subSet(E start, E end)NavigableSet<E>           subSet(E start, boolean startInclusive, E end, boolean endInclusive)NavigableSet<E>           tailSet(E start, boolean startInclusive)SortedSet<E>              tailSet(E start)

說明：

(01) TreeSet是有序的Set集合，因此支援add、remove、get等方法。
(02) 和NavigableSet一樣，TreeSet的導航方法大致可以區分為兩類，一類時提供元素項的導航方法，返回某個元素；另一類時提供集合的導航方法，返回某個集合。
lower、floor、ceiling 和 higher 分別返回小於、小於等於、大於等於、大於給定元素的元素，如果不存在這樣的元素，則返回 null。

TreeSet源碼分析

　　對於TreeSet而言，它是基於TreeMap實現的，TreeSet底層使用TreeMap來儲存所有元素，因此TreeSet的實現比較簡單，相關TreeSet的操作，基本上都是直接調用底層TreeMap的相關方法來完成，
　　TreeSet的原始碼如下：

 

/* * @(#)TreeSet.java1.37 06/05/10 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */package java.util;/** * @param <E> the type of elements maintained by this set * * @author  Josh Bloch * @version 1.37, 05/10/06 * @see    Collection * @see    Set * @see    HashSet * @see     Comparable * @see     Comparator * @see    TreeMap * @since   1.2 */public class TreeSet<E> extends AbstractSet<E>    implements NavigableSet<E>, Cloneable, java.io.Serializable{    /**     * NavigableMap對象     */    private transient NavigableMap<E,Object> m;    // TreeSet是通過TreeMap實現的，    // PRESENT是鍵-值對中的值。    private static final Object PRESENT = new Object();    /**     * 將TreeMap賦值給 "NavigableMap對象m"     */    TreeSet(NavigableMap<E,Object> m) {        this.m = m;    }    /**     * 不帶參數的建構函式。建立一個空的TreeMap     */    public TreeSet() {this(new TreeMap<E,Object>());    }    /**     * 帶比較子的建構函式。     */    public TreeSet(Comparator<? super E> comparator) {this(new TreeMap<E,Object>(comparator));    }    /**     * 建立TreeSet，並將集合c中的全部元素都添加到TreeSet中     */    public TreeSet(Collection<? extends E> c) {        this();        addAll(c);    }    /**     * 建立TreeSet，並將s中的全部元素都添加到TreeSet中     */    public TreeSet(SortedSet<E> s) {        this(s.comparator());addAll(s);    }    /**     * 返回TreeSet的順序排列的迭代器。     * 因為TreeSet是TreeMap實現的，所以這裡實際上時返回TreeMap的“鍵集”對應的迭代器     */    public Iterator<E> iterator() {        return m.navigableKeySet().iterator();    }    /**     * 返回TreeSet的逆序排列的迭代器。     * 因為TreeSet是TreeMap實現的，所以這裡實際上時返回TreeMap的“鍵集”對應的迭代器     */    public Iterator<E> descendingIterator() {return m.descendingKeySet().iterator();    }    /**     * 返回NavigableSet<E>類型的TreeSet     */    public NavigableSet<E> descendingSet() {return new TreeSet(m.descendingMap());    }    /**     * 返回大小     */    public int size() {return m.size();    }    /**     * 是否為空白     */    public boolean isEmpty() {return m.isEmpty();    }    /**     * 是否包含o     */    public boolean contains(Object o) {return m.containsKey(o);    }    /**     * 添加元素e     */    public boolean add(E e) {return m.put(e, PRESENT)==null;    }    /**     * 刪除元素o     */    public boolean remove(Object o) {return m.remove(o)==PRESENT;    }    /**     * 清空集合     */    public void clear() {m.clear();    }    /**     * 將集合c中的全部元素添加到TreeSet中     */    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);    }    /**     * 返回子Set，實際上是通過TreeMap的subMap()實現的。     */    public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,                                  E toElement,   boolean toInclusive) {return new TreeSet<E>(m.subMap(fromElement, fromInclusive,                                       toElement,   toInclusive));    }    /**     * 返回Set的頭部，範圍是：從頭部到toElement。     * inclusive是是否包含toElement的標誌     */    public NavigableSet<E> headSet(E toElement, boolean inclusive) {return new TreeSet<E>(m.headMap(toElement, inclusive));    }    /**     * 返回Set的尾部，範圍是：從fromElement到結尾。     * inclusive是是否包含fromElement的標誌     */    public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {return new TreeSet<E>(m.tailMap(fromElement, inclusive));    }    /**     * 返回子Set。範圍是：從fromElement(包括)到toElement(不包括)。     */    public SortedSet<E> subSet(E fromElement, E toElement) {return subSet(fromElement, true, toElement, false);    }    /**     * 返回Set的頭部，範圍是：從頭部到toElement(不包括)。     */    public SortedSet<E> headSet(E toElement) {return headSet(toElement, false);    }    /**     * 返回Set的尾部，範圍是：從fromElement到結尾(不包括)。     */    public SortedSet<E> tailSet(E fromElement) {return tailSet(fromElement, true);    }        // 返回Set的比較子    public Comparator<? super E> comparator() {        return m.comparator();    }    /**     * 返回Set的第一個元素     */    public E first() {        return m.firstKey();    }    /**     * 返回Set的最後一個元素     */    public E last() {        return m.lastKey();    }    // NavigableSet API methods    /**     * 返回Set中小於e的最大元素     */    public E lower(E e) {        return m.lowerKey(e);    }    /**     * 返回Set中小於/等於e的最大元素     */    public E floor(E e) {        return m.floorKey(e);    }    /**     * 返回Set中大於/等於e的最小元素     */    public E ceiling(E e) {        return m.ceilingKey(e);    }    /**     * 返回Set中大於e的最小元素     */    public E higher(E e) {        return m.higherKey(e);    }    /**     * 擷取第一個元素，並將該元素從TreeMap中刪除。     */    public E pollFirst() {        Map.Entry<E,?> e = m.pollFirstEntry();        return (e == null)? null : e.getKey();    }    /**     * 擷取最後一個元素，並將該元素從TreeMap中刪除。     */    public E pollLast() {        Map.Entry<E,?> e = m.pollLastEntry();        return (e == null)? null : e.getKey();    }    /**     * 複製一個TreeSet，並返回Object對象     */    public Object clone() {        TreeSet<E> clone = null;try {    clone = (TreeSet<E>) super.clone();} catch (CloneNotSupportedException e) {    throw new InternalError();}        clone.m = new TreeMap<E,Object>(m);        return clone;    }    /**     * java.io.Serializable的寫入函數     *      * 將TreeSet的“比較子、容量，所有的元素值”都寫入到輸出資料流中     */    private void writeObject(java.io.ObjectOutputStream s)        throws java.io.IOException {// Write out any hidden stuffs.defaultWriteObject();        // 寫入比較子        s.writeObject(m.comparator());        // 寫入容量        s.writeInt(m.size());// 寫入“TreeSet中的每一個元素”for (Iterator i=m.keySet().iterator(); i.hasNext(); )            s.writeObject(i.next());    }    /**     * java.io.Serializable的讀取函數：根據寫入方式讀出     * 先將TreeSet的“比較子、容量、所有的元素值”依次讀出     */    private void readObject(java.io.ObjectInputStream s)        throws java.io.IOException, ClassNotFoundException {// Read in any hidden stuffs.defaultReadObject();        // 從輸入資料流中讀取TreeSet的“比較子”        Comparator<? super E> c = (Comparator<? super E>) s.readObject();        // Create backing TreeMapTreeMap<E,Object> tm;if (c==null)    tm = new TreeMap<E,Object>();else    tm = new TreeMap<E,Object>(c);m = tm;        // 從輸入資料流中讀取TreeSet的“容量”        int size = s.readInt();        // 從輸入資料流中讀取TreeSet的“全部元素”        tm.readTreeSet(size, s, PRESENT);    }    // TreeSet的序列版本號碼    private static final long serialVersionUID = -2479143000061671589L;}

 

總結:

(01) TreeSet實際上是TreeMap實現的。當我們構造TreeSet時；若使用不帶參數的建構函式，則TreeSet的使用自然比較子；若使用者需要使用自訂的比較子，則需要使用帶比較子的參數。
(02) TreeSet是非安全執行緒的。
(03) TreeSet實現java.io.Serializable的方式。當寫入到輸出資料流時，依次寫入“比較子、容量、全部元素”；當讀出輸入資料流時，再依次讀取。