list.html

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

</DL>
<HR>

<A NAME="add(java.lang.Object)"><!-- --></A><A NAME="add(E)"><!-- --></A><H3>
add</H3>
<PRE>
boolean <B>add</B>(<A HREF="List.html" title="List 中的类型参数">E</A>&nbsp;o)</PRE>
<DL>
<DD>向列表的尾部追加指定的元素（可选操作）。<p>

支持该操作的列表可能对列表可以添加的元素有一些限制。特别是，某些列表将拒绝添加 null 元素，某些列表将在可以添加的元素类型上施加限制。List 类应该在它们的文档中明确指定有关添加元素的所有限制。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#add(E)">add</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 要追加到列表的元素。
<DT><B>返回：</B><DD><tt>true</tt>（根据 <tt>Collection.add</tt> 方法的常规协定）。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>add</tt> 方法。
<DD><CODE><A HREF="../lang/ClassCastException.html" title="java.lang 中的类">ClassCastException</A></CODE> - 如果指定元素的类不允许它添加到此列表。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的元素为 null，并且此列表不支持 null 元素。
<DD><CODE><A HREF="../lang/IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 如果此元素的某个方面不允许它添加到此列表。</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>移除列表中指定元素的第一个匹配项（可选操作）。如果列表不包含元素，则不更改列表。更正式地说，移除具有满足下面条件的最低索引 i 的元素：<tt>(o==null ? get(i)==null :o.equals(get(i)))</tt>（如果存在这样的元素）。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#remove(java.lang.Object)">remove</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 要从该列表中移除的元素，如果存在的话。
<DT><B>返回：</B><DD>如果列表包含指定的元素，则返回 <tt>true</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/ClassCastException.html" title="java.lang 中的类">ClassCastException</A></CODE> - 如果指定元素的类型和此列表不兼容（可选）。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的元素是 null，并且此列表不支持 null 元素（可选）。
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>remove</tt> 方法。</DL>
</DD>
</DL>
<HR>

<A NAME="containsAll(java.util.Collection)"><!-- --></A><H3>
containsAll</H3>
<PRE>
boolean <B>containsAll</B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;?&gt;&nbsp;c)</PRE>
<DL>
<DD>如果列表包含指定 collection 的所有元素，则返回 <tt>true</tt>。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#containsAll(java.util.Collection)">containsAll</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</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> - 如果指定的 collection 包含一个或多个 null 元素，并且此列表不支持 null 元素（可选）。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的 collection 为 <tt>null</tt>。<DT><B>另请参见：</B><DD><A HREF="List.html#contains(java.lang.Object)"><CODE>contains(Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addAll(java.util.Collection)"><!-- --></A><H3>
addAll</H3>
<PRE>
boolean <B>addAll</B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;? extends <A HREF="List.html" title="List 中的类型参数">E</A>&gt;&nbsp;c)</PRE>
<DL>
<DD>追加指定 collection 中的所有元素到此列表的结尾，顺序是指定 collection 的迭代器返回这些元素的顺序（可选操作）。如果在操作正在进行中修改了指定的 collection，那么该操作的行为是未指定的（注意，如果指定的 collection 是此列表，并且它是非空的，则会发生这种情况。）
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#addAll(java.util.Collection)">addAll</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</CODE> - 其元素要被添加到此列表的 collection。
<DT><B>返回：</B><DD>如果此列表由于此方法的调用而发生改变，则返回 <tt>true</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>addAll</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> - 如果指定的 collection 包含一个或多个 null 元素，并且该列表不支持 null 元素，或者指定的 collection 为 <tt>null</tt>。
<DD><CODE><A HREF="../lang/IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 如果指定 collection 中某元素的某个方面不允许它添加到此列表。<DT><B>另请参见：</B><DD><A HREF="List.html#add(E)"><CODE>add(Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addAll(int, java.util.Collection)"><!-- --></A><H3>
addAll</H3>
<PRE>
boolean <B>addAll</B>(int&nbsp;index,
               <A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;? extends <A HREF="List.html" title="List 中的类型参数">E</A>&gt;&nbsp;c)</PRE>
<DL>
<DD>将指定 collection 中的所有元素都插入到列表中的指定位置（可选操作）。将当前处于该位置的元素（如果有的话）和所有后续元素向右移动（增加其索引）。新元素将按照它们通过指定 collection 的迭代器所返回的顺序出现在此列表中。如果在操作正在进行中修改了指定的 collection，那么该操作的行为是未指定的（注意，如果指定的 collection 是此列表，并且它是非空的，则会发生这种情况。）
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>index</CODE> - 将指定 collection 的第一个元素所插入位置的索引。<DD><CODE>c</CODE> - 要插入到列表中的元素。
<DT><B>返回：</B><DD>如果此列表由于此方法的调用发生改变，则返回 <tt>true</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>addAll</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> - 如果指定的 collection 包含一个或多个 null 元素，并且该列表不支持 null 元素，或者指定的 collection 为 <tt>null</tt>。
<DD><CODE><A HREF="../lang/IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 如果指定 collection 中某个元素的某些方面不允许它添加到此列表。
<DD><CODE><A HREF="../lang/IndexOutOfBoundsException.html" title="java.lang 中的类">IndexOutOfBoundsException</A></CODE> - 如果索引超出范围 (index &lt; 0 || index &gt; size())。</DL>
</DD>
</DL>
<HR>

<A NAME="removeAll(java.util.Collection)"><!-- --></A><H3>
removeAll</H3>
<PRE>
boolean <B>removeAll</B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;?&gt;&nbsp;c)</PRE>
<DL>
<DD>从列表中移除指定 collection 中包含的所有元素（可选操作）。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#removeAll(java.util.Collection)">removeAll</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</CODE> - 定义将从此列表中移除哪些元素的 collection。
<DT><B>返回：</B><DD>如果此列表由于此方法的调用发生改变，则返回 <tt>true</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>removeAll</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/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的 collection 为 <tt>null</tt>。<DT><B>另请参见：</B><DD><A HREF="List.html#remove(java.lang.Object)"><CODE>remove(Object)</CODE></A>, 
<A HREF="List.html#contains(java.lang.Object)"><CODE>contains(Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="retainAll(java.util.Collection)"><!-- --></A><H3>
retainAll</H3>
<PRE>
boolean <B>retainAll</B>(<A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;?&gt;&nbsp;c)</PRE>
<DL>
<DD>仅在列表中保留指定 collection 中所包含的元素（可选操作）。换句话说，该方法从列表中移除未包含在指定 collection 中的所有元素。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#retainAll(java.util.Collection)">retainAll</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</CODE> - 定义此 set 将保留哪些元素的 collection。
<DT><B>返回：</B><DD>如果此列表由于此方法的调用发生改变，则返回 <tt>true</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>retainAll</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/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果指定的 collection 为 <tt>null</tt>。<DT><B>另请参见：</B><DD><A HREF="List.html#remove(java.lang.Object)"><CODE>remove(Object)</CODE></A>, 
<A HREF="List.html#contains(java.lang.Object)"><CODE>contains(Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
void <B>clear</B>()</PRE>
<DL>
<DD>从列表中移除所有元素（可选操作）。此调用返回后列表将是空的（除非它抛出异常）。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#clear()">clear</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/UnsupportedOperationException.html" title="java.lang 中的类">UnsupportedOperationException</A></CODE> - 如果列表不支持 <tt>clear</tt> 方法。</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(<A HREF="../lang/Object.html" title="java.lang 中的类">Object</A>&nbsp;o)</PRE>
<DL>
<DD>比较指定的对象与列表是否相等。当且仅当指定的对象也是一个列表、两个列表有相同的大小，并且两个列表中的所有相应的元素对<i>相等</i> 时才返回 <tt>true</tt>（ 如果 <tt>(e1==null ? e2==null :e1.equals(e2))</tt>，则两个元素 <tt>e1</tt> 和 <tt>e2</tt> 是<i>相等</i> 的）。换句话说，如果两个列表以相同的顺序包含相同的元素，则定义它们是相等的。该定义确保了 equals 方法在 <tt>List</tt> 接口的不同实现间正常工作。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#equals(java.lang.Object)">equals</A></CODE><DT><B>覆盖：</B><DD>类 <CODE><A HREF="../lang/Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="../lang/Object.html#equals(java.lang.Object)">equals</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>o</CODE> - 要与此列表进行相等性比较的对象。
<DT><B>返回：</B><DD>如果指定对象与此列表相等，则返回 <tt>true</tt>。<DT><B>另请参见：</B><DD><A HREF="../lang/Object.html#hashCode()"><CODE>Object.hashCode()</CODE></A>, 
<A HREF="Hashtable.html" title="java.util 中的类"><CODE>Hashtable</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
int <B>hashCode</B>()</PRE>
<DL>
<DD>返回列表的哈希代码值。列表的哈希代码定义为以下计算的结果：
 <pre>
  hashCode = 1;
  Iterator i = list.iterator();
  while (i.hasNext()) {
      Object obj = i.next();
      hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
  }
 </pre>
这确保了按照 <tt>Object.hashCode</tt> 的常规协定要求，对于任何两个列表 <tt>list1</tt> 和 <tt>list2</tt>，<tt>list1.equals(list2)</tt> 的含义是 <tt>list1.hashCode()==list2.hashCode()</tt>。
<P>
<DD><DL>
<DT><B>指定者：</B><DD>接口 <CODE><A HREF="Collection.html" title="java.util 中的接口">Collection</A>&lt;<A HREF="List.html" title="List 中的类型参数">E</A>&gt;</CODE> 中的 <CODE><A HREF="Collection.html#hashCode()">hashCode</A></CODE><DT><B>覆盖：</B><DD>类 <CODE><A HREF="../lang/Object.html" title="java.lang 中的类">Object</A></CODE> 中的 <CODE><A HREF="../lang/Object.html#hashCode()">hashCode</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>返回：</B><DD>此列表的哈希代码值。<DT><B>另请参见：</B><DD><A HREF="../lang/Object.html#hashCode()"><CODE>Object.hashCode()</CODE></A>, 
<A HREF="../lang/Object.html#equals(java.lang.Object)"><CODE>Object.equals(Object)</CODE></A>, 
<A HREF="List.html#equals(java.lang.Object)"><CODE>equals(Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="get(int)"><!-- --></A><H3>
get</H3>
<PRE>
<A HREF="List.html" title="List 中的类型参数">E</A> <B>get</B>(int&nbsp;index)</PRE>
<DL>
<DD>返回列表中指定位置的元素。
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>参数：</B><DD><CODE>index</CODE> - 要返回的元素的索引。
<DT><B>返回：</B><DD>列表中指定位置的元素。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../lang/IndexOutOfBoundsException.html" title="java.lang 中的类">IndexOutOfBoundsException</A></CODE> - 如果索引超出范围 (index &lt; 0 || index &gt;= size())。</DL>