文章目录
1. 概述
- 由于 SortedSet 接口能对元素升序排序（也叫自然排序），TreeSet 类也会对实现了Comparable接口 的类的对象自动排序，或者根据创建 TreeSet 时提供的 Comparator 进行排序；
- 底层依赖于 TreeMap，元素没有索引；
- 通过红黑树实现，不允许放入null值；
- 存储大量的需要进行快速检索的排序信息时，TreeSet 是一个很好的选择；
2. 类图
TreeSet 实现的接口、继承的类，如下图所示：
- 实现 NavigableSet接口，并继承 AbstractSet 抽像类。
- 实现序列化接口接口。
- 实现克隆接口。
3. 属性
TreeSet 只有一个属性，那就是 NavigableMap 。代码如下：
private transient NavigableMap<E,Object> m;
-
m的 key ，存储 HashSet 的每个 key 。 -
map的 value ，因为 TreeSet 没有 value 的需要，所以使用一个统一的PRESENT即可。代码如下：private static final Object PRESENT = new Object();
4. 构造方法
TreeSet 一共有 5 个构造方法，其实底层的实现借助于TreeMap中的API来做，代码如下：
TreeSet(NavigableMap<E,Object> m) {
this.m = m;
}
public TreeSet() {
this(new TreeMap<>());
}
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);
}
- 在构造方法中，会创建 TreeMap 对象，赋予到 NavigableMap 属性。
5. 添加单个元素
#add(E e) 方法，添加单个元素。代码如下：
public boolean add(E e) {
return m.put(e, PRESENT)==null;
}
m的 value 值，就是我们看到的PRESENT。
#addAll(Collection<? extends E> c) 方法，批量添加。代码如下：
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;
if (Objects.equals(set.comparator(), map.comparator())) {
map.addAllForTreeSet(set, PRESENT);
return true;
}
}
// 情况二
return super.addAll(c);
}
- 在实现上，和 TreeMap 的批量添加是一样的，对于情况一，会进行优化。
6. 移除单个元素
#remove(Object o) 方法，移除 o 对应的 value ，并返回是否成功。代码如下：
public boolean remove(Object o) {
return m.remove(o)==PRESENT;
}
7. 查找单个元素
#contains(Object key) 方法，判断 key 是否存在。代码如下：
public boolean contains(Object o) {
return m.containsKey(o);
}
8. 查找接近的元素
在 NavigableSet 中，定义了四个查找接近的元素：
#lower(E e)方法，小于e的 key#floor(E e)方法，小于等于e的 key#higher(E e)方法，大于e的 key#ceiling(E e)方法，大于等于e的 key
public E lower(E e) {
return m.lowerKey(e);
}
public E floor(E e) {
return m.floorKey(e);
}
public E ceiling(E e) {
return m.ceilingKey(e);
}
public E higher(E e) {
return m.higherKey(e);
}
9. 获得首尾的元素
#first() 方法，获得首个 key 。代码如下：
public E first() {
return m.firstKey();
}
-
#pollFirst()方法，获得并移除首个 key 。代码如下：// TreeSet.java public E pollFirst() { Map.Entry<E,?> e = m.pollFirstEntry(); return (e == null) ? null : e.getKey(); }
#last() 方法，获得尾部 key 。代码如下：
public E last() {
return m.lastKey();
}
-
#pollLast()方法，获得并移除尾部 key 。代码如下：public E pollLast() { Map.Entry<E,?> e = m.pollLastEntry(); return (e == null) ? null : e.getKey(); }
10. 清空
#clear() 方法，清空。代码如下：
public void clear() {
m.clear();
}
11. 克隆
#clone() 方法，克隆 TreeSet 。代码如下：
// TreeSet.java
public Object clone() {
// 克隆创建 TreeSet 对象
TreeSet<E> clone;
try {
clone = (TreeSet<E>) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
// 创建 TreeMap 对象，赋值给 clone 的 m 属性
clone.m = new TreeMap<>(m);
return clone;
}
12. 获得迭代器
public Iterator<E> iterator() { // 正序 Iterator 迭代器
return m.navigableKeySet().iterator();
}
public Iterator<E> descendingIterator() { // 倒序 Iterator 迭代器
return m.descendingKeySet().iterator();
}
13. 转换成 Set/Collection
public NavigableSet<E> descendingSet() {
return new TreeSet<>(m.descendingMap());
}
14. 查找范围的元素
// TreeSet.java
// subSet 组
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
E toElement, boolean toInclusive) {
return new TreeSet<>(m.subMap(fromElement, fromInclusive,
toElement, toInclusive));
}
public SortedSet<E> subSet(E fromElement, E toElement) {
return subSet(fromElement, true, toElement, false);
}
// headSet 组
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
return new TreeSet<>(m.headMap(toElement, inclusive));
}
public SortedSet<E> headSet(E toElement) {
return headSet(toElement, false);
}
// tailSet 组
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
return new TreeSet<>(m.tailMap(fromElement, inclusive));
}
public SortedSet<E> tailSet(E fromElement) {
return tailSet(fromElement, true);
}