LinkedList

一、定義

（一）概要

    List接口的雙向循環鏈接列表實現（JDK1.6.0_20）。實現所有可選的列表操作，並且允許所有元素（包括 null）。除了實現 List 接口外，還實現了Deque接口，LinkedList 類還爲在列表的開頭及結尾 get、remove 和 insert 元素提供了統一的命名方法，這些操作允許將鏈接列表用作堆棧、隊列或雙端隊列。

（二）繼承關係

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

// 所有實現的接口
Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>

（三）類圖

二、常用方法

（一）構造函數

// 構造一個空列表
LinkedList() 

// 構造一個包含指定 collection 中的元素的列表，這些元素按其 collection 的迭代器返回的順序排列。
LinkedList(Collection<? extends E> c) 

（二）方法

// 將指定元素添加到此列表的結尾。
boolean	add(E e) 

// 在此列表中指定的位置插入指定的元素。
void add(int index, E element)

// 添加指定 collection 中的所有元素到此列表的結尾，順序是指定 collection 的迭代器返回這些元素的順序。
boolean addAll(Collection<? extends E> c) 

// 將指定 collection 中的所有元素從指定位置開始插入此列表。
boolean	addAll(int index, Collection<? extends E> c) 

// 將指定元素插入此列表的開頭。
void addFirst(E e) 

// 將指定元素添加到此列表的結尾。
void addLast(E e) 

// 從此列表中移除所有元素。
void clear() 

// 返回此 LinkedList 的淺表副本。
Object clone()

// 如果此列表包含指定元素，則返回 true。
boolean	contains(Object o)

// 返回以逆向順序在此雙端隊列的元素上進行迭代的迭代器。
Iterator<E> descendingIterator()  

// 獲取但不移除此列表的頭（第一個元素）。
E element() 

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

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

// 返回此列表的第一個元素。
E getFirst() 

// 返回此列表的最後一個元素。
E getLast()

// 返回此列表中首次出現的指定元素的索引，如果此列表中不包含該元素，則返回 -1。
int indexOf(Object o)

// 返回此列表中最後出現的指定元素的索引，如果此列表中不包含該元素，則返回 -1。
int lastIndexOf(Object o) 

// 返回此列表中的元素的列表迭代器（按適當順序），從列表中指定位置開始。
ListIterator<E>	listIterator(int index)

//  將指定元素添加到此列表的末尾（最後一個元素）。
boolean	offer(E e) 

// 在此列表的開頭插入指定的元素。
boolean	offerFirst(E e)

// 在此列表末尾插入指定的元素。
boolean	offerLast(E e) 

// 獲取但不移除此列表的頭（第一個元素）。
E peek() 

// 獲取但不移除此列表的第一個元素；如果此列表爲空，則返回 null。
E peekFirst()

// 獲取但不移除此列表的最後一個元素；如果此列表爲空，則返回 null。
E peekLast()

// 獲取並移除此列表的頭（第一個元素）
E poll()

// 獲取並移除此列表的第一個元素；如果此列表爲空，則返回 null。
E pollFirst()

// 獲取並移除此列表的最後一個元素；如果此列表爲空，則返回 null。
E pollLast()

// 從此列表所表示的堆棧處彈出一個元素。
E pop() 

// 將元素推入此列表所表示的堆棧。
void push(E e) 

// 獲取並移除此列表的頭（第一個元素）。
E remove()

// 移除此列表中指定位置處的元素。
E remove(int index)

// 從此列表中移除首次出現的指定元素（如果存在）
boolean	remove(Object o)

// 移除並返回此列表的第一個元素
E removeFirst()

// 從此列表中移除第一次出現的指定元素（從頭部到尾部遍歷列表時）。
boolean	removeFirstOccurrence(Object o) 

// 移除並返回此列表的最後一個元素。
E removeLast()

// 從此列表中移除最後一次出現的指定元素（從頭部到尾部遍歷列表時）。
boolean	removeLastOccurrence(Object o) 

// 將此列表中指定位置的元素替換爲指定的元素。
E set(int index, E element)

// 返回此列表的元素數。
int size()

// 返回以適當順序（從第一個元素到最後一個元素）包含此列表中所有元素的數組。
Object[] toArray()

// 返回以適當順序（從第一個元素到最後一個元素）包含此列表中所有元素的數組；返回數組的運行時類型爲指定數組的類型。
<T> T[]	toArray(T[] a) 

三、源碼

（一）成員變量和內部類

// 定義空的頭元素
private transient Entry<E> header = new Entry<E>(null, null, null);

// 序列化版本ID
private static final long serialVersionUID = 876323262645176354L;

// 定義鏈表元素個數
private transient int size = 0;

// 定義一個內部類
private static class Entry<E> {
    // 本節點value
    E element;
    // 下一個節點
    Entry<E> next;
    // 上一個節點
    Entry<E> previous;
    // 構造方法
    Entry(E element, Entry<E> next, Entry<E> previous) {
        this.element = element;
        this.next = next;
        this.previous = previous;
    }
}

（二）構造函數

// 一個空的列表，無任何元素
public LinkedList() {
    header.next = header.previous = header;
}

// 構造一個包含指定 collection 中的元素的列表，這些元素按其 collection 的迭代器返回的順序排列。
public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

（三）增加元素

// 獲取指定位置節點
private Entry<E> entry(int index) {
    // 當指定位置小於0或者大於列表節點個數則拋出索引超出邊界異常
    if (index < 0 || index >= size) {
        throw new IndexOutOfBoundsException("Index: "+index+", Size: "+size);
    }
    
    // 從頭節點開始遍歷
    Entry<E> e = header;
    
    // 位運算二進制數向右移動一位（size/2）
    if (index < (size >> 1)) { // 如果指定位置小於列表的1/2則重頭節點開始遍歷
         for (int i = 0; i <= index; i++){
             e = e.next;
         }
             
    } else {
        for (int i = size; i > index; i--) { // 如果指定位置大於列表的1/2則重頭節點開始遍歷
            e = e.previous;
        }               
    }

    return e;
}

// 將指定元素添加到指定節點之前
private Entry<E> addBefore(E e, Entry<E> entry) {
    // 新增一個節點，此節點的下一個節點爲指定節點，上一個節點爲指定節點的上一個節點
    Entry<E> newEntry = new Entry<E>(e, entry, entry.previous);
    // 將新增節點的上一個節點的next屬性設置爲新增節點
    newEntry.previous.next = newEntry;
    // 將新增節點的下一個節點的previous屬性設置爲新增節點
    newEntry.next.previous = newEntry;
    size++; // 列表元素個數累加1
    modCount++; // 列表修改次數累加1

    return newEntry; //返回新增節點
}

// 將指定元素添加在列表的頭部（頭節點和第一個節點之間）
public void addFirst(E e) {
    addBefore(e, header.next);
}

// 將指定元素添加在列表的尾部（最後一個節點和頭節點之間）
public void addLast(E e) {
    addBefore(e, header);
}

// 將指定元素添加在列表的尾部
public boolean add(E e) {
    addBefore(e, header);

    return true;
}

// 添加指定 collection 中的所有元素到此列表的結尾，順序是指定 collection 的迭代器返回這些元素的順序。
public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

// 將指定 collection 中的所有元素從指定位置開始插入此列表。
public boolean addAll(int index, Collection<? extends E> c) {
    // 如果指定的位置小於0或者大於列表節點個數則拋出索引超出邊界異常
    if (index < 0 || index > size) {
            throw new IndexOutOfBoundsException("Index: "+index+", Size: "+size);
    }

    // 將集合轉成數組
    Object[] a = c.toArray();
    // 新增節點個數
    int numNew = a.length;

    // 如果傳入collection元素個數爲0則返回false
    if (numNew == 0) {
        return false;
    }
    
    modCount++; // 列表修改次數加1
    // 獲取新增節點下一個元素的位置
    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);
        // 將上一個節點的next屬性設置爲新增節點
        predecessor.next = e;
        // 以後新增節點的上一個節點發生改變
        predecessor = e;
    }
    
    // 指定位置節點的previous屬性設置爲最後新增的一個節點
    successor.previous = predecessor;

    size += numNew; // 列表個數增加

    return true;
}

// 在指定元素添加到列表的指定位置
public void add(int index, E element) {
    addBefore(element, (index==size ? header : entry(index)));
}

（四）刪除元素

（五）查找元素

（六）其他

四、總結

1.

2.

3.

4.

5、