java.util
类 TreeSet<E>

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

所有已实现的接口：

Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>, SortedSet<E>

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, 序列化表格

构造方法摘要

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

TreeSet(Collection<? extends E> c)
构造一个新 set，包含指定 collection 中的元素，这个新 set 按照元素的自然顺序 排序。

TreeSet(Comparator<? super E> c)
构造一个新的空 set，该 set 根据指定的比较器进行排序。

TreeSet(SortedSet<E> s)
构造一个新 set，该 set 所包含的元素与指定的已排序 set 包含的元素相同，并按照相同的顺序对元素进行排序。

方法摘要

boolean	add(E o) 将指定的元素添加到 set（如果尚未存在于该 set 中）。
boolean	addAll(Collection<? extends E> c) 将指定 collection 中的所有元素添加到此 set 中。
void	clear() 移除 set 中的所有元素。
Object	clone() 返回 TreeSet 实例的浅表复制（并不克隆元素自身）。
Comparator<? super E>	comparator() 返回用于确定已排序 set 顺序的比较器，或者，如果此树 set 使用其元素的自然顺序，则返回 null。
boolean	contains(Object o) 如果 set 包含指定的元素，则返回 true。
E	first() 返回已排序 set 中当前的第一个（最小）元素。
SortedSet<E>	headSet(E toElement) 返回此 set 的部分视图，要求其元素严格小于 toElement。
boolean	isEmpty() 如果 set 不包含元素，则返回 true。
Iterator<E>	iterator() 返回对此 set 中的元素进行迭代的迭代器。
E	last() 返回已排序 set 中当前的最后一个（最大）元素。
boolean	remove(Object o) 将指定的元素从 set 中移除（如果该元素存在于此 set 中）。
int	size() 返回 set 中的元素个数（其容量）。
SortedSet<E>	subSet(E fromElement, E toElement) 返回此 set 的部分视图，其元素从 fromElement（包括）到 toElement（不包括）。
SortedSet<E>	tailSet(E fromElement) 返回 set 的部分视图，其元素大于或等于 fromElement。

从类 java.util.AbstractSet 继承的方法

equals, hashCode, removeAll

从类 java.util.AbstractCollection 继承的方法

containsAll, retainAll, toArray, toArray, toString

从类 java.lang.Object 继承的方法

finalize, getClass, notify, notifyAll, wait, wait, wait

从接口 java.util.Set 继承的方法

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

构造方法详细信息

TreeSet

public TreeSet()

构造一个新的空 set，该 set 按照元素的自然顺序排序。插入该 set 的所有元素都必须实现 Comparable 接口。而且，所有此类元素必须是可相互比较的：为 set 中的任何元素 e1 和 e2 执行 e1.compareTo(e2) 时必须不抛出 ClassCastException。如果用户尝试将违背此约束的元素添加到 set 中（例如，用户试图将字符串元素添加到其元素为整数的 set 中），则 add(Object) 调用将抛出 ClassCastException。

另请参见：

Comparable

TreeSet

public TreeSet(Comparator<? super E> c)

构造一个新的空 set，该 set 根据指定的比较器进行排序。所有插入到该 set 的元素都必须可由指定的比较器相互比较：为 set 中的任何元素 e1 和 e2 执行 comparator.compare(e1, e2) 时必须不抛出 ClassCastException。如果用户尝试将违背此约束的元素添加到 set 中，则 add(Object) 调用将抛出 ClassCastException。

参数：

c - 用于对此 set 进行排序的比较器。null 值表示应该使用元素的自然顺序。

TreeSet

public TreeSet(Collection<? extends E> c)

构造一个新 set，包含指定 collection 中的元素，这个新 set 按照元素的自然顺序 排序。插入该 set 的所有键都必须实现 Comparable 接口。而且，所有此类键必须是可相互比较的：针对 set 中的任何元素 k1 和 k2 执行 k1.compareTo(k2) 必须不抛出 ClassCastException。

参数：

c - 将组成新 set 的元素。

抛出：

ClassCastException - 如果指定 collection 中的键不可比较，或不可相互比较。

NullPointerException - 如果指定的 collection 为 null。

TreeSet

public TreeSet(SortedSet<E> s)

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

参数：

s - 已排序的 set，其元素将组成新的 set。

抛出：

NullPointerException - 如果指定的已排序 set 为 null。

方法详细信息

iterator

public Iterator<E> iterator()

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

指定者：

接口 Iterable<E> 中的 iterator

指定者：

接口 Collection<E> 中的 iterator

指定者：

接口 Set<E> 中的 iterator

指定者：

类 AbstractCollection<E> 中的 iterator

返回：

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

size

public int size()

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

指定者：

接口 Collection<E> 中的 size

指定者：

接口 Set<E> 中的 size

指定者：

类 AbstractCollection<E> 中的 size

返回：

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

isEmpty

public boolean isEmpty()

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

指定者：

接口 Collection<E> 中的 isEmpty

指定者：

接口 Set<E> 中的 isEmpty

覆盖：

类 AbstractCollection<E> 中的 isEmpty

返回：

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

contains

public boolean contains(Object o)

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

指定者：

接口 Collection<E> 中的 contains

指定者：

接口 Set<E> 中的 contains

覆盖：

类 AbstractCollection<E> 中的 contains

参数：

o - 要在 set 中检查是否包含的对象。

返回：

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

抛出：

ClassCastException - 如果指定的对象不能与 set 中的当前元素进行比较。

add

public boolean add(E o)

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

指定者：

接口 Collection<E> 中的 add

指定者：

接口 Set<E> 中的 add

覆盖：

类 AbstractCollection<E> 中的 add

参数：

o - 要添加到 set 中的元素。

返回：

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

抛出：

ClassCastException - 如果指定的对象不能与 set 中的当前元素进行比较。

remove

public boolean remove(Object o)

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

指定者：

接口 Collection<E> 中的 remove

指定者：

接口 Set<E> 中的 remove

覆盖：

类 AbstractCollection<E> 中的 remove

参数：

o - 要从 set 移除的对象（如果存在）。

返回：

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

抛出：

ClassCastException - 如果指定的对象不能与 set 中的当前元素进行比较。

clear

public void clear()

移除 set 中的所有元素。

指定者：

接口 Collection<E> 中的 clear

指定者：

接口 Set<E> 中的 clear

覆盖：

类 AbstractCollection<E> 中的 clear

addAll

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

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

指定者：

接口 Collection<E> 中的 addAll

指定者：

接口 Set<E> 中的 addAll

覆盖：

类 AbstractCollection<E> 中的 addAll

参数：

c - 要添加的元素。

返回：

如果此 set 随调用的结果发生改变，则返回 true。

抛出：

ClassCastException - 如果提供的元素不能与 set 中的当前元素进行比较。

NullPointerException - 如果指定的 collection 为 null。

另请参见：

AbstractCollection.add(Object)

subSet

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

返回此 set 的部分视图，其元素从 fromElement（包括）到 toElement（不包括）。（如果 fromElement 与 toElement 相等，则返回的已排序 set 为空。）返回的已排序 set 受此 set 支持，所以在返回的已排序 set 中的更改将在此 set 中得到反映，反之亦然。返回的已排序 set 支持所有可选 Set 操作。

如果用户试图插入指定范围之外的元素，那么由此方法返回的已排序 set 将抛出 IllegalArgumentException。

注意：此方法将始终返回一个半开区间（包括低端点，但不包括其高端点）。如果需要闭合区间（同时包括两个端点），并且元素类型允许计算指定值的后继值，则请求从 lowEndpoint 到 successor(highEndpoint) 的子范围即可。例如，假设 s 是一个已排序的字符串 set。下面的语句将获得一个视图，该视图包含 s 中从 low 到 high（包括）的所有字符串：

     SortedSet sub = s.subSet(low, high+"\0");
 

可以使用类似的技术生成开放区间（两个端点均不包括）。下面的语句将获得一个视图，该视图包含 s 中从 low 到 high（不包括）的所有字符串：

     SortedSet sub = s.subSet(low+"\0", high);
 

指定者：

接口 SortedSet<E> 中的 subSet

参数：

fromElement - subSet 的低端点（包括）。

toElement - subSet 的高端点（不包括）。

返回：

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

抛出：

ClassCastException - 如果 fromElement 和 toElement 不能使用此 set 的比较器（或者，如果 set 没有比较器，则使用自然顺序）进行相互比较。

IllegalArgumentException - 如果 fromElement 大于 toElement。

NullPointerException - 如果 fromElement 或 toElement 为 null，并且此 set 使用自然顺序，或者其比较器不允许使用 null 元素。

headSet

public SortedSet<E> headSet(E toElement)

返回此 set 的部分视图，要求其元素严格小于 toElement。返回的已排序 set 受此 set 支持，所以在返回的已排序 set 中的更改将反映在此 set 中，反之亦然。返回的已排序 set 支持所有可选 Set 操作。

如果用户试图插入大于或等于 toElement 的元素，那么由此方法返回的已排序 set 将抛出 IllegalArgumentException。

注，此方法将始终返回不包含其（高）端点的视图。如果需要包含此端点的视图，而元素类型允许计算指定值的后继值，则请求由 successor(highEndpoint) 指定范围的 headSet 即可。例如，假设 s 是一个已排序的字符串 set。下面的语句将获得一个视图，该视图包含 s 中小于或等于 high 的所有字符串：

 SortedSet head = s.headSet(high+"\0");

指定者：

接口 SortedSet<E> 中的 headSet

参数：

toElement - headSet 的高端点（不包括）。

返回：

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

抛出：

ClassCastException - 如果 toElement 与此 set 的比较器不兼容（或者，如果 set 不具有比较器，而 toElement 又未实现 Comparable）。

IllegalArgumentException - 如果 set 本身是 subSet、headSet 或 tailSet，而 toElement 又不在 subSet、headSet 或 tailSet 的指定范围内。

NullPointerException - 如果 toElement 为 null，并且此 set 使用自然顺序，或者其比较器不允许使用 null 元素。

tailSet

public SortedSet<E> tailSet(E fromElement)

返回 set 的部分视图，其元素大于或等于 fromElement。返回的已排序 set 受此 set 支持，所以在返回的已排序 set 中的更改将反映在此 set 中，反之亦然。返回的已排序 set 支持所有可选 Set 操作。

如果用户试图插入小于 fromElement 的元素，则由此方法返回的已排序 set 将抛出 IllegalArgumentException。 注意：此方法将始终返回包含其（低）端点的视图。如果需要不包含此端点的视图，而元素类型允许计算指定值的后继值，则请求由 successor(lowEndpoint) 指定范围的 tailSet 即可。例如，假设 s 是一个已排序的字符串 set。下面的语句将获得一个视图，该视图包含 s 中严格要求大于 low 的所有字符串：

     SortedSet tail = s.tailSet(low+"\0");
 

指定者：

接口 SortedSet<E> 中的 tailSet

参数：

fromElement - tailSet 的低端点（包括）。

返回：

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

抛出：

ClassCastException - 如果 fromElement 与此 set 的比较器不兼容（或者，如果 set 不具有比较器，而 fromElement 又未实现 Comparable）。

IllegalArgumentException - 如果 set 本身是 subSet、headSet 或 tailSet，而 fromElement 又不在 subSet、headSet 或 tailSet 的指定范围内。

NullPointerException - 如果 fromElement 为 null，并且此 set 使用自然顺序，或者其比较器不允许使用 null 元素。

comparator

public Comparator<? super E> comparator()

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

指定者：

接口 SortedSet<E> 中的 comparator

返回：

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

first

public E first()

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

指定者：

接口 SortedSet<E> 中的 first

返回：

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

抛出：

NoSuchElementException - 已排序 set 为空。

last

public E last()

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

指定者：

接口 SortedSet<E> 中的 last

返回：

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

抛出：

NoSuchElementException - 已排序 set 为空。

clone

public Object clone()

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

覆盖：

类 Object 中的 clone

返回：

set 的浅表复制。

另请参见：

Cloneable