站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

LinkedList (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

JavaTM 2 Platform
Standard Ed. 5.0

java.util
类 LinkedList<E>

java.lang.Object
  继承者 java.util.AbstractCollection<E>
      继承者 java.util.AbstractList<E>
          继承者 java.util.AbstractSequentialList<E>
              继承者 java.util.LinkedList<E>
类型参数:
E - 在此集合中保持的元素的类型
所有已实现的接口:
Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, Queue<E>

public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Queue<E>, Cloneable, Serializable

List 接口的链接列表实现。实现所有可选的列表操作,并且允许所有元素(包括 null)。除了实现 List 接口外,LinkedList 类还为在列表的开头及结尾 getremoveinsert 元素提供了统一的命名方法。这些操作允许将链接列表用作堆栈、队列或双端队列 (deque)。

此类实现 Queue 接口,为 addpoll 等提供先进先出队列操作。其他堆栈和双端队列操作可以根据标准列表操作方便地进行再次强制转换。虽然它们可能比等效列表操作运行稍快,但是将其包括在这里主要是出于方便考虑。

所有操作都是按照双重链接列表的需要执行的。在列表中编索引的操作将从开头或结尾遍历列表(从靠近指定索引的一端)。

注意,此实现不是同步的。如果多个线程同时访问列表,而其中至少一个线程从结构上修改了该列表,则它必须 保持外部同步。(结构修改指添加或删除一个或多个元素的任何操作;仅设置元素的值不是结构修改。)这一般通过对自然封装该列表的对象进行同步操作来完成。如果不存在这样的对象,则应该使用 Collections.synchronizedList 方法来“包装”该列表。最好在创建时完成这一操作,以防止对列表进行意外的不同步访问,如下所示:

     List list = Collections.synchronizedList(new LinkedList(...));
 

此类的 iteratorlistIterator 方法返回的迭代器是快速失败 的:在迭代器创建之后,如果从结构上对列表进行修改,除非通过迭代器自身的 removeadd 方法,其他任何时间任何方式的修改,迭代器都将抛出 ConcurrentModificationException。因此,面对并发的修改,迭代器很快就会完全失败,而不冒将来不确定的时间任意发生不确定行为的风险。

注意,迭代器的快速失败行为不能得到保证,一般来说,存在不同步的并发修改时,不可能作出任何硬性保证。快速失败迭代器尽最大努力抛出 ConcurrentModificationException。因此,编写依赖于此异常的程序的方式是错误的,正确做法是:迭代器的快速失败行为应该仅用于检测程序错误。

此类是 Java Collections Framework 的成员。

从以下版本开始:
1.2
另请参见:
List, ArrayList, Vector, Collections.synchronizedList(List), 序列化表格

字段摘要
 
从类 java.util.AbstractList 继承的字段
modCount
 
构造方法摘要
LinkedList()
          构造一个空列表。
LinkedList(Collection<? extends E> c)
          构造一个包含指定集合中的元素的列表,这些元素按其集合的迭代器返回的顺序排列。
 
方法摘要
 boolean add(E o)
          将指定元素追加到此列表的结尾。
 void add(int index, E element)
          在此列表中指定的位置插入指定的元素。
 boolean addAll(Collection<? extends E> c)
          追加指定 collection 中的所有元素到此列表的结尾,顺序是指定 collection 的迭代器返回这些元素的顺序。
 boolean addAll(int index, Collection<? extends E> c)
          将指定集合中的所有元素从指定位置开始插入此列表。
 void addFirst(E o)
          将给定元素插入此列表的开头。
 void addLast(E o)
          将给定元素追加到此列表的结尾。
 void clear()
          从此列表中移除所有元素。
 Object clone()
          返回此 LinkedList 的浅表复制。
 boolean contains(Object o)
          如果此列表包含指定元素,则返回 true
 E element()
          找到但不移除此列表的头(第一个元素)。
 E get(int index)
          返回此列表中指定位置处的元素。
 E getFirst()
          返回此列表的第一个元素。
 E getLast()
          返回此列表的最后一个元素。
 int indexOf(Object o)
          返回此列表中首次出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。
 int lastIndexOf(Object o)
          返回此列表中最后出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。
 ListIterator<E> listIterator(int index)
          返回此列表中的元素的列表迭代器(按适当顺序),从列表中指定位置开始。
 boolean offer(E o)
          将指定元素添加到此列表的末尾(最后一个元素)。
 E peek()
          找到但不移除此列表的头(第一个元素)。
 E poll()
          找到并移除此列表的头(第一个元素)。
 E remove()
          找到并移除此列表的头(第一个元素)。
 E remove(int index)
          移除此列表中指定位置处的元素。
 boolean remove(Object o)
          移除此列表中首次出现的指定元素。
 E removeFirst()
          移除并返回此列表的第一个元素。
 E removeLast()
          移除并返回此列表的最后一个元素。
 E set(int index, E element)
          将此列表中指定位置的元素替换为指定的元素。
 int size()
          返回此列表的元素数。
 Object[] toArray()
          以正确顺序返回包含此列表中所有元素的数组。
<T> T[]
toArray(T[] a)
          以正确顺序返回包含此列表中所有元素的数组;返回数组的运行时类型即为指定数组的类型。
 
从类 java.util.AbstractSequentialList 继承的方法
iterator
 
从类 java.util.AbstractList 继承的方法
equals, hashCode, listIterator, removeRange, subList
 
从类 java.util.AbstractCollection 继承的方法
containsAll, isEmpty, removeAll, retainAll, toString
 
从类 java.lang.Object 继承的方法
finalize, getClass, notify, notifyAll, wait, wait, wait
 
从接口 java.util.List 继承的方法
containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, retainAll, subList
 

构造方法详细信息

LinkedList

public LinkedList()
构造一个空列表。


LinkedList

public LinkedList(Collection<? extends E> c)
构造一个包含指定集合中的元素的列表,这些元素按其集合的迭代器返回的顺序排列。

参数:
c - 要将其元素放到此集合中的列表。
抛出:
NullPointerException - 如果指定的集合为 null。
方法详细信息

getFirst

public E getFirst()
返回此列表的第一个元素。

返回:
此列表的第一个元素。
抛出:
NoSuchElementException - 如果此列表为空。

getLast

public E getLast()
返回此列表的最后一个元素。

返回:
此列表的最后一个元素。
抛出:
NoSuchElementException - 如果此列表为空。

removeFirst

public E removeFirst()
移除并返回此列表的第一个元素。

返回:
此列表的第一个元素。
抛出:
NoSuchElementException - 如果此列表为空。

removeLast

public E removeLast()
移除并返回此列表的最后一个元素。

返回:
此列表的最后一个元素。
抛出:
NoSuchElementException - 如果此列表为空。

addFirst

public void addFirst(E o)
将给定元素插入此列表的开头。

参数:
o - 要插入到此列表的开头的元素。

addLast

public void addLast(E o)
将给定元素追加到此列表的结尾。(与 add 方法功能相同;包括它只是出于一致性考虑。)

参数:
o - 要插入到此列表的结尾的元素。

contains

public boolean contains(Object o)
如果此列表包含指定元素,则返回 true。更正式地说,当且仅当此列表包含至少一个满足以下条件的元素 e 时返回 true(o==null ? e==null : o.equals(e))

指定者:
接口 Collection<E> 中的 contains
指定者:
接口 List<E> 中的 contains
覆盖:
AbstractCollection<E> 中的 contains
参数:
o - 要测试在此列表中是否存在的元素。
返回:
如果此列表包含指定元素,则返回 true

size

public int size()
返回此列表的元素数。

指定者:
接口 Collection<E> 中的 size
指定者:
接口 List<E> 中的 size
指定者:
AbstractCollection<E> 中的 size
返回:
此列表的元素数。

add

public boolean add(E o)
将指定元素追加到此列表的结尾。

指定者:
接口 Collection<E> 中的 add
指定者:
接口 List<E> 中的 add
覆盖:
AbstractList<E> 中的 add
参数:
o - 要追加到此列表的元素。
返回:
true(按照 Collection.add 的常规协定)。

remove

public boolean remove(Object o)
移除此列表中首次出现的指定元素。如果列表不包含该元素,则不作更改。更正式地说,移除具有满足以下条件的最低索引 i 的元素 :(o==null ? get(i)==null : o.equals(get(i)))(如果存在这样的元素)。

指定者:
接口 Collection<E> 中的 remove
指定者:
接口 List<E> 中的 remove
覆盖:
AbstractCollection<E> 中的 remove
参数:
o - 要从此列表删除的元素,如果存在。
返回:
如果列表包含指定元素,则返回 true

addAll

public boolean addAll(Collection<? extends E> c)
追加指定 collection 中的所有元素到此列表的结尾,顺序是指定 collection 的迭代器返回这些元素的顺序。如果指定的集合在操作过程中被修改,则此操作的行为是不明确的。(这意味着如果指定集合就是此列表并且此列表为非空,则此调用的行为是不明确的。)

指定者:
接口 Collection<E> 中的 addAll
指定者:
接口 List<E> 中的 addAll
覆盖:
AbstractCollection<E> 中的 addAll
参数:
c - 要插入此列表的元素。
返回:
如果此列表由于调用而更改,则返回 true
抛出:
NullPointerException - 如果指定的集合为 null。
另请参见:
AbstractCollection.add(Object)

addAll

public boolean addAll(int index,
                      Collection<? extends E> c)
将指定集合中的所有元素从指定位置开始插入此列表。移动当前在该位置上的元素(如果有),所有后续元素都向右移(增加其索引)。新元素将按由指定集合的迭代器返回的顺序在列表中显示。

指定者:
接口 List<E> 中的 addAll
覆盖:
AbstractSequentialList<E> 中的 addAll
参数:
index - 在其中插入指定集合中第一个元素的索引。
c - 要插入此列表的元素。
返回:
如果此列表由于调用而更改,则返回 true
抛出:
IndexOutOfBoundsException - 如果指定的索引超出范围 (index < 0 || index > size())。
NullPointerException - 如果指定的集合为 null。

clear

public void clear()
从此列表中移除所有元素。

指定者:
接口 Collection<E> 中的 clear
指定者:
接口 List<E> 中的 clear
覆盖:
AbstractList<E> 中的 clear

get

public E get(int index)
返回此列表中指定位置处的元素。

指定者:
接口 List<E> 中的 get
覆盖:
AbstractSequentialList<E> 中的 get
参数:
index - 要返回的元素的索引。
返回:
列表中指定位置的元素。
抛出:
IndexOutOfBoundsException - 如果指定的索引超出范围 (index < 0 || index >= size())。

set

public E set(int index,
             E element)
将此列表中指定位置的元素替换为指定的元素。

指定者:
接口 List<E> 中的 set
覆盖:
AbstractSequentialList<E> 中的 set
参数:
index - 要替换的元素的索引。
element - 要在指定位置存储的元素。
返回:
以前在指定位置的元素。
抛出:
IndexOutOfBoundsException - 如果指定的索引超出范围 (index < 0 || index >= size())。

add

public void add(int index,
                E element)
在此列表中指定的位置插入指定的元素。移动当前在该位置处的元素(如果有),所有后续元素都向右移(在其索引中添加 1)。

指定者:
接口 List<E> 中的 add
覆盖:
AbstractSequentialList<E> 中的 add
参数:
index - 要在其中插入指定元素的索引。
element - 要插入的元素。
抛出:
IndexOutOfBoundsException - 如果指定的索引超出范围 (index < 0 || index > size())。

remove

public E remove(int index)
移除此列表中指定位置处的元素。将任何后续元素向左移(从索引中减 1)。返回从列表中删除的元素。

指定者:
接口 List<E> 中的 remove
覆盖:
AbstractSequentialList<E> 中的 remove
参数:
index - 要删除的元素的索引。
返回:
以前在指定位置的元素。
抛出:
IndexOutOfBoundsException - 如果指定的索引超出范围 (index < 0 || index >= size())。

indexOf

public int indexOf(Object o)
返回此列表中首次出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。更正式地说,返回满足以下条件的最低索引 i:(o==null ? get(i)==null :o.equals(get(i))),如果没有此索引,则返回 -1。

指定者:
接口 List<E> 中的 indexOf
覆盖:
AbstractList<E> 中的 indexOf
参数:
o - 要搜索的元素。
返回:
此列表中首次出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。

lastIndexOf

public int lastIndexOf(Object o)
返回此列表中最后出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。更正式地说,返回满足以下条件的最高索引 i:(o==null ? get(i)==null :o.equals(get(i))),如果没有此索引,则返回 -1。

指定者:
接口 List<E> 中的 lastIndexOf
覆盖:
AbstractList<E> 中的 lastIndexOf
参数:
o - 要搜索的元素。
返回:
此列表中最后出现的指定元素的索引,如果列表中不包含此元素,则返回 -1。

peek

public E peek()
找到但不移除此列表的头(第一个元素)。

指定者:
接口 Queue<E> 中的 peek
返回:
此队列的头,如果此队列为空,则返回 null
从以下版本开始:
1.5

element

public E element()
找到但不移除此列表的头(第一个元素)。

指定者:
接口 Queue<E> 中的 element
返回:
队列的头。
抛出:
NoSuchElementException - 如果此队列为空。
从以下版本开始:
1.5

poll

public E poll()
找到并移除此列表的头(第一个元素)。

指定者:
接口 Queue<E> 中的 poll
返回:
此队列的头,如果此队列为空,则返回 null
从以下版本开始:
1.5

remove

public E remove()
找到并移除此列表的头(第一个元素)。

指定者:
接口 Queue<E> 中的 remove
返回:
队列的头。
抛出:
NoSuchElementException - 如果此队列为空。
从以下版本开始:
1.5

offer

public boolean offer(E o)
将指定元素添加到此列表的末尾(最后一个元素)。

指定者:
接口 Queue<E> 中的 offer
参数:
o - 要添加的元素。
返回:
true(按照 Queue.offer 的常规协定)
从以下版本开始:
1.5

listIterator

public ListIterator<E> listIterator(int index)
返回此列表中的元素的列表迭代器(按适当顺序),从列表中指定位置开始。遵守 List.listIterator(int) 的常规协定。

列表迭代器是快速失败 的:在迭代器创建之后,如果从结构上对列表进行修改,除非通过列表迭代器自身的 removeadd 方法,其他任何时间任何方式的修改,列表迭代器都将抛出 ConcurrentModificationException。因此,面对并发的修改,迭代器很快就会完全失败,而不冒将来不确定的时间任意发生不确定行为的风险。

指定者:
接口 List<E> 中的 listIterator
指定者:
AbstractSequentialList<E> 中的 listIterator
参数:
index - 要从列表迭代器返回的第一个元素的索引(通过调用 next 方法)。
返回:
此列表中的元素的 ListIterator(按适当顺序),从列表中指定位置开始。
抛出:
IndexOutOfBoundsException - 如果索引超出范围 (index < 0 || index > size())。
另请参见:
List.listIterator(int)

clone

public Object clone()
返回此 LinkedList 的浅表复制。(这些元素本身没有克隆。)

覆盖:
Object 中的 clone
返回:
LinkedList 实例的浅表复制。
另请参见:
Cloneable

toArray

public Object[] toArray()
以正确顺序返回包含此列表中所有元素的数组。

指定者:
接口 Collection<E> 中的 toArray
指定者:
接口 List<E> 中的 toArray
覆盖:
AbstractCollection<E> 中的 toArray
返回:
包含此列表中所有元素的正确顺序的数组。
另请参见:
Arrays.asList(Object[])

toArray

public <T> T[] toArray(T[] a)
以正确顺序返回包含此列表中所有元素的数组;返回数组的运行时类型即为指定数组的类型。如果列表适合指定数组,则在其中返回该列表。否则,分配具有指定数组的运行时类型和此列表的大小的新数组。

如果在指定数组中放入列表尚有剩余空间(即数组比列表元素多),则紧跟在集合末尾的数组元素会被设置为 null。 当调用方知道列表不包含任何 null 元素时,才可使用此方法来确定列表的长度。

指定者:
接口 Collection<E> 中的 toArray
指定者:
接口 List<E> 中的 toArray
覆盖:
AbstractCollection<E> 中的 toArray
参数:
a - 要在其中存储列表元素的数组(如果它足够大);否则,为其分配具有相同运行时类型的新数组。
返回:
包含列表元素的数组。
抛出:
ArrayStoreException - 如果 a 的运行时类型不是此列表中每个元素的运行时类型的超类型。
NullPointerException - 如果指定的数组为 null。

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策