JDK学习笔记之LinkedList

LinkedList实现了List和Deque接口，是一个双端队列，可以存放null元素，实现了List说明支持随机访问（底层是链表，所以复杂度不是常数级别），实现Deque说明可以当做栈或者队列使用，是一个功能性很强的数据结构。

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

transient int size = 0;
transient Node<E> first;
transient Node<E> last;

底层即基于链表的，提供一个首节点和尾节点。

private static class Node<E> {
    E item;
    Node<E> next;
    Node<E> prev;

    Node(Node<E> prev, E element, Node<E> next) {
        this.item = element;
        this.next = next;
        this.prev = prev;
    }
}

节点是LinkedList自己定义的内部类

public LinkedList() {
}

无参构造器。

public LinkedList(Collection<? extends E> c) {
    this();
    addAll(c);
}

传入集合的构造器。

private void linkFirst(E e) {
    //存储原来的首节点
    final Node<E> f = first;
    //新建一个节点，跌点的next是原来的首节点f
    final Node<E> newNode = new Node<>(null, e, f);
    //新节点置为first首节点
    first = newNode;
    //如果当前链表只有一个节点
    if (f == null)
        //首节点和尾节点都置为newNode
        last = newNode;
    else
    	//f前驱置为newNode
        f.prev = newNode;
    //元素个数加一
    size++;
    modCount++;
}

在头部插入一个节点。

Node(Node<E> prev, E element, Node<E> next) {
    this.item = element;
    this.next = next;
    this.prev = prev;
}

Node的构造函数之一，设置了前驱和后继节点。

void linkLast(E e) {
    final Node<E> l = last;
    final Node<E> newNode = new Node<>(l, e, null);
    last = newNode;
    if (l == null)
        first = newNode;
    else
        l.next = newNode;
    size++;
    modCount++;
}

插入尾节点，和插入头节点类似。

void linkBefore(E e, Node<E> succ) {
    // assert succ != null;
    //取出目标节点的前驱
    final Node<E> pred = succ.prev;
    //新建一个节点，前驱和后继分别指向pred和succ
    final Node<E> newNode = new Node<>(pred, e, succ);
    //新节点置为succ的前驱
    succ.prev = newNode;
    if (pred == null)
        first = newNode;
    else
        pred.next = newNode;
    size++;
    modCount++;
}

在某个节点之前插入一个节点。

private E unlinkFirst(Node<E> f) {
    // assert f == first && f != null;
    final E element = f.item;
    final Node<E> next = f.next;
    f.item = null;
    f.next = null; // help GC
    first = next;
    if (next == null)
        last = null;
    else
        next.prev = null;
    size--;
    modCount++;
    return element;
}

断开链表，移除；目标节点及之前的节点。

private E unlinkLast(Node<E> l) {
    // assert l == last && l != null;
    final E element = l.item;
    final Node<E> prev = l.prev;
    l.item = null;
    l.prev = null; // help GC
    last = prev;
    if (prev == null)
        first = null;
    else
        prev.next = null;
    size--;
    modCount++;
    return element;
}

断开链表，移除目标节点及目标节点之前的节点。

E unlink(Node<E> x) {
    // assert x != null;
    final E element = x.item;
    final Node<E> next = x.next;
    final Node<E> prev = x.prev;

    if (prev == null) {
        first = next;
    } else {
        prev.next = next;
        x.prev = null;
    }

    if (next == null) {
        last = prev;
    } else {
        next.prev = prev;
        x.next = null;
    }

    x.item = null;
    size--;
    modCount++;
    return element;
}

断开某个节点，返回节点中存储的元素。

public E getFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return f.item;
}

返回首节点存储的元素。

public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

移除首节点

public void addFirst(E e) {
    linkFirst(e);
}

在首部插入节点

public void addLast(E e) {
    linkLast(e);
}

在尾部插入节点

public boolean contains(Object o) {
    return indexOf(o) != -1;
}

查看是否存在某个节点

public int indexOf(Object o) {
    int index = 0;
    if (o == null) {
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null)
                return index;
            index++;
        }
    } else {
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item))
                return index;
            index++;
        }
    }
    return -1;
}

获取某个节点的下标，可以看出来底层无法实现随机访问，而是遍历一次链表的O（n）复杂度。

public int size() {
    return size;
}

返回链表节点数目。

public boolean add(E e) {
    linkLast(e);
    return true;
}

默认的添加方式是添加到尾部。

public boolean remove(Object o) {
    if (o == null) {
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

移除某个节点，从头到尾遍历，只删除一个节点。

public boolean addAll(Collection<? extends E> c) {
    return addAll(size, c);
}

把某个元素全部添加到链表中，从尾部添加。

public boolean addAll(int index, Collection<? extends E> c) {
    checkPositionIndex(index);
	//集合转换为Object数组。
    Object[] a = c.toArray();
    int numNew = a.length;
    if (numNew == 0)
        return false;
    //插入的位置可能在链表中间，先获取位置之前和之后的节点
    Node<E> pred, succ;
    //如果插入的位置在链表尾部
    if (index == size) {
        //最后不需要再链接succ
        succ = null;
        pred = last;
    } else {
    	//获取第index个节点
        succ = node(index);
        //获取第index-1个节点，元素插入到这两个节点之间。
        pred = succ.prev;
    }
    //依次插入节点
    for (Object o : a) {
        @SuppressWarnings("unchecked") E e = (E) o;
        Node<E> newNode = new Node<>(pred, e, null);
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
        pred = newNode;
    }

    if (succ == null) {
        last = pred;
    } else {
        pred.next = succ;
        succ.prev = pred;
    }

    size += numNew;
    modCount++;
    return true;
}

添加集合中所有元素到链表中的特定位置。

public void clear() {
    // Clearing all of the links between nodes is "unnecessary", but:
    // - helps a generational GC if the discarded nodes inhabit
    //   more than one generation
    // - is sure to free memory even if there is a reachable Iterator
    for (Node<E> x = first; x != null; ) {
        Node<E> next = x.next;
        x.item = null;
        x.next = null;
        x.prev = null;
        x = next;
    }
    first = last = null;
    size = 0;
    modCount++;
}

清空链表，为了方便GC，把所有节点的item, next, prev置空，最后把first，last置为空，size置为0。

public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

获取特定位置的节点，检查index是否在范围内，然后返回特定节点存放的元素。

private void checkElementIndex(int index) {
    if (!isElementIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

private boolean isElementIndex(int index) {
    return index >= 0 && index < size;
}

LinkedList中有两类检查下标是否在范围内的函数，区别是index是否可以为size。

private void checkPositionIndex(int index) {
    if (!isPositionIndex(index))
        throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}

private boolean isPositionIndex(int index) {
    return index >= 0 && index <= size;
}

public E set(int index, E element) {
    checkElementIndex(index);
    Node<E> x = node(index);
    E oldVal = x.item;
    x.item = element;
    return oldVal;
}

修改节点

public void add(int index, E element) {
    checkPositionIndex(index);

    if (index == size)
        linkLast(element);
    else
        linkBefore(element, node(index));
}

添加节点。

public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

移除节点。

public E peek() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

获取头结点元素。

public E element() {
    return getFirst();
}

获取头节点元素。

public E poll() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

获取并移除头结点。

public E remove() {
    return removeFirst();
}

移除头结点。

public boolean offer(E e) {
    return add(e);
}

尾部添加节点。

public boolean offerFirst(E e) {
    addFirst(e);
    return true;
}

头部添加节点。

public boolean offerLast(E e) {
    addLast(e);
    return true;
}

尾部添加节点。

public E peekFirst() {
    final Node<E> f = first;
    return (f == null) ? null : f.item;
}

获取头节点。

public E peekLast() {
    final Node<E> l = last;
    return (l == null) ? null : l.item;
}

获取尾部节点。

public E pollFirst() {
    final Node<E> f = first;
    return (f == null) ? null : unlinkFirst(f);
}

获取并移除头结点。

public E pollLast() {
    final Node<E> l = last;
    return (l == null) ? null : unlinkLast(l);
}

获取并移除尾节点。

public void push(E e) {
    addFirst(e);
}

入栈一个元素（在头部插入元素）。

public E pop() {
    return removeFirst();
}

出栈一个元素（从头部移除一个元素）。
和队列有关的函数有：
poll()
pollFirst()
pollLast()
offer()
offerFirst()
offerLast()
peek()
peekFirst()
peekLast()
和栈有关的函数有：
push()
pop()