Java提高十七：TreeSet 深入分析

private transient NavigableMap<E,Object> m;

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  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);
}

TreeMap

NavigableSet

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的方法：

boolean

add(E e)

boolean

addAll(Collection<? extends E> c)

E

ceiling(E e)

null

void

clear()

Object

clone()

TreeSet

Comparator<? super E>

comparator()

boolean

contains(Object o)

true

Iterator<E>

descendingIterator()

NavigableSet<E>

descendingSet()

E

first()

E

floor(E e)

null

SortedSet<E>

headSet(E toElement)

NavigableSet<E>

headSet(E toElement, boolean inclusive)

inclusive

toElement

E

higher(E e)

null

boolean

isEmpty()

true

Iterator<E>

iterator()

E

last()

E

lower(E e)

null

E

pollFirst()

null

E

pollLast()

null

boolean

remove(Object o)

int

size()

NavigableSet<E>

subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)

fromElement

toElement

SortedSet<E>

subSet(E fromElement, E toElement)

SortedSet<E>

tailSet(E fromElement)

NavigableSet<E>

tailSet(E fromElement, boolean inclusive)

inclusive

fromElement

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

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);
}

public E ceiling(E e) {
return m.ceilingKey(e);
}

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

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;
}

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

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

public Iterator<E> descendingIterator() {
return m.descendingKeySet().iterator();
}

public NavigableSet<E> descendingSet() {
return new TreeSet<>(m.descendingMap());
}

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

for(Iterator iter = set.iterator(); iter.hasNext(); ) {
iter.next();
}

// 假设set是TreeSet对象
for(Iterator iter = set.descendingIterator(); iter.hasNext(); ) {
iter.next();
}

// 假设set是TreeSet对象，并且set中元素是String类型
String[] arr = (String[])set.toArray(new String[0]);
for (String str:arr)
System.out.printf("for each : %s\n", str);

import java.util.*;

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

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;
}