LinkedList源码浅析

节点Node：静态内部类

    // 节点类，有值、前驱、后继
    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;
        }
    }

 

Deque的方法

addFirst

    // 在链表头部添加元素
    public void addFirst(E e) {
        linkFirst(e);
    }

    // 在链表头部添加一个元素
    private void linkFirst(E e) {
        final Node<E> f = first;
	// 构造节点，并添加前驱和后继
        final Node<E> newNode = new Node<>(null, e, f);
	// 更新链表头部节点
        first = newNode;
	// 如果是第一个节点
        if (f == null)
            last = newNode;
        else
	    // 更新旧first节点的前驱
            f.prev = newNode;
        size++;
        modCount++;
    }

addLast

    // 在链表尾部添加元素
    public void addLast(E e) {
        linkLast(e);
    }

    // 在链表尾部添加一个元素
    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++;
    }

offerFirst

    // 插入元素到链表头部
    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }

offerLast

    // 插入元素到链表尾部
    public boolean offerLast(E e) {
        addLast(e);
        return true;
    }

pollFirst，不存在不会抛出异常

    // 取出链表头部元素
    public E pollFirst() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    // 断开链表头部的连接
    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;
    }

pollLast，不存在不会抛出异常

    // 取出链表尾部元素
    public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

    // 断开链表尾部的连接
    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;
    }

removeFirst，不存在会抛出异常

    // 移除链表头部，头部不存在则会出现异常
    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

removeLast，不存在会抛出异常

    // 移除链表尾部，尾部不存在则会出现异常
    public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }

getFirst，不存在会抛出异常

    // 获取链表头部，获取为null时会出现异常
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

getLast，不存在会抛出异常

    // 获取链表尾部，获取为null时会出现异常
    public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

peekFirst，不存在不会抛出异常

    // 查询链表头部元素
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

peekLast，不存在不会抛出异常

    // 查询链表尾部元素
    public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

push

    // 入栈(添加到链表首部)
    public void push(E e) {
        addFirst(e);
    }

pop

    // 出栈(链表首部移除元素)
    public E pop() {
        return removeFirst();
    }

remove

    // 删除某个元素
    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;
                }
            }
        }
	// 找到元素并删除，则返回true
	// 找不到元素则返回false
        return false;
    }

    // 断开节点的连接
    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;
    }

contains

    // 判断是否包含某个元素
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

    // 返回元素的索引位置，如果不存在，则返回-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;
    }

反序遍历

    public Iterator<E> descendingIterator() {
        return new DescendingIterator();
    }

    /**
     * Adapter to provide descending iterators via ListItr.previous
     */
    private class DescendingIterator implements Iterator<E> {
        private final ListItr itr = new ListItr(size());
        public boolean hasNext() {
            return itr.hasPrevious();
        }
        public E next() {
            return itr.previous();
        }
        public void remove() {
            itr.remove();
        }
    }

 

Queue的方法

add

    // 添加元素(添加元素的位置是链表尾部)
    public boolean add(E e) {
        linkLast(e);
        return true;
    }

offer

    // 添加元素到尾部
    public boolean offer(E e) {
        return add(e);
    }

removeFirst

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

poll

    // 取出头部元素
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

element

    // 获取头部元素
    public E element() {
        return getFirst();
    }

peek

    // 查询头部元素
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

 

List的方法

    // 获取指定索引位置的元素
    public E get(int index) {
	// 检查是否存在该索引
        checkElementIndex(index);
        return node(index).item;
    }

    // 返回指定索引位置的元素
    Node<E> node(int index) {
        // assert isElementIndex(index);

	// 由于是双向队列，判断是从链表头部搜索，还是从链表尾部搜索的效率更快
        if (index < (size >> 1)) {
            Node<E> x = first;
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {
            Node<E> x = last;
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }