Java集合系列之LinkedList源碼分析

//結(jié)點內(nèi)部類
private static class Node<E> {
  E item;     //元素
  Node<E> next;  //下一個節(jié)點
  Node<E> prev;  //上一個節(jié)點

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

//集合元素個數(shù)
transient int size = 0;

//頭結(jié)點引用
transient Node<E> first;

//尾節(jié)點引用
transient Node<E> last;

//無參構(gòu)造器
public LinkedList() {}

//傳入外部集合的構(gòu)造器
public LinkedList(Collection<? extends E> c) {
  this();
  addAll(c);
}

//增(添加)
public boolean add(E e) {
  //在鏈表尾部添加
  linkLast(e);
  return true;
}

//增(插入)
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 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 E set(int index, E element) {
  //檢查下標是否合法
  checkElementIndex(index);
  //獲取指定下標的結(jié)點引用
  Node<E> x = node(index);
  //獲取指定下標結(jié)點的值
  E oldVal = x.item;
  //將結(jié)點元素設(shè)置為新的值
  x.item = element;
  //返回之前的值
  return oldVal;
}

//查
public E get(int index) {
  //檢查下標是否合法
  checkElementIndex(index);
  //返回指定下標的結(jié)點的值
  return node(index).item;
}

//鏈接到指定結(jié)點之前
void linkBefore(E e, Node<E> succ) {
  //獲取給定結(jié)點的上一個結(jié)點引用
  final Node<E> pred = succ.prev;
  //創(chuàng)建新結(jié)點, 新結(jié)點的上一個結(jié)點引用指向給定結(jié)點的上一個結(jié)點
  //新結(jié)點的下一個結(jié)點的引用指向給定的結(jié)點
  final Node<E> newNode = new Node<>(pred, e, succ);
  //將給定結(jié)點的上一個結(jié)點引用指向新結(jié)點
  succ.prev = newNode;
  //如果給定結(jié)點的上一個結(jié)點為空, 表明給定結(jié)點為頭結(jié)點
  if (pred == null) {
    //將頭結(jié)點引用指向新結(jié)點
    first = newNode;
  } else {
    //否則, 將給定結(jié)點的上一個結(jié)點的下一個結(jié)點引用指向新結(jié)點
    pred.next = newNode;
  }
  //集合元素個數(shù)加一
  size++;
  //修改次數(shù)加一
  modCount++;
}

//卸載指定結(jié)點
E unlink(Node<E> x) {
  //獲取給定結(jié)點的元素
  final E element = x.item;
  //獲取給定結(jié)點的下一個結(jié)點的引用
  final Node<E> next = x.next;
  //獲取給定結(jié)點的上一個結(jié)點的引用
  final Node<E> prev = x.prev;

  //如果給定結(jié)點的上一個結(jié)點為空, 說明給定結(jié)點為頭結(jié)點
  if (prev == null) {
    //將頭結(jié)點引用指向給定結(jié)點的下一個結(jié)點
    first = next;
  } else {
    //將上一個結(jié)點的后繼結(jié)點引用指向給定結(jié)點的后繼結(jié)點
    prev.next = next;
    //將給定結(jié)點的上一個結(jié)點置空
    x.prev = null;
  }

  //如果給定結(jié)點的下一個結(jié)點為空, 說明給定結(jié)點為尾結(jié)點
  if (next == null) {
    //將尾結(jié)點引用指向給定結(jié)點的上一個結(jié)點
    last = prev;
  } else {
    //將下一個結(jié)點的前繼結(jié)點引用指向給定結(jié)點的前繼結(jié)點
    next.prev = prev;
    x.next = null;
  }

  //將給定結(jié)點的元素置空
  x.item = null;
  //集合元素個數(shù)減一
  size--;
  //修改次數(shù)加一
  modCount++;
  return element;
}

//根據(jù)指定位置獲取結(jié)點
Node<E> node(int 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;
  }
}

//獲取頭結(jié)點
public E peek() {
  final Node<E> f = first;
  return (f == null) ? null : f.item;
}

//獲取頭結(jié)點
public E element() {
  return getFirst();
}

//彈出頭結(jié)點
public E poll() {
  final Node<E> f = first;
  return (f == null) ? null : unlinkFirst(f);
}

//移除頭結(jié)點
public E remove() {
  return removeFirst();
}

//在隊列尾部添加結(jié)點
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;
}

//獲取頭結(jié)點
public E peekFirst() {
  final Node<E> f = first;
  return (f == null) ? null : f.item;
 }

//獲取尾結(jié)點
public E peekLast() {
  final Node<E> l = last;
  return (l == null) ? null : l.item;
}

//入棧
public void push(E e) {
  addFirst(e);
}

//出棧
public E pop() {
  return removeFirst();
}