Skip to content

Most visited

Recently visited

navigation
Added in API level 1

LinkedList

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

java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ java.util.AbstractList<E>
       ↳ java.util.AbstractSequentialList<E>
         ↳ java.util.LinkedList<E>


Doubly-linked list implementation of the List and Deque interfaces. Implements all optional list operations, and permits all elements (including null).

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.

See also:

Summary

Inherited fields

From class java.util.AbstractList

Public constructors

LinkedList()

Constructs an empty list.

LinkedList(Collection<? extends E> c)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Public methods

boolean add(E e)

Appends the specified element to the end of this list.

void add(int index, E element)

Inserts the specified element at the specified position in this list.

boolean addAll(Collection<? extends E> 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.

boolean addAll(int index, Collection<? extends E> c)

Inserts all of the elements in the specified collection into this list, starting at the specified position.

void addFirst(E e)

Inserts the specified element at the beginning of this list.

void addLast(E e)

Appends the specified element to the end of this list.

void clear()

Removes all of the elements from this list.

Object clone()

Returns a shallow copy of this LinkedList.

boolean contains(Object o)

Returns true if this list contains the specified element.

Iterator<E> descendingIterator()

Returns an iterator over the elements in this deque in reverse sequential order.

E element()

Retrieves, but does not remove, the head (first element) of this list.

E get(int index)

Returns the element at the specified position in this list.

E getFirst()

Returns the first element in this list.

E getLast()

Returns the last element in this list.

int indexOf(Object o)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

int lastIndexOf(Object o)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

ListIterator<E> listIterator(int index)

Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list.

boolean offer(E e)

Adds the specified element as the tail (last element) of this list.

boolean offerFirst(E e)

Inserts the specified element at the front of this list.

boolean offerLast(E e)

Inserts the specified element at the end of this list.

E peek()

Retrieves, but does not remove, the head (first element) of this list.

E peekFirst()

Retrieves, but does not remove, the first element of this list, or returns null if this list is empty.

E peekLast()

Retrieves, but does not remove, the last element of this list, or returns null if this list is empty.

E poll()

Retrieves and removes the head (first element) of this list.

E pollFirst()

Retrieves and removes the first element of this list, or returns null if this list is empty.

E pollLast()

Retrieves and removes the last element of this list, or returns null if this list is empty.

E pop()

Pops an element from the stack represented by this list.

void push(E e)

Pushes an element onto the stack represented by this list.

E remove(int index)

Removes the element at the specified position in this list.

E remove()

Retrieves and removes the head (first element) of this list.

boolean remove(Object o)

Removes the first occurrence of the specified element from this list, if it is present.

E removeFirst()

Removes and returns the first element from this list.

boolean removeFirstOccurrence(Object o)

Removes the first occurrence of the specified element in this list (when traversing the list from head to tail).

E removeLast()

Removes and returns the last element from this list.

boolean removeLastOccurrence(Object o)

Removes the last occurrence of the specified element in this list (when traversing the list from head to tail).

E set(int index, E element)

Replaces the element at the specified position in this list with the specified element.

int size()

Returns the number of elements in this list.

Spliterator<E> spliterator()

Creates a late-binding and fail-fast Spliterator over the elements in this list.

Object[] toArray()

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

<T> T[] toArray(T[] a)

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.

Inherited methods

From class java.util.AbstractSequentialList
From class java.util.AbstractList
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.util.List
From interface java.util.Collection
From interface java.util.Deque
From interface java.lang.Iterable
From interface java.util.Queue

Public constructors

LinkedList

Added in API level 1
LinkedList ()

Constructs an empty list.

LinkedList

Added in API level 1
LinkedList (Collection<? extends E> c)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters
c Collection: the collection whose elements are to be placed into this list
Throws
NullPointerException if the specified collection is null

Public methods

add

Added in API level 1
boolean add (E e)

Appends the specified element to the end of this list.

This method is equivalent to addLast(E).

Parameters
e E: element to be appended to this list
Returns
boolean true (as specified by add(E))

add

Added in API level 1
void add (int index, 
                E element)

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 int: index at which the specified element is to be inserted
element E: element to be inserted
Throws
IndexOutOfBoundsException

addAll

Added in API level 1
boolean addAll (Collection<? extends E> 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. 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.)

Parameters
c Collection: collection containing elements to be added to this list
Returns
boolean true if this list changed as a result of the call
Throws
NullPointerException if the specified collection is null

addAll

Added in API level 1
boolean addAll (int index, 
                Collection<? extends E> c)

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 int: index at which to insert the first element from the specified collection
c Collection: collection containing elements to be added to this list
Returns
boolean true if this list changed as a result of the call
Throws
IndexOutOfBoundsException
NullPointerException if the specified collection is null

addFirst

Added in API level 1
void addFirst (E e)

Inserts the specified element at the beginning of this list.

Parameters
e E: the element to add

addLast

Added in API level 1
void addLast (E e)

Appends the specified element to the end of this list.

This method is equivalent to add(E).

Parameters
e E: the element to add

clear

Added in API level 1
void clear ()

Removes all of the elements from this list. The list will be empty after this call returns.

clone

Added in API level 1
Object clone ()

Returns a shallow copy of this LinkedList. (The elements themselves are not cloned.)

Returns
Object a shallow copy of this LinkedList instance

contains

Added in API level 1
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 Object: element whose presence in this list is to be tested
Returns
boolean true if this list contains the specified element

descendingIterator

Added in API level 9
Iterator<E> descendingIterator ()

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).

Returns
Iterator<E> an iterator over the elements in this deque in reverse sequence

element

Added in API level 1
E element ()

Retrieves, but does not remove, the head (first element) of this list.

Returns
E the head of this list
Throws
NoSuchElementException if this list is empty

get

Added in API level 1
E get (int index)

Returns the element at the specified position in this list.

Parameters
index int: index of the element to return
Returns
E the element at the specified position in this list
Throws
IndexOutOfBoundsException

getFirst

Added in API level 1
E getFirst ()

Returns the first element in this list.

Returns
E the first element in this list
Throws
NoSuchElementException if this list is empty

getLast

Added in API level 1
E getLast ()

Returns the last element in this list.

Returns
E the last element in this list
Throws
NoSuchElementException if this list is empty

indexOf

Added in API level 1
int indexOf (Object o)

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.

Parameters
o Object: element to search for
Returns
int the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

lastIndexOf

Added in API level 1
int lastIndexOf (Object o)

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.

Parameters
o Object: element to search for
Returns
int the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

listIterator

Added in API level 1
ListIterator<E> 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. 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 int: index of the first element to be returned from the list-iterator (by a call to next)
Returns
ListIterator<E> a ListIterator of the elements in this list (in proper sequence), starting at the specified position in the list
Throws
IndexOutOfBoundsException

See also:

offer

Added in API level 1
boolean offer (E e)

Adds the specified element as the tail (last element) of this list.

Parameters
e E: the element to add
Returns
boolean true (as specified by offer(E))

offerFirst

Added in API level 9
boolean offerFirst (E e)

Inserts the specified element at the front of this list.

Parameters
e E: the element to insert
Returns
boolean true (as specified by offerFirst(E))

offerLast

Added in API level 9
boolean offerLast (E e)

Inserts the specified element at the end of this list.

Parameters
e E: the element to insert
Returns
boolean true (as specified by offerLast(E))

peek

Added in API level 1
E peek ()

Retrieves, but does not remove, the head (first element) of this list.

Returns
E the head of this list, or null if this list is empty

peekFirst

Added in API level 9
E peekFirst ()

Retrieves, but does not remove, the first element of this list, or returns null if this list is empty.

Returns
E the first element of this list, or null if this list is empty

peekLast

Added in API level 9
E peekLast ()

Retrieves, but does not remove, the last element of this list, or returns null if this list is empty.

Returns
E the last element of this list, or null if this list is empty

poll

Added in API level 1
E poll ()

Retrieves and removes the head (first element) of this list.

Returns
E the head of this list, or null if this list is empty

pollFirst

Added in API level 9
E pollFirst ()

Retrieves and removes the first element of this list, or returns null if this list is empty.

Returns
E the first element of this list, or null if this list is empty

pollLast

Added in API level 9
E pollLast ()

Retrieves and removes the last element of this list, or returns null if this list is empty.

Returns
E the last element of this list, or null if this list is empty

pop

Added in API level 9
E pop ()

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().

Returns
E the element at the front of this list (which is the top of the stack represented by this list)
Throws
NoSuchElementException if this list is empty

push

Added in API level 9
void push (E e)

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).

Parameters
e E: the element to push

remove

Added in API level 1
E remove (int index)

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 int: the index of the element to be removed
Returns
E the element previously at the specified position
Throws
IndexOutOfBoundsException

remove

Added in API level 1
E remove ()

Retrieves and removes the head (first element) of this list.

Returns
E the head of this list
Throws
NoSuchElementException if this list is empty

remove

Added in API level 1
boolean remove (Object o)

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).

Parameters
o Object: element to be removed from this list, if present
Returns
boolean true if this list contained the specified element

removeFirst

Added in API level 1
E removeFirst ()

Removes and returns the first element from this list.

Returns
E the first element from this list
Throws
NoSuchElementException if this list is empty

removeFirstOccurrence

Added in API level 9
boolean removeFirstOccurrence (Object o)

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.

Parameters
o Object: element to be removed from this list, if present
Returns
boolean true if the list contained the specified element

removeLast

Added in API level 1
E removeLast ()

Removes and returns the last element from this list.

Returns
E the last element from this list
Throws
NoSuchElementException if this list is empty

removeLastOccurrence

Added in API level 9
boolean removeLastOccurrence (Object o)

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.

Parameters
o Object: element to be removed from this list, if present
Returns
boolean true if the list contained the specified element

set

Added in API level 1
E set (int index, 
                E element)

Replaces the element at the specified position in this list with the specified element.

Parameters
index int: index of the element to replace
element E: element to be stored at the specified position
Returns
E the element previously at the specified position
Throws
IndexOutOfBoundsException

size

Added in API level 1
int size ()

Returns the number of elements in this list.

Returns
int the number of elements in this list

spliterator

Added in API level 24
Spliterator<E> spliterator ()

Creates a late-binding and fail-fast Spliterator over the elements in this list.

The Spliterator reports SIZED and ORDERED. Overriding implementations should document the reporting of additional characteristic values.

Implementation Note:
  • The Spliterator additionally reports SUBSIZED and implements trySplit to permit limited parallelism..
Returns
Spliterator<E> a Spliterator over the elements in this list

toArray

Added in API level 1
Object[] toArray ()

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.

Returns
Object[] an array containing all of the elements in this list in proper sequence

toArray

Added in API level 1
T[] toArray (T[] a)

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().

Parameters
a T: 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.
Returns
T[] an array containing the elements of the list
Throws
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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.