public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{
//实际的存储对象的数量，transient的作用是使得改成员变量不会被序列化
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;
}
}
//无参构造方法
public LinkedList() {
}
//利用一个容器对象进行初始化
public LinkedList(Collection<? extends E> c) {
this();
addAll(c);
}
//上面的有参构造调用该方法，当然也可以直接使用它复制一个容器进入linklist
public boolean addAll(Collection<? extends E> c) {
//从size也就是当前最后一个结点的的位置+1的位置添加，因为下标是从0开始
return addAll(size, c);
}
//从一个固定位置复制一个容器进入linklist
public boolean addAll(int index, Collection<? extends E> c) {
//判断代码为 index >= 0 && index <= size; 判断这个给的这个位置是否合理
//不是这个范围会抛出数组越界异常
checkPositionIndex(index);
//将容器转换为数组
Object[] a = c.toArray();
int numNew = a.length;
//如果要添加的容器是空的，直接返回一个false
if (numNew == 0)
return false;
//succ是index所在位置的那个结点的，pred是succ上一个结点，
Node<E> pred, succ;
if (index == size) {
//如果index和size相等，说明这个就是要在linklist的末尾后面添加
//所以succ应该赋值为空，pred就是末尾的那个结点
succ = null;
pred = last;
} else {
//否则说明index那个位置不是空的，就把那个位置的结点的引用给succ
//node(index)就是遍历这个双向链表，返回index位置结点的引用
succ = node(index);
pred = succ.prev;
}
//前面的代码确定了要添加的位置，这里开始遍历容器转换的数组，进行添加
for (Object o : a) {
@SuppressWarnings("unchecked") E e = (E) o;
//生成一个结点，注意pred作为该结点的前一个结点，之后不用进行e.prev = prev,因为构造方法已经完成了这一步
Node<E> newNode = new Node<>(pred, e, null);
if (pred == null)
//如果pred是空的，说明整个linklist是空的
first = newNode;
else
//linklist是双向链表，前一个结点需要说明它的下一个结点是谁
pred.next = newNode;
//这一步让pred指向新的结点，完成了一个结点的添加
//注意:我们是让pred指向要添加的位置的的前一个结点，现在要添加的位置应该是新结点所在位置的下一个位置了
pred = newNode;
}
//上面结束遍历后，容器是复制完成了，但是没添加之前，index位置之后的链表的其余部分需要添加回来
//succ现在应该让它的前一个结点是新结点，新结点的下一个结点应该是succ
if (succ == null) {
//如果succ是空的，说明我们是在链表的末尾的下一个位置添加的，last需要重新指向正确的结点，也就是当前的最后一个结点
//这个pred经过上面的遍历，指向的是最后添加的那个结点，就是最后一个结点
last = pred;
} else {
//如果succ不是空的，当然原先是末尾的结点现在仍然是末尾，所以就不用last = pred;
//这个pred经过上面的遍历，指向的是最后添加的那个结点，重要的事情说两遍
//这里是succ和pred建立联系
pred.next = succ;
succ.prev = pred;
}
//更改现在linklist中存在的结点对象的个数
size += numNew;
//记录修改次数，使用迭代器时使用linklist的增删改会出现并发修改异常
//关于modCount在另一篇浅析arraylist做了些说明，就不赘述了
modCount++;
return true;
}
//在linklist内部总调用的方法，因为总是需要得到某个位置的结点引用
Node<E> node(int index) {
//这一句不是我注释的，其代码为index >= 0 && index < size，判断下范围，和之前checkPositionIndex作用差不多
// assert isElementIndex(index);
//size >> 1时将size除以2，但是这个是直接把指令给cpu的，是最快的运算
//除2是为了更快一点，这样最多只用遍历一半长度的链表就能得到index位置的结点
//遍历方式就是朝着一个方向一直取next或者prev，直到到达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;
}
}
//添加一个元素的方法，知道了addAll(int index, Collection<? extends E> c),添加一个元素看的就容易了
public boolean add(E e) {
linkLast(e);
return true;
}
//真正的添加一个元素的方法
void linkLast(E e) {
final Node<E> l = last;
//让新结点的前一个结点是linklist的最后一个结点
final Node<E> newNode = new Node<>(l, e, null);
//last指向作为最后一个结点的新结点newNode
last = newNode;
if (l == null)
//l为旧的last，如果l为空说明链表是空的，说明first需要指向作为第一个结点的新结点newNode
first = newNode;
else
//l不为空，那么l现在是倒数第二个结点，它需要知道它的下一个结点是谁
l.next = newNode;
//更改当前linklist存储的对象的个数
size++;
//更改修改次数
modCount++;
}
//删除一个位置的元素的方法
public E remove(int index) {
//检测index是否合理
checkElementIndex(index);
return unlink(node(index));
}
//删除一个结点的方法
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 else就是想让该结点的前一个和后一个结点相互建立联系，消除该结点它们的联系
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这个引用，让垃圾回收器回收这个被删除的结点的那块内存
x.item = null;
size--;
modCount++;
return element;
}
//根据对象删除一个linklist中元素对象的方法
public boolean remove(Object o) {
//总之从头结点开始遍历，找到那个存储元素对象等于要删除的对象的结点
//调用上面的 E unlink(Node<E> x)方法，删除该结点
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;
}
}
