collection.html

来自「j2se5-api-zh,java文档的中文版本」· HTML 代码 · 共 675 行 · 第 1/3 页

<TD><CODE><B><A HREF="Collection.html#remove(java.lang.Object)">remove</A></B>(<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>&nbsp;o)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;从此 collection 中移除指定元素的单个实例，如果存在的话（可选操作）。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="Collection.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;?&gt;&nbsp;c)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;移除此 collection 中那些也包含在指定 collection 中的所有元素（可选操作）。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="Collection.html#retainAll(java.util.Collection)">retainAll</A></B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;?&gt;&nbsp;c)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;仅保留此 collection 中那些也包含在指定 collection 的元素（可选操作）。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="Collection.html#size()">size</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;返回此 collection 中的元素数。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="Collection.html#toArray()">toArray</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;返回包含此 collection 中所有元素的数组。</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE>&lt;T&gt; T[]</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="Collection.html#toArray(T[])">toArray</A></B>(T[]&nbsp;a)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;返回包含此 collection 中所有元素的数组；返回数组的运行时类型与指定数组的运行时类型相同。</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
int <B>size</B>()</PRE>
<DL>
<DD>返回此 collection 中的元素数。如果此 collection 包含多个 <tt>Integer.MAX_VALUE</tt> 元素，则返回 <tt>Integer.MAX_VALUE</tt>。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>此 collection 中的元素数</DL>
</DD>
</DL>
<HR>

<A NAME="isEmpty()"><!-- --></A><H3>
isEmpty</H3>
<PRE>
boolean <B>isEmpty</B>()</PRE>
<DL>
<DD>如果此 collection 不包含元素，则返回 <tt>true</tt>。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>如果此 collection 不包含元素，则返回 <tt>true</tt></DL>
</DD>
</DL>
<HR>

<A NAME="contains(java.lang.Object)"><!-- --></A><H3>
contains</H3>
<PRE>
boolean <B>contains</B>(<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>&nbsp;o)</PRE>
<DL>
<DD>如果此 collection 包含指定的元素，则返回 <tt>true</tt>。更正式地说，当且仅当此 collection 至少包含一个满足 <tt>(o==null ? e==null : o.equals(e))</tt> 的元素 <tt>e</tt> 时才返回 <tt>true</tt>。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 测试在此 collection 中是否存在的元素。
<DT><B>返回：</B><DD>如果此 collection 包含指定的元素，则返回 <tt>true</tt>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/ClassCastException.html" title="java.lang 中的类">ClassCastException</A></CODE> - 如果指定元素的类型与此 collection 不兼容（可选）。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的元素为 null，并且此 collection 不支持 null 元素（可选）。</DL>
</DD>
</DL>
<HR>

<A NAME="iterator()"><!-- --></A><H3>
iterator</H3>
<PRE>
<A HREF="Iterator.html" title="java.util 中的接口">Iterator</A>&lt;<A HREF="Collection.html" title="Collection 中的类型参数">E</A>&gt; <B>iterator</B>()</PRE>
<DL>
<DD>返回在此 collection 的元素上进行迭代的迭代器。关于元素返回的顺序没有任何保证（除非此 collection 是某个能提供保证顺序的类实例）。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="../lang/Iterable.html" title="java.lang 中的接口">Iterable</A>&lt;<A HREF="Collection.html" title="Collection 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="../lang/Iterable.html#iterator()">iterator</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>在此 collection 的元素上进行迭代的 <tt>Iterator</tt></DL>
</DD>
</DL>
<HR>

<A NAME="toArray()"><!-- --></A><H3>
toArray</H3>
<PRE>
<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>[] <B>toArray</B>()</PRE>
<DL>
<DD>返回包含此 collection 中所有元素的数组。如果 collection 对其迭代器返回的元素顺序做出了某些保证，那么此方法必须以相同的顺序返回这些元素。<p>

返回的数组将是“安全的”，因为此 collection 并不维护对返回数组的任何引用。（换句话说，即使 collection 受到数组的支持，此方法也必须分配一个新的数组）。因此，调用方可以自由地修改返回的数组。<p>

此方法充当了基于数组的 API 与基于 collection 的 API 之间的桥梁。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>包含此 collection 中所有元素的数组</DL>
</DD>
</DL>
<HR>

<A NAME="toArray(java.lang.Object)"><!-- --></A><A NAME="toArray(T[])"><!-- --></A><H3>
toArray</H3>
<PRE>
&lt;T&gt; T[] <B>toArray</B>(T[]&nbsp;a)</PRE>
<DL>
<DD>返回包含此 collection 中所有元素的数组；返回数组的运行时类型与指定数组的运行时类型相同。如果指定的数组能容纳该 collection，则返回包含此 collection 元素的数组。否则，将根据指定数组的运行时类型和此 collection 的大小分配一个新数组。<p>

如果指定的数组能容纳 collection 并有剩余空间（即数组的元素比 collection 的元素多），那么会将数组中紧跟在 collection 末尾的元素设置为 <tt>null</tt>。（这对确定 collection 的长度很有用，但<i>只有</i> 在调用方知道此 collection 没有包含任何 <tt>null</tt> 元素时才可行。）<p>

如果此 collection 对其迭代器返回的元素顺序做出了某些保证，那么此方法必须以相同的顺序返回这些元素。<p>

像 <tt>toArray</tt> 方法一样，此方法充当了基于数组的 API 与基于 collection 的 API 之间的桥梁。更进一步说，此方法允许在输出数组的运行时类型上进行精确控制，并且在某些情况下，可以用来节省分配开销。<p>

假定 <tt>l</tt> 是只包含字符串的一个已知 <tt>List</tt>。以下代码用来将该列表转储到一个新分配的 <tt>String</tt> 数组：

 <pre>
     String[] x = (String[]) v.toArray(new String[0]);
 </pre><p>

注意，<tt>toArray(new Object[0])</tt> 和 <tt>toArray()</tt> 在功能上是相同的。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>a</CODE> - 存储此 collection 元素的数组（如果其足够大）；否则，将为此分配一个具有相同运行时类型的新数组。
<DT><B>返回：</B><DD>包含此 collection 元素的数组
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/ArrayStoreException.html" title="java.lang 中的类">ArrayStoreException</A></CODE> - 指定数组的运行时类型不是此 collection 每个元素运行时类型的超类型。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的数组为 <tt>null</tt>。</DL>
</DD>
</DL>
<HR>

<A NAME="add(java.lang.Object)"><!-- --></A><A NAME="add(E)"><!-- --></A><H3>
add</H3>
<PRE>
boolean <B>add</B>(<A HREF="Collection.html" title="Collection 中的类型参数">E</A>&nbsp;o)</PRE>
<DL>
<DD>确保此 collection 包含指定的元素（可选操作）。如果此 collection 由于此方法的调用而发生改变，则返回 <tt>true</tt>。（如果此 collection 不允许有重复元素，并且已经包含了指定的元素，则返回 <tt>false</tt>。）<p>

支持此操作的 collection 可以限制哪些元素能添加到此 collection 中来。需要特别指出的是，一些 collection 拒绝添加 <tt>null</tt> 元素，其他一些 collection 将对可以添加的元素类型强加限制。Collection 类应该在其文档中清楚地指定能添加哪些元素方面的所有限制。<p>

如果 collection 由于某些原因（已经包含该元素的原因除外）拒绝添加特定的元素，那么它<i>必须</i> 抛出一个异常（而不是返回 <tt>false</tt>）。这确保了在此调用返回后，collection 总是包含指定的元素。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 确定此 collection 中是否存在的元素。
<DT><B>返回：</B><DD>如果此 collection 由于此方法的调用而发生改变，则返回 <tt>true</tt>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 此 collection 不支持 <tt>add</tt> 操作。
<DD><CODE><A HREF="../lang/ClassCastException.html" title="java.lang 中的类">ClassCastException</A></CODE> - 指定元素的类不允许它添加到此 collection 中。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的元素为 null，并且此 collection 不支持 null 元素。
<DD><CODE><A HREF="../lang/IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 此元素的某方面不允许它添加到此 collection 中。</DL>
</DD>
</DL>
<HR>

<A NAME="remove(java.lang.Object)"><!-- --></A><H3>
remove</H3>
<PRE>
boolean <B>remove</B>(<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>&nbsp;o)</PRE>
<DL>
<DD>从此 collection 中移除指定元素的单个实例，如果存在的话（可选操作）。更正式地说，如果此 collection 包含一个或多个满足 <tt>(o==null ?  e==null : o.equals(e))</tt> 的元素 <tt>e</tt>，则移除这样的元素。如果此 collection 包含指定的元素（或者此 collection 由于此方法的调用而发生改变），则返回 true。
<P>