java.lang.Object | ||||
↳ | java.util.AbstractCollection<E> | |||
↳ | java.util.AbstractList<E> | |||
↳ | java.util.AbstractSequentialList<E> | |||
↳ | java.util.LinkedList<E> |
Linked list implementation of the List interface. Implements all
optional list operations, and permits all elements (including
null). In addition to implementing the List interface,
the LinkedList class provides uniformly named methods to
get, remove and insert an element at the
beginning and end of the list. These operations allow linked lists to be
used as a stack, queue
, or double-ended queue
.
The class implements the Deque interface, providing first-in-first-out queue operations for add, poll, along with other stack and deque operations.
All of the operations perform as could be expected for a doubly-linked list. Operations that index into the list will traverse the list from the beginning or the end, whichever is closer to the specified index.
Note that this implementation is not synchronized.
If multiple threads access a linked list concurrently, and at least
one of the threads modifies the list structurally, it must be
synchronized externally. (A structural modification is any operation
that adds or deletes one or more elements; merely setting the value of
an element is not a structural modification.) This is typically
accomplished by synchronizing on some object that naturally
encapsulates the list.
If no such object exists, the list should be "wrapped" using the
Collections.synchronizedList
method. This is best done at creation time, to prevent accidental
unsynchronized access to the list:
List list = Collections.synchronizedList(new LinkedList(...));
The iterators returned by this class's iterator and
listIterator methods are fail-fast: if the list is
structurally modified at any time after the iterator is created, in
any way except through the Iterator's own remove or
add methods, the iterator will throw a ConcurrentModificationException
. Thus, in the face of concurrent
modification, the iterator fails quickly and cleanly, rather than
risking arbitrary, non-deterministic behavior at an undetermined
time in the future.
Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.
This class is a member of the Java Collections Framework.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an empty list.
| |||||||||||
Constructs a list containing the elements of the specified
collection, in the order they are returned by the collection's
iterator.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Appends the specified element to the end of this list.
| |||||||||||
Inserts the specified element at the specified position in this list.
| |||||||||||
Appends all of the elements in the specified collection to the end of
this list, in the order that they are returned by the specified
collection's iterator.
| |||||||||||
Inserts all of the elements in the specified collection into this
list, starting at the specified position.
| |||||||||||
Inserts the specified element at the beginning of this list.
| |||||||||||
Appends the specified element to the end of this list.
| |||||||||||
Removes all of the elements from this list.
| |||||||||||
Returns a shallow copy of this LinkedList.
| |||||||||||
Returns true if this list contains the specified element.
| |||||||||||
Returns an iterator over the elements in this deque in reverse
sequential order.
| |||||||||||
Retrieves, but does not remove, the head (first element) of this list.
| |||||||||||
Returns the element at the specified position in this list.
| |||||||||||
Returns the first element in this list.
| |||||||||||
Returns the last element in this list.
| |||||||||||
Returns the index of the first occurrence of the specified element
in this list, or -1 if this list does not contain the element.
| |||||||||||
Returns the index of the last occurrence of the specified element
in this list, or -1 if this list does not contain the element.
| |||||||||||
Returns a list-iterator of the elements in this list (in proper
sequence), starting at the specified position in the list.
| |||||||||||
Adds the specified element as the tail (last element) of this list.
| |||||||||||
Inserts the specified element at the front of this list.
| |||||||||||
Inserts the specified element at the end of this list.
| |||||||||||
Retrieves, but does not remove, the head (first element) of this list.
| |||||||||||
Retrieves, but does not remove, the first element of this list,
or returns null if this list is empty.
| |||||||||||
Retrieves, but does not remove, the last element of this list,
or returns null if this list is empty.
| |||||||||||
Retrieves and removes the head (first element) of this list
| |||||||||||
Retrieves and removes the first element of this list,
or returns null if this list is empty.
| |||||||||||
Retrieves and removes the last element of this list,
or returns null if this list is empty.
| |||||||||||
Pops an element from the stack represented by this list.
| |||||||||||
Pushes an element onto the stack represented by this list.
| |||||||||||
Retrieves and removes the head (first element) of this list.
| |||||||||||
Removes the element at the specified position in this list.
| |||||||||||
Removes the first occurrence of the specified element from this list,
if it is present.
| |||||||||||
Removes and returns the first element from this list.
| |||||||||||
Removes the first occurrence of the specified element in this
list (when traversing the list from head to tail).
| |||||||||||
Removes and returns the last element from this list.
| |||||||||||
Removes the last occurrence of the specified element in this
list (when traversing the list from head to tail).
| |||||||||||
Replaces the element at the specified position in this list with the
specified element.
| |||||||||||
Returns the number of elements in this list.
| |||||||||||
Returns an array containing all of the elements in this list in
proper sequence (from first to last element); the runtime type of
the returned array is that of the specified array.
| |||||||||||
Returns an array containing all of the elements in this list
in proper sequence (from first to last element).
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constructs an empty list.
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
c | the collection whose elements are to be placed into this list |
---|
NullPointerException | if the specified collection is null |
---|
Appends the specified element to the end of this list.
This method is equivalent to addLast(E)
.
e | element to be appended to this list |
---|
add(E)
)
Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
index | index at which the specified element is to be inserted |
---|---|
element | element to be inserted |
IndexOutOfBoundsException |
---|
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
c | collection containing elements to be added to this list |
---|
NullPointerException | if the specified collection is null |
---|
Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.
index | index at which to insert the first element from the specified collection |
---|---|
c | collection containing elements to be added to this list |
IndexOutOfBoundsException | |
---|---|
NullPointerException | if the specified collection is null |
Inserts the specified element at the beginning of this list.
e | the element to add |
---|
Appends the specified element to the end of this list.
This method is equivalent to add(E)
.
e | the element to add |
---|
Removes all of the elements from this list.
Returns a shallow copy of this LinkedList. (The elements themselves are not cloned.)
Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
o | element whose presence in this list is to be tested |
---|
Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
Retrieves, but does not remove, the head (first element) of this list.
NoSuchElementException | if this list is empty |
---|
Returns the element at the specified position in this list.
index | index of the element to return |
---|
IndexOutOfBoundsException |
---|
Returns the first element in this list.
NoSuchElementException | if this list is empty |
---|
Returns the last element in this list.
NoSuchElementException | if this list is empty |
---|
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
o | element to search for |
---|
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
o | element to search for |
---|
Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list. Obeys the general contract of List.listIterator(int).
The list-iterator is fail-fast: if the list is structurally modified at any time after the Iterator is created, in any way except through the list-iterator's own remove or add methods, the list-iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.
index | index of the first element to be returned from the list-iterator (by a call to next) |
---|
IndexOutOfBoundsException |
---|
Adds the specified element as the tail (last element) of this list.
e | the element to add |
---|
offer(E)
)Inserts the specified element at the front of this list.
e | the element to insert |
---|
offerFirst(E)
)Inserts the specified element at the end of this list.
e | the element to insert |
---|
offerLast(E)
)Retrieves, but does not remove, the head (first element) of this list.
Retrieves, but does not remove, the first element of this list, or returns null if this list is empty.
Retrieves, but does not remove, the last element of this list, or returns null if this list is empty.
Retrieves and removes the head (first element) of this list
Retrieves and removes the first element of this list, or returns null if this list is empty.
Retrieves and removes the last element of this list, or returns null if this list is empty.
Pops an element from the stack represented by this list. In other words, removes and returns the first element of this list.
This method is equivalent to removeFirst()
.
NoSuchElementException | if this list is empty |
---|
Pushes an element onto the stack represented by this list. In other words, inserts the element at the front of this list.
This method is equivalent to addFirst(E)
.
e | the element to push |
---|
Retrieves and removes the head (first element) of this list.
NoSuchElementException | if this list is empty |
---|
Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
index | the index of the element to be removed |
---|
IndexOutOfBoundsException |
---|
Removes the first occurrence of the specified element from this list, if it is present. If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
o | element to be removed from this list, if present |
---|
Removes and returns the first element from this list.
NoSuchElementException | if this list is empty |
---|
Removes the first occurrence of the specified element in this list (when traversing the list from head to tail). If the list does not contain the element, it is unchanged.
o | element to be removed from this list, if present |
---|
Removes and returns the last element from this list.
NoSuchElementException | if this list is empty |
---|
Removes the last occurrence of the specified element in this list (when traversing the list from head to tail). If the list does not contain the element, it is unchanged.
o | element to be removed from this list, if present |
---|
Replaces the element at the specified position in this list with the specified element.
index | index of the element to replace |
---|---|
element | element to be stored at the specified position |
IndexOutOfBoundsException |
---|
Returns the number of elements in this list.
Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.
If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)
Like the toArray()
method, this method acts as bridge between
array-based and collection-based APIs. Further, this method allows
precise control over the runtime type of the output array, and may,
under certain circumstances, be used to save allocation costs.
Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:
String[] y = x.toArray(new String[0]);Note that toArray(new Object[0]) is identical in function to toArray().
a | the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. |
---|
ArrayStoreException | if the runtime type of the specified array is not a supertype of the runtime type of every element in this list |
---|---|
NullPointerException | if the specified array is null |
Returns an array containing all of the elements in this list in proper sequence (from first to last element).
The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based APIs.