|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
public interface Set<E>
一个不包含重复元素的 collection。更正式地说,set 不包含满足 e1.equals(e2)
的元素对 e1
和 e2
,并且最多包含一个 null 元素。正如其名称所暗示的,此接口模仿了数学上的 set 抽象。
在所有构造方法以及 add、equals 和 hashCode 方法的协定上,Set 接口还加入了其他规定,这些规定超出了从 Collection 接口所继承的内容。出于方便考虑,它还包括了其他继承方法的声明(这些声明的规范已经专门针对 Set 接口进行了修改,但是没有包含任何其他的规定)。
对这些构造方法的其他规定是(不要奇怪),所有构造方法必须创建一个不包含重复元素的 set(正如上面所定义的)。
注:如果将可变对象用作 set 元素,那么必须极其小心。如果对象是 set 中某个元素,以一种影响 equals 比较的方式改变对象的值,那么 set 的行为就是不确定的。此项禁止的一个特殊情况是不允许某个 set 包含其自身作为元素。
某些 set 实现对其所包含的元素有所限制。例如,某些实现禁止 null 元素,而某些则对其元素的类型所有限制。试图添加不合格的元素会抛出未经检查的异常,通常是 NullPointerException 或 ClassCastException。试图查询不合格的元素是否存在可能会抛出异常,也可能简单地返回 false;某些实现会采用前一种行为,而某些则采用后者。概括地说,试图对不合格元素执行操作时,如果完成该操作后不会导致在 set 中插入不合格的元素,则该操作可能抛出一个异常,也可能成功,这取决于实现的选择。此接口的规范中将这样的异常标记为“可选”。
此接口是 Java Collections Framework 的成员。
Collection
,
List
,
SortedSet
,
HashSet
,
TreeSet
,
AbstractSet
,
Collections.singleton(java.lang.Object)
,
Collections.EMPTY_SET
方法摘要 | ||
---|---|---|
boolean |
add(E o)
如果 set 中尚未存在指定的元素,则添加此元素(可选操作)。 |
|
boolean |
addAll(Collection<? extends E> c)
如果 set 中没有指定 collection 中的所有元素,则将其添加到此 set 中(可选操作)。 |
|
void |
clear()
移除 set 中的所有元素(可选操作)。 |
|
boolean |
contains(Object o)
如果 set 包含指定的元素,则返回 true。 |
|
boolean |
containsAll(Collection<?> c)
如果此 set 包含指定 collection 的所有元素,则返回 true。 |
|
boolean |
equals(Object o)
比较指定对象与此 set 的相等性。 |
|
int |
hashCode()
返回 set 的哈希码值。 |
|
boolean |
isEmpty()
如果 set 不包含元素,则返回 true。 |
|
Iterator<E> |
iterator()
返回在此 set 中的元素上进行迭代的迭代器。 |
|
boolean |
remove(Object o)
如果 set 中存在指定的元素,则将其移除(可选操作)。 |
|
boolean |
removeAll(Collection<?> c)
移除 set 中那些包含在指定 collection 中的元素(可选操作)。 |
|
boolean |
retainAll(Collection<?> c)
仅保留 set 中那些包含在指定 collection 中的元素(可选操作)。 |
|
int |
size()
返回 set 中的元素数(其容量)。 |
|
Object[] |
toArray()
返回一个包含 set 中所有元素的数组。 |
|
|
toArray(T[] a)
返回一个包含 set 中所有元素的数组;返回数组的运行时类型是指定数组的类型。 |
方法详细信息 |
---|
int size()
Collection<E>
中的 size
boolean isEmpty()
Collection<E>
中的 isEmpty
boolean contains(Object o)
true
:(o==null ? e==null : o.equals(e))
。
Collection<E>
中的 contains
o
- 要测试 set 中是否存在的元素。
ClassCastException
- 如果指定元素的类型与此 set 不兼容(可选)。
NullPointerException
- 如果指定的元素为 null 并且此 set 不支持 null 元素(可选)。Iterator<E> iterator()
Collection<E>
中的 iterator
Iterable<E>
中的 iterator
Object[] toArray()
Collection<E>
中的 toArray
<T> T[] toArray(T[] a)
Collection<E>
中的 toArray
a
- 存储 set 中元素的数组(如果其足够大的话);否则出于这一目的分配一个具有相同运行时类型的新数组。
ArrayStoreException
- a 的运行时类型不是 set 中所有元素的运行时类型的超类型。
NullPointerException
- 如果指定的数组为 null。boolean add(E o)
e
,则向 set 中添加指定的元素 o
:(o==null ? e==null :o.equals(e))
。如果此 set 已经包含指定的元素,则该调用不改变此 set 并返回 false。结合构造方法上的限制,这就可以确保 set 永远不包含重复的元素。上述规定并未暗示 set 必须接受所有元素;set 可以拒绝添加任意特定的元素,包括 null,并抛出异常,这与 Collection.add 规范中所描述的一样。每个 set 实现应该明确地记录对其可能包含元素的所有限制。
Collection<E>
中的 add
o
- 要添加到 set 中的元素。
UnsupportedOperationException
- 如果此 set 不支持 add 方法。
ClassCastException
- 如果指定元素的类不允许它添加到此 set。
NullPointerException
- 如果指定的元素为 null 并且此 set 不支持 null 元素。
IllegalArgumentException
- 如果指定元素的某方面不允许它添加到此 set。boolean remove(Object o)
e
,则移除它:(o==null ? e==null : o.equals(e))
。如果 set 包含指定的元素(或等价元素,如果此 set 随调用的结果发生变化),则返回 true(一旦调用返回,则 set 不再包含指定的元素)。
Collection<E>
中的 remove
o
- 从 set 中移除的对象(如果存在)。
ClassCastException
- 如果指定元素的类型与此 set 不兼容(可选)。
NullPointerException
- 如果指定的元素为 null,并且此 set 不支持 null 元素(可选)。
UnsupportedOperationException
- 如果此 set 不支持 remove 方法。boolean containsAll(Collection<?> c)
Collection<E>
中的 containsAll
c
- 检查是否包含在此 set 中的 collection。
ClassCastException
- 如果指定 collection 中的一个或多个元素的类型与此 set 不兼容(可选)。
NullPointerException
- 如果指定的 collection 包含一个或多个 null 元素并且此 set 不支持 null 元素(可选)。
NullPointerException
- 如果指定的 collection 为 null。contains(Object)
boolean addAll(Collection<? extends E> c)
Collection<E>
中的 addAll
c
- 要将其元素添加到 set 中的 collection。
UnsupportedOperationException
- 如果 set 不支持 addAll 方法。
ClassCastException
- 如果某些指定 collection 元素的类不允许它添加到此 set。
NullPointerException
- 如果指定的 collection 包含一个或多个 null 元素并且此 set 不支持 null 元素,或者指定的 collection 为 null。
IllegalArgumentException
- 如果某些指定的 collection 元素的某方面不允许它添加到此 set。add(Object)
boolean retainAll(Collection<?> c)
Collection<E>
中的 retainAll
c
- 定义此 set 将要保留哪些元素的 collection。
UnsupportedOperationException
- 如果此 Collection 不支持 retainAll 方法。
ClassCastException
- 如果 set 中的一个或多个元素类型与指定的 collection 不兼容(可选)。
NullPointerException
- 如果 set 包含 null 元素并且指定的 collection 不支持 null 元素(可选)。
NullPointerException
- 如果指定的 collection 为 null。remove(Object)
boolean removeAll(Collection<?> c)
Collection<E>
中的 removeAll
c
- 定义将要从 set 中移除哪些元素的 collection。
UnsupportedOperationException
- 如果此 Collection 不支持 removeAll 方法。
ClassCastException
- 如果 set 中的一个或多个元素类型与指定的 collection 不兼容(可选)。
NullPointerException
- 如果 set 包含 null 元素并且指定的 collection 不支持 null 元素(可选)。
NullPointerException
- 如果指定的 collection 为 null。remove(Object)
void clear()
Collection<E>
中的 clear
UnsupportedOperationException
- 如果此 set 不支持 clear 方法。boolean equals(Object o)
Collection<E>
中的 equals
Object
中的 equals
o
- 要与此 set 进行相等性比较的对象。
Object.hashCode()
,
Hashtable
int hashCode()
s1
和 s2
而言,s1.equals(s2)
就意味着 s1.hashCode()==s2.hashCode()
,正如 Object.hashCode 的常规协定所要求的那样。
Collection<E>
中的 hashCode
Object
中的 hashCode
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。