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、