链表的应用----LinkedList

• linkedList底层是一个双向链表
  • 链表是一个一个节点连接 不需要连续的内存空间
  • 特点是查询慢 增加/删除快
  • 双向链表的每个节点都包含一个指向上一个节点的前指针和指向下一个节点的后指针(所以其所占用的内存空间相对数组也比较大)

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.源码解析

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;

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

    //包含一个数组的构造函数，链表中的顺序按照集合中的元素顺序进行插入
    public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);//添加所有元素
    }

    /**
     * 创建第一个节点元素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
			//否则不为空(表明当前链表已经有元素 注意这里是要构建第一个节点 所以是向前面添加元素) 则令f的头指针指向当前节点
            f.prev = newNode;
        size++;
        modCount++;
    }

    /**
     * 创建最后一个节点元素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++;
    }

    //在指定节点succ之前添加节点e
	//这里注意 LinkedList构建是是双向链表
    void linkBefore(E e, Node<E> succ) {
        final Node<E> pred = succ.prev;//获取到succ的前一个节点pred
        final Node<E> newNode = new Node<>(pred, e, succ);//构建一个新节点 令其前指针指向pred后指针指向succ
        succ.prev = newNode;//succ前指针指向新节点
        if (pred == null)
            first = newNode;//如果succ前指针为空 则说明该节点是头节点
        else
            pred.next = newNode;//否则pred后指针指向新节点
        size++;
        modCount++;
    }

    /**
	 * 取消非空第一个节点f的链接(相当于删除该节点)
	 *     1. 把第一个节点设为空
	 *     2. 取消第一个节点的后指针指向
	 *     3. 当第一个节点删除后 第二个节点就成为了当前链表的第一个节点
	 */
    private E unlinkFirst(Node<E> f) {
        final E element = f.item;//记录当前元素
        final Node<E> next = f.next;//记录当前元素的下一节点
        f.item = null;
        f.next = null;//方便GC回收内存
        first = next;//令第一个节点为当前元素的下一个节点 (此时已经成功把第一个节点置空)
        if (next == null)//如果next为空 说明当前链表只有f一个节点
            last = null;
        else
            next.prev = null;
        size--;
        modCount++;
        return element;
    }

    /**
     * 取消非空最后一个节点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;
    }

    /**
     * 取消非空节点x的链接(相当于删除该节点)
	 *     1. 把当前节点的前一个节点和后一个节点的前后指向由原来的指向当前节点x修改为分别指向前后两个节点(prev和next)即可
     */
    E unlink(Node<E> x) {

        final E element = x.item;//记录当前节点
        final Node<E> next = x.next;//记录前一个节点
        final Node<E> prev = x.prev;//记录后一个节点

        if (prev == null) {
            first = next;//当prev为空说明该节点为第一个节点
        } 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 getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

    //删除第一个节点
    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

    //删除最后一个节点
    public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }

    //添加元素为第一个节点
    public void addFirst(E e) {
        linkFirst(e);
    }

    //添加元素为最后一个节点
    public void addLast(E e) {
        linkLast(e);
    }

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

    //获取链表长度
    public int size() {
        return size;
    }

    //添加元素为最后一个节点
    public boolean add(E e) {
        linkLast(e);
        return true;
    }

    //删除节点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;
    }

    //添加一个集合元素到链表最后
    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

    //将一个集合元素插入到指定位置
    public boolean addAll(int index, Collection<? extends E> c) {
        checkPositionIndex(index);//校验是否index是否越界

        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew == 0)
            return false;

		//得到插入位置的前继节点和后继节点
        Node<E> pred, succ;
        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);
            if (pred == null)
                first = newNode;
            else
                pred.next = newNode;
            pred = newNode;
        }

        if (succ == null) {
			// 如果是从尾部开始插入的，则把last置为最后一个插入的元素
            last = pred;
        } else {
			//否则把尾部的数据和之前的节点连起来
            pred.next = succ;
            succ.prev = pred;
        }

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

    //删除所有数据
    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 get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }

    //修改指定节点元素值 并返回被修改的值
    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);
		//当index等于集合长度则插入到链表最后
        if (index == size)
            linkLast(element);
        else//否则插入到该节点之前
            linkBefore(element, node(index));
    }

    //删除指定节点
    public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }

    //判断链表上是否存在下标为index的元素
    private boolean isElementIndex(int index) {
        return index >= 0 && index < size;
    }

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

    //获取索引越界异常信息
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

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

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

    /**
     * 获取指定元素的非空节点
     */
    Node<E> node(int index) {
		//这里使用了二分查找法进行查询
        if (index < (size >> 1)) {//如果index小于长度一半则遍历查询前半个链表
            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;
        }
    }


    //判断linkedList集合是否包含元素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;
    }

    //从最后一个元素开始查询linkedList是否包含元素o  包含就返回该元素的索引否则返回-1
    public int lastIndexOf(Object o) {
        int index = size;
        if (o == null) {
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (x.item == null)
                    return index;
            }
        } else {
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (o.equals(x.item))
                    return index;
            }
        }
        return -1;
    }

    // Queue operations.

    //返回链表第一个元素  但不删除
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

    //获取链表第一个元素  但不删除
    public E element() {
        return getFirst();
    }

    //获取链表第一个元素 如果存在 就删除 否则返回null
    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);
    }

    // Deque operations
    //添加元素到链表第一个节点
    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();
    }

    //删除元素
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

 
    //删除链表指定元素的最后一个匹配节点
    public boolean removeLastOccurrence(Object o) {
        if (o == null) {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }


	//核心 : 节点构造器
    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 Object[] toArray() {
        Object[] result = new Object[size];//创建长度和集合长度相同的数组
        int i = 0;
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;//遍历链表添加到创建好的数组中
        return result;
    }

}