©
本文档使用
php.cn手册 发布
|
JavaTM 2 Platform Standard Ed. 6 |
|||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
java.lang.Object java.util.AbstractCollection<E> java.util.AbstractSet<E> java.util.TreeSet<E>
E
- 此 set 维护的元素的类型public class TreeSet<E>
基于 TreeMap
的 NavigableSet
实现。使用元素的自然顺序对元素进行排序,或者根据创建 set 时提供的 Comparator
进行排序,具体取决于使用的构造方法。
此实现为基本操作(add
、remove
和 contains
)提供受保证的 log(n) 时间开销。
注意,如果要正确实现 Set
接口,则 set 维护的顺序(无论是否提供了显式比较器)必须与 equals 一致。(关于与 equals 一致 的精确定义,请参阅 Comparable
或 Comparator
。)这是因为 Set
接口是按照 equals
操作定义的,但 TreeSet
实例使用它的 compareTo
(或 compare
)方法对所有元素进行比较,因此从 set 的观点来看,此方法认为相等的两个元素就是相等的。即使 set 的顺序与 equals 不一致,其行为也是 定义良好的;它只是违背了 Set
接口的常规协定。
注意,此实现不是同步的。如果多个线程同时访问一个 TreeSet,而其中至少一个线程修改了该 set,那么它必须 外部同步。这一般是通过对自然封装该 set 的对象执行同步操作来完成的。如果不存在这样的对象,则应该使用 Collections.synchronizedSortedSet
方法来“包装”该 set。此操作最好在创建时进行,以防止对 set 的意外非同步访问:
SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...));
此类的 iterator
方法返回的迭代器是快速失败 的:在创建迭代器之后,如果从结构上对 set 进行修改,除非通过迭代器自身的 remove
方法,否则在其他任何时间以任何方式进行修改都将导致迭代器抛出 ConcurrentModificationException
。因此,对于并发的修改,迭代器很快就完全失败,而不会冒着在将来不确定的时间发生不确定行为的风险。
注意,迭代器的快速失败行为无法得到保证,一般来说,存在不同步的并发修改时,不可能作出任何肯定的保证。快速失败迭代器尽最大努力抛出 ConcurrentModificationException
。因此,编写依赖于此异常的程序的做法是错误的,正确做法是:迭代器的快速失败行为应该仅用于检测 bug。
此类是 Java Collections Framework 的成员。
Collection
,
Set
,
HashSet
,
Comparable
,
Comparator
,
TreeMap
,
序列化表格构造方法摘要 | |
---|---|
TreeSet()
构造一个新的空 set,该 set 根据其元素的自然顺序进行排序。 |
|
TreeSet(Collection<? extends E> c)
构造一个包含指定 collection 元素的新 TreeSet,它按照其元素的自然顺序进行排序。 |
|
TreeSet(Comparator<? super E> comparator)
构造一个新的空 TreeSet,它根据指定比较器进行排序。 |
|
TreeSet(SortedSet<E> s)
构造一个与指定有序 set 具有相同映射关系和相同排序的新 TreeSet。 |
方法摘要 | |
---|---|
boolean |
add(E e)
将指定的元素添加到此 set(如果该元素尚未存在于 set 中)。 |
boolean |
addAll(Collection<? extends E> c)
将指定 collection 中的所有元素添加到此 set 中。 |
E |
ceiling(E e)
返回此 set 中大于等于给定元素的最小元素;如果不存在这样的元素,则返回 null 。 |
void |
clear()
移除此 set 中的所有元素。 |
Object |
clone()
返回 TreeSet 实例的浅表副本。 |
Comparator<? super E> |
comparator()
返回对此 set 中的元素进行排序的比较器;如果此 set 使用其元素的自然顺序,则返回 null。 |
boolean |
contains(Object o)
如果此 set 包含指定的元素,则返回 true 。 |
Iterator<E> |
descendingIterator()
返回在此 set 元素上按降序进行迭代的迭代器。 |
NavigableSet<E> |
descendingSet()
返回此 set 中所包含元素的逆序视图。 |
E |
first()
返回此 set 中当前第一个(最低)元素。 |
E |
floor(E e)
返回此 set 中小于等于给定元素的最大元素;如果不存在这样的元素,则返回 null 。 |
SortedSet<E> |
headSet(E toElement)
返回此 set 的部分视图,其元素严格小于 toElement。 |
NavigableSet<E> |
headSet(E toElement,
boolean inclusive)
返回此 set 的部分视图,其元素小于(或等于,如果 inclusive 为 true)toElement 。 |
E |
higher(E e)
返回此 set 中严格大于给定元素的最小元素;如果不存在这样的元素,则返回 null 。 |
boolean |
isEmpty()
如果此 set 不包含任何元素,则返回 true 。 |
Iterator<E> |
iterator()
返回在此 set 中的元素上按升序进行迭代的迭代器。 |
E |
last()
返回此 set 中当前最后一个(最高)元素。 |
E |
lower(E e)
返回此 set 中严格小于给定元素的最大元素;如果不存在这样的元素,则返回 null 。 |
E |
pollFirst()
获取并移除第一个(最低)元素;如果此 set 为空,则返回 null 。 |
E |
pollLast()
获取并移除最后一个(最高)元素;如果此 set 为空,则返回 null 。 |
boolean |
remove(Object o)
将指定的元素从 set 中移除(如果该元素存在于此 set 中)。 |
int |
size()
返回 set 中的元素数(set 的容量)。 |
NavigableSet<E> |
subSet(E fromElement,
boolean fromInclusive,
E toElement,
boolean toInclusive)
返回此 set 的部分视图,其元素范围从 fromElement 到 toElement 。 |
SortedSet<E> |
subSet(E fromElement,
E toElement)
返回此 set 的部分视图,其元素从 fromElement(包括)到 toElement(不包括)。 |
SortedSet<E> |
tailSet(E fromElement)
返回此 set 的部分视图,其元素大于等于 fromElement。 |
NavigableSet<E> |
tailSet(E fromElement,
boolean inclusive)
返回此 set 的部分视图,其元素大于(或等于,如果 inclusive 为 true)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 |
构造方法详细信息 |
---|
public TreeSet()
Comparable
接口。另外,所有这些元素都必须是可互相比较的:对于 set 中的任意两个元素 e1
和 e2
,执行 e1.compareTo(e2)
都不得抛出 ClassCastException
。如果用户试图将违反此约束的元素添加到 set(例如,用户试图将字符串元素添加到其元素为整数的 set 中),则 add
调用将抛出 ClassCastException
。
public TreeSet(Comparator<? super E> comparator)
e1
和 e2
,执行 comparator.compare(e1, e2)
都不得抛出 ClassCastException
。如果用户试图将违反此约束的元素添加到 set 中,则 add
调用将抛出 ClassCastException
。
comparator
- 将用来对此 set 进行排序的比较器。如果该参数为 null
,则使用元素的自然顺序。public TreeSet(Collection<? extends E> c)
Comparable
接口。另外,所有这些元素都必须是可互相比较的:对于 set 中的任意两个元素 e1
和 e2
,执行 e1.compareTo(e2)
都不得抛出 ClassCastException
。
c
- 一个 collection,其元素将组成新的 set
ClassCastException
- 如果 c
中的元素不是 Comparable
,或者是不可相互比较的
NullPointerException
- 如果指定 collection 为 nullpublic TreeSet(SortedSet<E> s)
s
- 一个有序 set,其元素将组成新 set
NullPointerException
- 如果指定有序 set 为 null方法详细信息 |
---|
public Iterator<E> iterator()
Iterable<E>
中的 iterator
Collection<E>
中的 iterator
NavigableSet<E>
中的 iterator
Set<E>
中的 iterator
AbstractCollection<E>
中的 iterator
public Iterator<E> descendingIterator()
NavigableSet<E>
中的 descendingIterator
public NavigableSet<E> descendingSet()
NavigableSet
复制的描述remove
操作除外),则迭代结果是不确定的。
返回 set 的顺序等于 Collections.reverseOrder
(comparator())。表达式 s.descendingSet().descendingSet()
返回的 s
视图基本等于 s
。
NavigableSet<E>
中的 descendingSet
public int size()
Collection<E>
中的 size
Set<E>
中的 size
AbstractCollection<E>
中的 size
public boolean isEmpty()
true
。
Collection<E>
中的 isEmpty
Set<E>
中的 isEmpty
AbstractCollection<E>
中的 isEmpty
true
public boolean contains(Object o)
true
。更确切地讲,当且仅当此 set 包含满足 (o==null ? e==null : o.equals(e)) 的元素 e
时,返回 true
。
Collection<E>
中的 contains
Set<E>
中的 contains
AbstractCollection<E>
中的 contains
o
- 将检查是否包含在此 set 中的对象
true
ClassCastException
- 如果指定对象无法与该 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public boolean add(E e)
e2
,则将指定元素 e
添加到此 set 中。如果此 set 已经包含这样的元素,则该调用不改变此 set 并返回 false
。
Collection<E>
中的 add
Set<E>
中的 add
AbstractCollection<E>
中的 add
e
- 要添加到此 set 的对象
true
ClassCastException
- 如果指定对象无法与此 set 的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public boolean remove(Object o)
e
,则移除一个这样的元素。如果此 set 包含这样的元素(或者此 set 由于调用而发生更改),则返回 true
。(一旦调用返回,则此 set 不再包含这样的元素。)
Collection<E>
中的 remove
Set<E>
中的 remove
AbstractCollection<E>
中的 remove
o
- 将从此 set 中移除的对象(如果存在)
true
ClassCastException
- 如果指定对象无法与该 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public void clear()
Collection<E>
中的 clear
Set<E>
中的 clear
AbstractCollection<E>
中的 clear
public boolean addAll(Collection<? extends E> c)
Collection<E>
中的 addAll
Set<E>
中的 addAll
AbstractCollection<E>
中的 addAll
c
- 包含要添加到此 set 的元素的 collection
true
ClassCastException
- 如果提供的元素无法与 set 中的当前元素进行比较
NullPointerException
- 如果指定 collection 为 null,或者任何元素为 null 并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素AbstractCollection.add(Object)
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
NavigableSet
复制的描述fromElement
到 toElement
。如果 fromElement
和 toElement
相等,则返回的 set 为空,除非 fromExclusive
和 toExclusive
都为 true。返回的 set 受此 set 支持,所以在返回 set 中的更改将反映在此 set 中,反之亦然。返回 set 支持此 set 支持的所有可选 set 操作。
如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException
。
NavigableSet<E>
中的 subSet
fromElement
- 返回 set 的低端点fromInclusive
- 如果低端点要包含在返回的视图中,则为 true
toElement
- 返回 set 的高端点toInclusive
- 如果高端点要包含在返回的视图中,则为 true
fromElement
(包括)到 toElement
(不包括)
ClassCastException
- 如果不能使用此 set 的比较器或者使用自然顺序(如果 set 没有比较器)比较 fromElement
和 toElement
。如果 fromElement
或 toElement
不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 fromElement
或 toElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果 fromElement
大于 toElement
;如果此 set 本身有范围限制,并且 fromElement
或 toElement
位于范围的边界之外。public NavigableSet<E> headSet(E toElement, boolean inclusive)
NavigableSet
复制的描述inclusive
为 true)toElement
。返回的 set 受此 set 支持,所以在返回 set 中的更改将反映在此 set 中,反之亦然。返回 set 支持此 set 支持的所有可选 set 操作。
如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException
。
NavigableSet<E>
中的 headSet
toElement
- 返回 set 的高端点inclusive
- 如果高端点要包含在返回的视图中,则为 true
inclusive
为 true)toElement
ClassCastException
- 如果 toElement
与此 set 的比较器不兼容(如果 set 没有比较器;如果 toElement
没有实现 Comparable
)。如果 toElement
不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 toElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果此 set 本身有范围限制,并且 toElement
位于范围的边界之外public NavigableSet<E> tailSet(E fromElement, boolean inclusive)
NavigableSet
复制的描述inclusive
为 true)fromElement
。返回的 set 受此 set 支持,所以在返回 set 中的更改将反映在此 set 中,反之亦然。返回 set 支持此 set 支持的所有可选 set 操作。
如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException
。
NavigableSet<E>
中的 tailSet
fromElement
- 返回 set 的低端点inclusive
- 如果低端点要包含在返回的视图中,则为 true
fromElement
ClassCastException
- 如果 fromElement
与此 set 的比较器不兼容(如果 set 没有任何比较器;如果 fromElement
没有实现 Comparable
)。如果 fromElement
不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 fromElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果此 set 本身有范围限制,并且 fromElement
位于范围的边界之外public SortedSet<E> subSet(E fromElement, E toElement)
NavigableSet
复制的描述如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException。
等效于 subSet(fromElement, true, toElement, false)
。
NavigableSet<E>
中的 subSet
SortedSet<E>
中的 subSet
fromElement
- 返回 set 的低端点(包括)toElement
- 返回 set 的高端点(不包括)
ClassCastException
- 如果无法使用此 set 的比较器(如果 set 没有比较器,则使用自然顺序)比较 fromElement 和 toElement。如果 fromElement 或 toElement 不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 fromElement
或 toElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果 fromElement 大于 toElement;如果此 set 本身有范围限制,并且 fromElement 或 toElement 位于范围的边界之外public SortedSet<E> headSet(E toElement)
NavigableSet
复制的描述如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException。
等效于 headSet(toElement, false)
。
NavigableSet<E>
中的 headSet
SortedSet<E>
中的 headSet
toElement
- 返回 set 的高端点(不包括)
ClassCastException
- 如果 toElement 与此 set 的比较器不兼容(如果 set 没有比较器;如果 toElement 没有实现 Comparable
)。如果 toElement 不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 toElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果此 set 本身有范围限制,并且 toElement 位于范围的边界之外public SortedSet<E> tailSet(E fromElement)
NavigableSet
复制的描述如果试图在返回 set 的范围之外插入元素,则返回的 set 将抛出 IllegalArgumentException。
等效于 tailSet(fromElement, true)
。
NavigableSet<E>
中的 tailSet
SortedSet<E>
中的 tailSet
fromElement
- 返回 set 的低端点(包括)
ClassCastException
- 如果 fromElement 与此 set 的比较器不兼容(如果 set 没有比较器;如果 fromElement 没有实现 Comparable
)。如果 fromElement 不能与 set 中的当前元素进行比较,则实现可以(但不是必须)抛出此异常。
NullPointerException
- 如果 fromElement
为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素
IllegalArgumentException
- 如果此 set 本身有范围限制,并且 fromElement 位于范围的边界之外public Comparator<? super E> comparator()
SortedSet
复制的描述
SortedSet<E>
中的 comparator
public E first()
SortedSet
复制的描述
SortedSet<E>
中的 first
NoSuchElementException
- 如果此 set 为空public E last()
SortedSet
复制的描述
SortedSet<E>
中的 last
NoSuchElementException
- 如果此 set 为空public E lower(E e)
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 lower
e
- 要匹配的值
e
的最大元素;如果不存在这样的元素,则返回 null
ClassCastException
- 如果指定元素不能与 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public E floor(E e)
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 floor
e
- 要匹配的值
e
的最大元素;如果不存在这样的元素,则返回 null
ClassCastException
- 如果指定元素不能与 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public E ceiling(E e)
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 ceiling
e
- 要匹配的值
e
的最小元素;如果不存在这样的元素,则返回 null
ClassCastException
- 如果指定元素不能与 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public E higher(E e)
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 higher
e
- 要匹配的值
e
的最小元素;如果不存在这样的元素,则返回 null
ClassCastException
- 如果指定元素不能与 set 中的当前元素进行比较
NullPointerException
- 如果指定元素为 null,并且此 set 使用自然顺序,或者其比较器不允许使用 null 元素public E pollFirst()
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 pollFirst
null
public E pollLast()
NavigableSet
复制的描述null
。
NavigableSet<E>
中的 pollLast
null
public Object clone()
TreeSet
实例的浅表副本。(这些元素本身不被复制。)
Object
中的 clone
Cloneable
|
JavaTM 2 Platform Standard Ed. 6 |
|||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。