FileDocCategorySizeDatePackage
LinkedList.javaAPI DocJava SE 6 API30978Tue Jun 10 00:25:54 BST 2008java.util

LinkedList

public class LinkedList extends AbstractSequentialList implements List, Cloneable, Deque, Serializable
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, {@linkplain Queue queue}, or {@linkplain Deque 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 {@link Collections#synchronizedList 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 {@link 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.67, 04/21/06
see
List
see
ArrayList
see
Vector
since
1.2
param
the type of elements held in this collection

Fields Summary
private transient Entry
header
private transient int
size
private static final long
serialVersionUID
Constructors Summary
public LinkedList()
Constructs an empty list.


             
      
        header.next = header.previous = header;
    
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.

param
c the collection whose elements are to be placed into this list
throws
NullPointerException if the specified collection is null

	this();
	addAll(c);
    
Methods Summary
public booleanadd(E e)
Appends the specified element to the end of this list.

This method is equivalent to {@link #addLast}.

param
e element to be appended to this list
return
true (as specified by {@link Collection#add})

	addBefore(e, header);
        return true;
    
public voidadd(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).

param
index index at which the specified element is to be inserted
param
element element to be inserted
throws
IndexOutOfBoundsException {@inheritDoc}

        addBefore(element, (index==size ? header : entry(index)));
    
public booleanaddAll(java.util.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. 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.)

param
c collection containing elements to be added to this list
return
true if this list changed as a result of the call
throws
NullPointerException if the specified collection is null

        return addAll(size, c);
    
public booleanaddAll(int index, java.util.Collection 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.

param
index index at which to insert the first element from the specified collection
param
c collection containing elements to be added to this list
return
true if this list changed as a result of the call
throws
IndexOutOfBoundsException {@inheritDoc}
throws
NullPointerException if the specified collection is null

        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index+
                                                ", Size: "+size);
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew==0)
            return false;
	modCount++;

        Entry<E> successor = (index==size ? header : entry(index));
        Entry<E> predecessor = successor.previous;
	for (int i=0; i<numNew; i++) {
            Entry<E> e = new Entry<E>((E)a[i], successor, predecessor);
            predecessor.next = e;
            predecessor = e;
        }
        successor.previous = predecessor;

        size += numNew;
        return true;
    
private java.util.LinkedList$EntryaddBefore(E e, java.util.LinkedList$Entry entry)

	Entry<E> newEntry = new Entry<E>(e, entry, entry.previous);
	newEntry.previous.next = newEntry;
	newEntry.next.previous = newEntry;
	size++;
	modCount++;
	return newEntry;
    
public voidaddFirst(E e)
Inserts the specified element at the beginning of this list.

param
e the element to add

	addBefore(e, header.next);
    
public voidaddLast(E e)
Appends the specified element to the end of this list.

This method is equivalent to {@link #add}.

param
e the element to add

	addBefore(e, header);
    
public voidclear()
Removes all of the elements from this list.

        Entry<E> e = header.next;
        while (e != header) {
            Entry<E> next = e.next;
            e.next = e.previous = null;
            e.element = null;
            e = next;
        }
        header.next = header.previous = header;
        size = 0;
	modCount++;
    
public java.lang.Objectclone()
Returns a shallow copy of this LinkedList. (The elements themselves are not cloned.)

return
a shallow copy of this LinkedList instance

        LinkedList<E> clone = null;
	try {
	    clone = (LinkedList<E>) super.clone();
	} catch (CloneNotSupportedException e) {
	    throw new InternalError();
	}

        // Put clone into "virgin" state
        clone.header = new Entry<E>(null, null, null);
        clone.header.next = clone.header.previous = clone.header;
        clone.size = 0;
        clone.modCount = 0;

        // Initialize clone with our elements
        for (Entry<E> e = header.next; e != header; e = e.next)
            clone.add(e.element);

        return clone;
    
public booleancontains(java.lang.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)).

param
o element whose presence in this list is to be tested
return
true if this list contains the specified element

        return indexOf(o) != -1;
    
public java.util.IteratordescendingIterator()

since
1.6

        return new DescendingIterator();
    
public Eelement()
Retrieves, but does not remove, the head (first element) of this list.

return
the head of this list
throws
NoSuchElementException if this list is empty
since
1.5

        return getFirst();
    
private java.util.LinkedList$Entryentry(int index)
Returns the indexed entry.

        if (index < 0 || index >= size)
            throw new IndexOutOfBoundsException("Index: "+index+
                                                ", Size: "+size);
        Entry<E> e = header;
        if (index < (size >> 1)) {
            for (int i = 0; i <= index; i++)
                e = e.next;
        } else {
            for (int i = size; i > index; i--)
                e = e.previous;
        }
        return e;
    
public Eget(int index)
Returns the element at the specified position in this list.

param
index index of the element to return
return
the element at the specified position in this list
throws
IndexOutOfBoundsException {@inheritDoc}

        return entry(index).element;
    
public EgetFirst()
Returns the first element in this list.

return
the first element in this list
throws
NoSuchElementException if this list is empty

	if (size==0)
	    throw new NoSuchElementException();

	return header.next.element;
    
public EgetLast()
Returns the last element in this list.

return
the last element in this list
throws
NoSuchElementException if this list is empty

	if (size==0)
	    throw new NoSuchElementException();

	return header.previous.element;
    
public intindexOf(java.lang.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.

param
o element to search for
return
the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

        int index = 0;
        if (o==null) {
            for (Entry e = header.next; e != header; e = e.next) {
                if (e.element==null)
                    return index;
                index++;
            }
        } else {
            for (Entry e = header.next; e != header; e = e.next) {
                if (o.equals(e.element))
                    return index;
                index++;
            }
        }
        return -1;
    
public intlastIndexOf(java.lang.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.

param
o element to search for
return
the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

        int index = size;
        if (o==null) {
            for (Entry e = header.previous; e != header; e = e.previous) {
                index--;
                if (e.element==null)
                    return index;
            }
        } else {
            for (Entry e = header.previous; e != header; e = e.previous) {
                index--;
                if (o.equals(e.element))
                    return index;
            }
        }
        return -1;
    
public java.util.ListIteratorlistIterator(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.

param
index index of the first element to be returned from the list-iterator (by a call to next)
return
a ListIterator of the elements in this list (in proper sequence), starting at the specified position in the list
throws
IndexOutOfBoundsException {@inheritDoc}
see
List#listIterator(int)

	return new ListItr(index);
    
public booleanoffer(E e)
Adds the specified element as the tail (last element) of this list.

param
e the element to add
return
true (as specified by {@link Queue#offer})
since
1.5

        return add(e);
    
public booleanofferFirst(E e)
Inserts the specified element at the front of this list.

param
e the element to insert
return
true (as specified by {@link Deque#offerFirst})
since
1.6

        addFirst(e);
        return true;
    
public booleanofferLast(E e)
Inserts the specified element at the end of this list.

param
e the element to insert
return
true (as specified by {@link Deque#offerLast})
since
1.6

        addLast(e);
        return true;
    
public Epeek()
Retrieves, but does not remove, the head (first element) of this list.

return
the head of this list, or null if this list is empty
since
1.5

        if (size==0)
            return null;
        return getFirst();
    
public EpeekFirst()
Retrieves, but does not remove, the first element of this list, or returns null if this list is empty.

return
the first element of this list, or null if this list is empty
since
1.6

        if (size==0)
            return null;
        return getFirst();
    
public EpeekLast()
Retrieves, but does not remove, the last element of this list, or returns null if this list is empty.

return
the last element of this list, or null if this list is empty
since
1.6

        if (size==0)
            return null;
        return getLast();
    
public Epoll()
Retrieves and removes the head (first element) of this list

return
the head of this list, or null if this list is empty
since
1.5

        if (size==0)
            return null;
        return removeFirst();
    
public EpollFirst()
Retrieves and removes the first element of this list, or returns null if this list is empty.

return
the first element of this list, or null if this list is empty
since
1.6

        if (size==0)
            return null;
        return removeFirst();
    
public EpollLast()
Retrieves and removes the last element of this list, or returns null if this list is empty.

return
the last element of this list, or null if this list is empty
since
1.6

        if (size==0)
            return null;
        return removeLast();
    
public Epop()
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 {@link #removeFirst()}.

return
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
since
1.6

        return removeFirst();
    
public voidpush(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 {@link #addFirst}.

param
e the element to push
since
1.6

        addFirst(e);
    
private voidreadObject(java.io.ObjectInputStream s)
Reconstitute this LinkedList instance from a stream (that is deserialize it).

	// Read in any hidden serialization magic
	s.defaultReadObject();

        // Read in size
        int size = s.readInt();

        // Initialize header
        header = new Entry<E>(null, null, null);
        header.next = header.previous = header;

	// Read in all elements in the proper order.
	for (int i=0; i<size; i++)
            addBefore((E)s.readObject(), header);
    
public booleanremove(java.lang.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).

param
o element to be removed from this list, if present
return
true if this list contained the specified element

        if (o==null) {
            for (Entry<E> e = header.next; e != header; e = e.next) {
                if (e.element==null) {
                    remove(e);
                    return true;
                }
            }
        } else {
            for (Entry<E> e = header.next; e != header; e = e.next) {
                if (o.equals(e.element)) {
                    remove(e);
                    return true;
                }
            }
        }
        return false;
    
public Eremove(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.

param
index the index of the element to be removed
return
the element previously at the specified position
throws
IndexOutOfBoundsException {@inheritDoc}

        return remove(entry(index));
    
public Eremove()
Retrieves and removes the head (first element) of this list.

return
the head of this list
throws
NoSuchElementException if this list is empty
since
1.5

        return removeFirst();
    
private Eremove(java.util.LinkedList$Entry e)

	if (e == header)
	    throw new NoSuchElementException();

        E result = e.element;
	e.previous.next = e.next;
	e.next.previous = e.previous;
        e.next = e.previous = null;
        e.element = null;
	size--;
	modCount++;
        return result;
    
public EremoveFirst()
Removes and returns the first element from this list.

return
the first element from this list
throws
NoSuchElementException if this list is empty

	return remove(header.next);
    
public booleanremoveFirstOccurrence(java.lang.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.

param
o element to be removed from this list, if present
return
true if the list contained the specified element
since
1.6

        return remove(o);
    
public EremoveLast()
Removes and returns the last element from this list.

return
the last element from this list
throws
NoSuchElementException if this list is empty

	return remove(header.previous);
    
public booleanremoveLastOccurrence(java.lang.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.

param
o element to be removed from this list, if present
return
true if the list contained the specified element
since
1.6

        if (o==null) {
            for (Entry<E> e = header.previous; e != header; e = e.previous) {
                if (e.element==null) {
                    remove(e);
                    return true;
                }
            }
        } else {
            for (Entry<E> e = header.previous; e != header; e = e.previous) {
                if (o.equals(e.element)) {
                    remove(e);
                    return true;
                }
            }
        }
        return false;
    
public Eset(int index, E element)
Replaces the element at the specified position in this list with the specified element.

param
index index of the element to replace
param
element element to be stored at the specified position
return
the element previously at the specified position
throws
IndexOutOfBoundsException {@inheritDoc}

        Entry<E> e = entry(index);
        E oldVal = e.element;
        e.element = element;
        return oldVal;
    
public intsize()
Returns the number of elements in this list.

return
the number of elements in this list

	return size;
    
public java.lang.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.

return
an array containing all of the elements in this list in proper sequence

	Object[] result = new Object[size];
        int i = 0;
        for (Entry<E> e = header.next; e != header; e = e.next)
            result[i++] = e.element;
	return result;
    
public 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 {@link #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().

param
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.
return
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
throws
NullPointerException if the specified array is null

        if (a.length < size)
            a = (T[])java.lang.reflect.Array.newInstance(
                                a.getClass().getComponentType(), size);
        int i = 0;
	Object[] result = a;
        for (Entry<E> e = header.next; e != header; e = e.next)
            result[i++] = e.element;

        if (a.length > size)
            a[size] = null;

        return a;
    
private voidwriteObject(java.io.ObjectOutputStream s)
Save the state of this LinkedList instance to a stream (that is, serialize it).

serialData
The size of the list (the number of elements it contains) is emitted (int), followed by all of its elements (each an Object) in the proper order.


                                                                           
       
          
	// Write out any hidden serialization magic
	s.defaultWriteObject();

        // Write out size
        s.writeInt(size);

	// Write out all elements in the proper order.
        for (Entry e = header.next; e != header; e = e.next)
            s.writeObject(e.element);