LinkedList源码解析

Posted 2021-03-05 buhuiflydepig

1、存储结构

　　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;
        }
    }

 

2、属性

//当前链表中元素的个数
transient int size = 0;

//链表的第一个元素
transient Node<E> first;

//链表的最后一个元素
transient Node<E> last;

 

3、构造方法

    //无参构造方法
    public LinkedList() {
    }

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

 

4、添加

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

　　void linkLast(E e) {
　　　　　//获取链表中最后一个元素的地址
        final Node<E> l = last;
　　　　　//创建一个新的结点，前继为l，值为e，后继为null
        final Node<E> newNode = new Node<>(l, e, null);
　　　　  //因为是插到链表尾部，所以last一定会指向这个结点
        last = newNode;
　　　　  //如果最后一个结点为null，说明链表中没有一个结点，那么，将其当成第一个结点，否则，链表的最后一个结点的next指向这个新结点newNode
        if (l == null)
            first = newNode;
        else
            l.next = newNode;
　　　　 //链表元素个数加一
        size++;
　　　　 //操作次数加一
        modCount++;
    }

    //添加元素e到链表的尾部，和add方法的作用一样
    public void addLast(E e) {
        linkLast(e);
    }

    //添加元素e到链表的首部
    public void addFirst(E e) {
        linkFirst(e);
    }

    private void linkFirst(E e) {
　　　　  //获取链表第一个元素的地址
        final Node<E> f = first;
　　　　　//创建一个新的结点，前继为null，值为e，后继为f
        final Node<E> newNode = new Node<>(null, e, f);
　　　　  //因为是插到链表的首部，所以first一定会指向这个结点
        first = newNode;
　　　　  //如果第一个结点为null，说明链表中没有一个结点，那么，将其当成最后一个结点，否则，链表的第一个结点的prev指向这个新节点newNode
        if (f == null)
            last = newNode;
        else
            f.prev = newNode;
　　　　 //链表的元素个数加一
        size++;
　　　　 //操作次数加一
        modCount++;
    }

 

    //添加元素element到指定位置index处
    public void add(int index, E element) {
        //检查index是否越界
        checkPositionIndex(index);

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

    //返回链表中第index个元素
    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;
        }
    }

    //在succ结点前插入一个新结点，值为e
    void linkBefore(E e, Node<E> succ) {
        // assert succ != null
　　　　　//过去当前结点的前继结点的地址
        final Node<E> pred = succ.prev;
　　　　  //创建一个新结点，前继为pred，值为e，后继为succ
        final Node<E> newNode = new Node<>(pred, e, succ);
　　　　　//succ结点的前继一定是这个新结点
        succ.prev = newNode;
　　　　　//如果succ的前继结点为null，说明succ就是当前链表的首部，那么，将首部指向新节点new，否则，将succ的前继结点的next指向新节点newNode
        if (pred == null)
            first = newNode;
        else
            pred.next = newNode;
　　　　　//链表中的元素个数加一
        size++;
　　　　 //操作次数加一
        modCount++;
    }

 

    //构造方法中调用了此方法
　　 public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

    //将集合c的中元素，全部插入到index位置之前
    public boolean addAll(int index, Collection<? extends E> c) {
　　　　　//检查index是否越界
        checkPositionIndex(index);

　　　　　//将集合c转成数组a
        Object[] a = c.toArray();
　　　　　//获取集合中的元素个数
        int numNew = a.length;
　　　　  //如果没有元素，直接返回
        if (numNew == 0)
            return false;
　　　　 
　　　　　//获取需要插入结合的前继和后继
        Node<E> pred, succ;
　　　　　//如果index==size说明是链表最后一个元素
        if (index == size) {
            succ = null;
            pred = last;
        } else {
            succ = node(index);
            pred = succ.prev;
        }

　　　　　//将集合中的元素依次插入链表中
        for (Object o : a) {
            @SuppressWarnings("unchecked") E e = (E) o;
            Node<E> newNode = new Node<>(pred, e, null);
　　　　　　　 //如果pred==null说明是链表的第一个元素
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }
　　　　　　
　　　　　//如果succ==null说明是集合c时插入到链表的尾部，否则，将后面的链表接上
        if (succ == null) {
            last = pred;
        } else {
            pred.next = succ;
            succ.prev = pred;
        }

　　　　　//修改链表中元素的个数
        size += numNew;
　　　　　//操作次数加一
        modCount++;
        return true;
    }

    private void checkPositionIndex(int index) {
        //如果越界，抛出异常
        if (!isPositionIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

     //判断index是否越界
     private boolean isPositionIndex(int index) {
        return index >= 0 && index <= size;
    }

 

 

5、删除

    //删除链表的第一个结点，并返回其值
    public E removeFirst() {
        final Node<E> f = first;
　　　　  //如果链表的第一个结点为null时，抛出异常
        if (f == null)
            throw new NoSuchElementException();
        return 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;
　　　　　//如果next==null，说明f是最后一个结点，因为f需要删掉，所以last指向null
        if (next == null)
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

 

    //删除链表最后一个结点，并返回其值
    public E removeLast() {
        final Node<E> l = last;
　　　　　//如果最后一个结点为null时，抛出异常
        if (l == null)
            throw new NoSuchElementException();
        return 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;
　　　　　//如果prev==null，说明f时第一个结点，因为f需要删掉，所以first指向null
        if (prev == null)
            first = null;
        else
            prev.next = null;
        size--;
        modCount++;
        return element;
    }

 

    //删除链表中值为o得第一个元素
    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;
    }

    //删除元素x
    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;

　　　　　//如果前继为null，说明是第一个结点
        if (prev == null) {
            first = next;
        } else {
            prev.next = next;
            x.prev = null;
        }

　　　　　//如果后继为null，说明是最后一个结点
        if (next == null) {
            last = prev;
        } else {
            next.prev = prev;
            x.next = null;
        }

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

 

 

    //删除第index个元素
    public E remove(int index) {
        //检查index是否越界
        checkElementIndex(index);
        return unlink(node(index));
    }    

    private void checkElementIndex(int index) {
　　　　  //如果越界，抛出异常
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

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

 

 

6、查找

    //返回链表中第index个结点得值
    public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }

    //返回链表头结点得值
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

    //返回链表尾节点的值
    public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

 

   //返回链表中元素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;
    }

 

 

7、修改

    //将链表中第index个元素的值修改成element
    public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);
        E oldVal = x.item;
        x.item = element;
        return oldVal;
    }

 

 

8、其他方法

    //判断链表中是否存在元素o
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

 

     //返回链表中的元素个数 
     public int size() {
        return size;
    }

 

    //清空链表
     public void clear() {
        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++;
    }

 

    //返回链表首元素的值
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

 

    //删除首元素，并返回链表首元素的值
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }