| java.lang.Object java.util.AbstractCollection java.util.AbstractList java.util.AbstractSequentialList java.util.LinkedList
LinkedList | public class LinkedList extends AbstractSequentialList implements List,Cloneable,java.io.Serializable(Code) | | 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 (deque).
All of the stack/queue/deque operations could be easily recast in terms of
the standard list operations. They're included here primarily for
convenience, though they may run slightly faster than the equivalent List
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 begining or the end, whichever is closer to the specified index.
Note that this implementation is not synchronized. If multiple
threads access a 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 the 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.
author: Josh Bloch version: 1.39, 10/10/06 See Also: List See Also: ArrayList See Also: Vector See Also: Collections.synchronizedList(List) since: 1.2 |
Constructor Summary | |
public | LinkedList() Constructs an empty list. | public | LinkedList(Collection c) Constructs a list containing the elements of the specified
collection, in the order they are returned by the collection's
iterator. |
Method Summary | |
public boolean | add(Object o) Appends the specified element to the end of this list.
Parameters: o - element to be appended to this list. | public void | add(int index, Object element) Inserts the specified element at the specified position in this list. | public boolean | addAll(Collection c) 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. | public boolean | addAll(int index, Collection c) Inserts all of the elements in the specified collection into this
list, starting at the specified position. | public void | addFirst(Object o) Inserts the given element at the beginning of this list. | public void | addLast(Object o) Appends the given element to the end of this list. | public void | clear() Removes all of the elements from this list. | public Object | clone() Returns a shallow copy of this LinkedList. | public boolean | contains(Object o) 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)).
Parameters: o - element whose presence in this list is to be tested. | public Object | get(int index) Returns the element at the specified position in this list.
Parameters: index - index of element to return. | public Object | getFirst() Returns the first element in this list. | public Object | getLast() Returns the last element in this list. | public int | indexOf(Object o) Returns the index in this list of the first occurrence of the
specified element, or -1 if the List does not contain this
element. | public int | lastIndexOf(Object o) Returns the index in this list of the last occurrence of the
specified element, or -1 if the list does not contain this
element. | public ListIterator | listIterator(int index) 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. | public boolean | remove(Object o) Removes the first occurrence of the specified element in this list. | public Object | remove(int index) Removes the element at the specified position in this list. | public Object | removeFirst() Removes and returns the first element from this list. | public Object | removeLast() Removes and returns the last element from this list. | public Object | set(int index, Object element) Replaces the element at the specified position in this list with the
specified element.
Parameters: index - index of element to replace. Parameters: element - element to be stored at the specified position. | public int | size() Returns the number of elements in this list. | public Object[] | toArray() Returns an array containing all of the elements in this list
in the correct order. | public Object[] | toArray(Object a) Returns an array containing all of the elements in this list in
the correct order; the runtime type of the returned array is that of
the specified array. |
LinkedList | public LinkedList()(Code) | | Constructs an empty list.
|
LinkedList | public LinkedList(Collection c)(Code) | | Constructs a list containing the elements of the specified
collection, in the order they are returned by the collection's
iterator.
Parameters: c - the collection whose elements are to be placed into this list. throws: NullPointerException - if the specified collection is null. |
add | public boolean add(Object o)(Code) | | Appends the specified element to the end of this list.
Parameters: o - element to be appended to this list. true (as per the general contract ofCollection.add). |
add | public void add(int index, Object element)(Code) | | 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).
Parameters: index - index at which the specified element is to be inserted. Parameters: element - element to be inserted. throws: IndexOutOfBoundsException - if the specified index is out ofrange (index < 0 || index > size()). |
addAll | public boolean addAll(Collection c)(Code) | | 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. (This implies that the behavior of this call is undefined if
the specified Collection is this list, and this list is nonempty.)
Parameters: c - the elements to be inserted into this list. true if this list changed as a result of the call. throws: NullPointerException - if the specified collection is null. |
addAll | public boolean addAll(int index, Collection c)(Code) | | 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.
Parameters: index - index at which to insert first elementfrom the specified collection. Parameters: c - elements to be inserted into this list. true if this list changed as a result of the call. throws: IndexOutOfBoundsException - if the specified index is out ofrange (index < 0 || index > size()). throws: NullPointerException - if the specified collection is null. |
addFirst | public void addFirst(Object o)(Code) | | Inserts the given element at the beginning of this list.
Parameters: o - the element to be inserted at the beginning of this list. |
addLast | public void addLast(Object o)(Code) | | Appends the given element to the end of this list. (Identical in
function to the add method; included only for consistency.)
Parameters: o - the element to be inserted at the end of this list. |
clear | public void clear()(Code) | | Removes all of the elements from this list.
|
clone | public Object clone()(Code) | | Returns a shallow copy of this LinkedList. (The elements
themselves are not cloned.)
a shallow copy of this LinkedList instance. |
contains | public boolean contains(Object o)(Code) | | 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)).
Parameters: o - element whose presence in this list is to be tested. true if this list contains the specified element. |
get | public Object get(int index)(Code) | | Returns the element at the specified position in this list.
Parameters: index - index of element to return. the element at the specified position in this list. throws: IndexOutOfBoundsException - if the specified index is is out ofrange (index < 0 || index >= size()). |
indexOf | public int indexOf(Object o)(Code) | | Returns the index in this list of the first occurrence of the
specified element, or -1 if the List does not contain this
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.
Parameters: o - element to search for. the index in this list of the first occurrence of thespecified element, or -1 if the list does not contain thiselement. |
lastIndexOf | public int lastIndexOf(Object o)(Code) | | Returns the index in this list of the last occurrence of the
specified element, or -1 if the list does not contain this
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.
Parameters: o - element to search for. the index in this list of the last occurrence of thespecified element, or -1 if the list does not contain thiselement. |
listIterator | public ListIterator listIterator(int index)(Code) | | 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.
Parameters: index - index of first element to be returned from thelist-iterator (by a call to next). a ListIterator of the elements in this list (in propersequence), starting at the specified position in the list. throws: IndexOutOfBoundsException - if index is out of range(index < 0 || index > size()). See Also: List.listIterator(int) |
remove | public boolean remove(Object o)(Code) | | Removes the first occurrence of the specified element in this list. If
the 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).
Parameters: o - element to be removed from this list, if present. true if the list contained the specified element. |
remove | public Object remove(int index)(Code) | | 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.
Parameters: index - the index of the element to removed. the element previously at the specified position. throws: IndexOutOfBoundsException - if the specified index is out ofrange (index < 0 || index >= size()). |
removeFirst | public Object removeFirst()(Code) | | Removes and returns the first element from this list.
the first element from this list. throws: NoSuchElementException - if this list is empty. |
removeLast | public Object removeLast()(Code) | | Removes and returns the last element from this list.
the last element from this list. throws: NoSuchElementException - if this list is empty. |
set | public Object set(int index, Object element)(Code) | | Replaces the element at the specified position in this list with the
specified element.
Parameters: index - index of element to replace. Parameters: element - element to be stored at the specified position. the element previously at the specified position. throws: IndexOutOfBoundsException - if the specified index is out ofrange (index < 0 || index >= size()). |
size | public int size()(Code) | | Returns the number of elements in this list.
the number of elements in this list. |
toArray | public Object[] toArray()(Code) | | Returns an array containing all of the elements in this list
in the correct order.
an array containing all of the elements in this listin the correct order. |
toArray | public Object[] toArray(Object a)(Code) | | Returns an array containing all of the elements in this list in
the correct order; 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
collection 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.
Parameters: a - the array into which the elements of the list are tobe stored, if it is big enough; otherwise, a new array of thesame runtime type is allocated for this purpose. an array containing the elements of the list. throws: ArrayStoreException - if the runtime type of a is not asupertype of the runtime type of every element in this list. throws: NullPointerException - if the specified array is null. |
Fields inherited from java.util.AbstractList | protected transient int modCount(Code)(Java Doc)
|
|
|