Java-API简析_java.util.TreeSet＜E＞类（基于 Latest JDK）（浅析源码）

【版权声明】未经博主同意，谢绝转载！（请尊重原创，博主保留追究权）
https://blog.csdn.net/m0_69908381/article/details/131442558
出自【进步*于辰的博客】

1、概述

继承关系：

• java.lang.Object
  • java.util.AbstractCollection<E>
    • java.util.AbstractSet<E>
      • java.util.TreeSet<E>

所有已实现的接口：
Serializable, Cloneable, Iterable, Collection, Set, SortedSet

---

public class TreeSet<E> extends AbstractSet<E> implements SortedSet<E>, Cloneable, Serializable

此类实现 Set 接口，该接口由 TreeMap 实例支持。此类保证排序后的 set 按照升序排列元素，根据使用的构造方法不同，可能会按照元素的自然顺序 进行排序（参见 Comparable），或按照在创建 set 时所提供的比较器进行排序。

此实现为基本操作（add、remove 和 contains）提供了可保证的 log(n) 时间开销。

注意，如果要正确实现 Set 接口，则 set 所维护的顺序（是否提供了显式比较器）必须为 与等号一致（请参阅 与等号一致 精确定义的 Comparable 或 Comparator）。这是因为 Set 接口根据 equals() 操作进行定义，但 TreeSet 实例将使用其 compareTo()（或 compare()）执行所有的键比较，因此，从 set 的角度出发，该方法认为相等的两个键就是相等的。即使 set 的顺序与等号不一致，其行为也是 定义良好的；它只是违背了 Set 接口的常规协定。

注意，此实现不是同步的。如果多个线程同时访问一个 set，而其中至少一个线程修改了该 set，那么它必须保持外部同步。通常通过对某个自然封装该 set 的对象进行同步来实现此操作。如果不存在此类对象，则 set 就应该使用 Collections.synchronizedSet() 进行“包装”。此操作最好在创建时进行，以防止对 set 的意外非同步访问：

SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...));

此类的 iterator() 返回的迭代器是快速失败的：如果在迭代器创建后的任意时间修改 set（通过迭代器本身 remove() 方法之外的任何其他方式），迭代器将抛出 ConcurrentModificationException。因此，在并发修改时，迭代器将快速而彻底地失败，而不会在以后的不确定时间有出现任意、无法确定行为的危险。

注意，无法保证迭代器的快速失败行为，因为通常来说，不可能在非同步并发修改的情况下提供任何硬性保证。快速失败的迭代器将尽量抛出 ConcurrentModificationException。因此，为了获得其准确性而编写依赖此异常的程序的做法是错误的：迭代器的快速失败行为应当仅用于检测 bug。

此类是 Java Collections Framework 的成员。

从以下版本开始：
1.2
另请参见：
Collection, Set, HashSet, Comparable, Comparator, Collections.synchronizedSortedSet(SortedSet), TreeMap, 序列化表格

2、构造方法摘要

2.1 null

构造一个新的空 set，该 set 按照元素的自然顺序排序。

2.2 Collection<? extends E> c)

构造一个新 set，包含指定 collection 中的元素，这个新 set 按照元素的自然顺序 排序。

2.3 Comparator<? super E> c)

构造一个新的空 set，该 set 根据指定的比较器进行排序。

2.4 SortedSet<E> s)

构造一个新 set，该 set 所包含的元素与指定的已排序 set 包含的元素相同，并按照相同的顺序对元素进行排序。

3、方法摘要

3.1 boolean add(E o)

将指定的元素添加到 set（如果尚未存在于该 set 中）。

3.2 boolean addAll(Collection<? extends E> c)

将指定 collection 中的所有元素添加到此 set 中。

3.3 void clear()

移除 set 中的所有元素。

3.4 Object clone()

返回 TreeSet 实例的浅表复制（并不克隆元素自身）。

3.5 Comparator<? super E> comparator()

返回用于确定已排序 set 顺序的比较器，或者，如果此树 set 使用其元素的自然顺序，则返回 null。

3.6 boolean contains(Object o)

如果 set 包含指定的元素，则返回 true。

3.7 E first()

返回已排序 set 中当前的第一个（最小）元素。

3.8 SortedSet<E> headSet(E toElement)

返回此 set 的部分视图，要求其元素严格小于 toElement。

3.9 boolean isEmpty()

如果 set 不包含元素，则返回 true。

3.10 Iterator<E> iterator()

返回对此 set 中的元素进行迭代的迭代器。

3.11 E last()

返回已排序 set 中当前的最后一个（最大）元素。

3.12 boolean remove(Object o)

将指定的元素从 set 中移除（如果该元素存在于此 set 中）。

3.13 int size()

返回 set 中的元素个数（其容量）。

3.14 SortedSet<E> subSet(E fromElement, E toElement)

返回此 set 的部分视图，其元素从 fromElement（包括）到 toElement（不包括）。

3.15 SortedSet<E> tailSet(E fromElement)

返回 set 的部分视图，其元素大于或等于 fromElement。

最后

如果大家需要Java-API文档，我上传了《Java-API文档-包含5/8/11三个版本》。

---

本文暂缓更新。