目錄
第1部分 TreeSet介紹
TreeSet簡介
TreeSet 是一個有序的集合，它的作用是提供有序的Set集合。它繼承於AbstractSet抽象類，實現了NavigableSet, 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包含collection
TreeSet(Collection<? extends E> collection)
// 指定TreeSet的比較器
TreeSet(Comparator<? super E> comparator)
// 創建的TreeSet包含set
TreeSet(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)
說明：
- TreeSet是有序的Set集合，因此支持add、remove、get等方法。
- 和NavigableSet一樣，TreeSet的導航方法大致可以區分為兩類，一類是提供元素項的導航方法，返回某個元素；另一類是提供集合的導航方法，返回某個集合。
lower、floor、ceiling 和 higher
分別返回小於、小於等於、大於等於、大於給定元素的元素，如果不存在這樣的元素，則返回 null。
第2部分 TreeSet數據結構
TreeSet的繼承關系
java.lang.Object
↳ java.util.AbstractCollection<E>
↳ java.util.AbstractSet<E>
↳ java.util.TreeSet<E>
public class TreeSet<E> extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, java.io.Serializable{}
TreeSet與Collection關系如下圖：
從圖中可以看出：
(01) TreeSet繼承於AbstractSet，並且實現了NavigableSet接口。
(02) TreeSet的本質是一個"有序的，並且沒有重復元素"的集合，它是通過TreeMap實現的。TreeSet中含有一個"NavigableMap類型的成員變量"m，而m實際上是"TreeMap的實例"。
第3部分 TreeSet源碼解析(基於JDK1.6.0_45)
為了更了解TreeSet的原理，下面對TreeSet源碼代碼作出分析。
package java.util;
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
public TreeSet() {
this(new TreeMap<E,Object>());
}
// 將TreeMap賦值給 "NavigableMap對象m"
TreeSet(NavigableMap<E,Object> m) {
this.m = m;
}
// 帶比較器的構造函數。
public TreeSet(Comparator<? super E> comparator) {
this(new TreeMap<E,Object>(comparator));
}
// 創建TreeSet，並將集合c中的全部元素都添加到TreeSet中
public TreeSet(Collection<? extends E> c) {
this();
// 將集合c中的元素全部添加到TreeSet中
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();
}
// 返回TreeSet的大小
public int size() {
return m.size();
}
// 返回TreeSet是否為空
public boolean isEmpty() {
return m.isEmpty();
}
// 返回TreeSet是否包含對象(o)
public boolean contains(Object o) {
return m.containsKey(o);
}
// 添加e到TreeSet中
public boolean add(E e) {
return m.put(e, PRESENT)==null;
}
// 刪除TreeSet中的對象o
public boolean remove(Object o) {
return m.remove(o)==PRESENT;
}
// 清空TreeSet
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 first() {
public E last() {
return m.lastKey();
}
// 返回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 {
s.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 stuff
s.defaultReadObject();
// 從輸入流中讀取TreeSet的“比較器”
Comparator<? super E> c = (Comparator<? super E>) s.readObject();
TreeMap<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的方式。當寫入到輸出流時，依次寫入“比較器、容量、全部元素”；當讀出輸入流時，再依次讀取。
第4部分 TreeSet遍歷方式
4.1 Iterator順序遍歷
for(Iterator iter = set.iterator(); iter.hasNext(); ) {
iter.next();
}
4.2 Iterator逆序遍歷
// 假設set是TreeSet對象
for(Iterator iter = set.descendingIterator(); iter.hasNext(); ) {
iter.next();
}
4.3 for-each遍歷HashSet
// 假設set是TreeSet對象，並且set中元素是String類型
String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : %s\n", str);
TreeSet不支持快速隨機遍歷，只能通過迭代器進行遍歷！
import java.util.*;
/** * @desc TreeSet的遍歷程序 * * @author skywang * @email kuiwu-wang@163.com */
public class TreeSetIteratorTest {
public static void main(String[] args) {
TreeSet set = new TreeSet();
set.add("aaa");
set.add("aaa");
set.add("bbb");
set.add("eee");
set.add("ddd");
set.add("ccc");
// 順序遍歷TreeSet
ascIteratorThroughIterator(set) ;
// 逆序遍歷TreeSet
descIteratorThroughIterator(set);
// 通過for-each遍歷TreeSet。不推薦！此方法需要先將Set轉換為數組
foreachTreeSet(set);
}
// 順序遍歷TreeSet
public static void ascIteratorThroughIterator(TreeSet set) {
System.out.print("\n ---- Ascend Iterator ----\n");
for(Iterator iter = set.iterator(); iter.hasNext(); ) {
System.out.printf("asc : %s\n", iter.next());
}
}
// 逆序遍歷TreeSet
public static void descIteratorThroughIterator(TreeSet set) {
System.out.printf("\n ---- Descend Iterator ----\n");
for(Iterator iter = set.descendingIterator(); iter.hasNext(); )
System.out.printf("desc : %s\n", (String)iter.next());
}
// 通過for-each遍歷TreeSet。不推薦！此方法需要先將Set轉換為數組
private static void foreachTreeSet(TreeSet set) {
System.out.printf("\n ---- For-each ----\n");
String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : %s\n", str);
}
}
運行結果：
---- Ascend Iterator ----
asc : aaa
asc : bbb
asc : ccc
asc : ddd
asc : eee
---- Descend Iterator ----
desc : eee
desc : ddd
desc : ccc
desc : bbb
desc : aaa
---- For-each ----
for each : aaa
for each : bbb
for each : ccc
for each : ddd
for each : eee
第5部分 TreeSet示例
下面通過實例學習如何使用TreeSet
import java.util.*;
/** * @desc TreeSet的API測試 * * @author skywang * @email kuiwu-wang@163.com */
public class TreeSetTest {
public static void main(String[] args) {
testTreeSetAPIs();
}
// 測試TreeSet的api
public static void testTreeSetAPIs() {
String val;
// 新建TreeSet
TreeSet tSet = new TreeSet();
// 將元素添加到TreeSet中
tSet.add("aaa");
// Set中不允許重復元素，所以只會保存一個“aaa”
tSet.add("aaa");
tSet.add("bbb");
tSet.add("eee");
tSet.add("ddd");
tSet.add("ccc");
System.out.println("TreeSet:"+tSet);
// 打印TreeSet的實際大小
System.out.printf("size : %d\n", tSet.size());
// 導航方法
// floor(小於、等於)
System.out.printf("floor bbb: %s\n", tSet.floor("bbb"));
// lower(小於)
System.out.printf("lower bbb: %s\n", tSet.lower("bbb"));
// ceiling(大於、等於)
System.out.printf("ceiling bbb: %s\n", tSet.ceiling("bbb"));
System.out.printf("ceiling eee: %s\n", tSet.ceiling("eee"));
// ceiling(大於)
System.out.printf("higher bbb: %s\n", tSet.higher("bbb"));
// subSet()
System.out.printf("subSet(aaa, true, ccc, true): %s\n", tSet.subSet("aaa", true, "ccc", true));
System.out.printf("subSet(aaa, true, ccc, false): %s\n", tSet.subSet("aaa", true, "ccc", false));
System.out.printf("subSet(aaa, false, ccc, true): %s\n", tSet.subSet("aaa", false, "ccc", true));
System.out.printf("subSet(aaa, false, ccc, false): %s\n", tSet.subSet("aaa", false, "ccc", false));
// headSet()
System.out.printf("headSet(ccc, true): %s\n", tSet.headSet("ccc", true));
System.out.printf("headSet(ccc, false): %s\n", tSet.headSet("ccc", false));
// tailSet()
System.out.printf("tailSet(ccc, true): %s\n", tSet.tailSet("ccc", true));
System.out.printf("tailSet(ccc, false): %s\n", tSet.tailSet("ccc", false));
// 刪除“ccc”
tSet.remove("ccc");
// 將Set轉換為數組
String[] arr = (String[])tSet.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : %s\n", str);
// 打印TreeSet
System.out.printf("TreeSet:%s\n", tSet);
// 遍歷TreeSet
for(Iterator iter = tSet.iterator(); iter.hasNext(); ) {
System.out.printf("iter : %s\n", iter.next());
}
// 刪除並返回第一個元素
val = (String)tSet.pollFirst();
System.out.printf("pollFirst=%s, set=%s\n", val, tSet);
// 刪除並返回最后一個元素
val = (String)tSet.pollLast();
System.out.printf("pollLast=%s, set=%s\n", val, tSet);
// 清空HashSet
tSet.clear();
// 輸出HashSet是否為空
System.out.printf("%s\n", tSet.isEmpty()?"set is empty":"set is not empty");
}
}
運行結果：
TreeSet:[aaa, bbb, ccc, ddd, eee]
size : 5
floor bbb: bbb
lower bbb: aaa
ceiling bbb: bbb
ceiling eee: eee
higher bbb: ccc
subSet(aaa, true, ccc, true): [aaa, bbb, ccc]
subSet(aaa, true, ccc, false): [aaa, bbb]
subSet(aaa, false, ccc, true): [bbb, ccc]
subSet(aaa, false, ccc, false): [bbb]
headSet(ccc, true): [aaa, bbb, ccc]
headSet(ccc, false): [aaa, bbb]
tailSet(ccc, true): [ccc, ddd, eee]
tailSet(ccc, false): [ddd, eee]
for each : aaa
for each : bbb
for each : ddd
for each : eee
TreeSet:[aaa, bbb, ddd, eee]
iter : aaa
iter : bbb
iter : ddd
iter : eee
pollFirst=aaa, set=[bbb, ddd, eee]
pollLast=eee, set=[bbb, ddd]
set is empty