LinkList继承AbstractSequentialList抽象类，实现了List、Deque、Cloneable、java.io.Serializable接口
- AbstractSequentialList抽象类：只支持按次序访问
- Deque接口：双向队列
- Cloneable接口：浅克隆
- Serializable接口：序列化
LinkedList是List和Deque接口的双向链表的实现。实现了所有可选列表操作，并允许包括null值。顺序访问非常高效。
1. LinkList的属性
其属性都用transient关键字修饰
// 实际元素个数
transient int size = 0;
// 头结点
transient Node<E> first;
// 尾结点
transient Node<E> last;
2. LinkList的构造方法
2.1 LinkedList()型构造函数
public LinkedList() {
}
2.2 LinkedList(Collection<? extends E>)型构造函数
/**
* 会调用无参构造函数，并且会把集合中所有的元素添加到LinkedList中
*/
public LinkedList(Collection<? extends E> c) {
// 调用无参构造函数
this();
// 添加集合中所有的元素
addAll(c);
}
3. LinkedList的插入方法
3.1 头插法
/**
* LinkedList的api方法 头插入，在列表首部插入节点值e
*/
public void addFirst(E e) {
linkFirst(e);
}
/**
* 内部调用 头插入，即将节点值为e的节点设置为链表首节点
*/
private void linkFirst(E e) {
final Node<E> f = first;
// 构建一个prev值为null,节点值为e,next值为f的新节点newNode
final Node<E> newNode = new Node<>(null, e, f);
// 将newNode作为首节点
first = newNode;
// 如果原首节点为null，即原链表为null，则链表尾节点也设置为newNode
if (f == null)
last = newNode;
else // 否则，原首节点的prev设置为newNode
f.prev = newNode;
size++;
modCount++;
}
3.2 尾插法
/**
* LinkedList的api方法 尾插入，在列表尾部插入节点值e，该方法等价于add()
*/
public void addLast(E e) {
linkLast(e);
}
/**
* 重写List 的api方法 尾插入，在列表尾部插入节点值e
*/
public boolean add(E e) {
linkLast(e);
return true;
}
/**
* 尾插入，即将节点值为e的节点设置为链表的尾节点
*/
void linkLast(E e) {
final Node<E> l = last;
// 构建一个prev值为l,节点值为e,next值为null的新节点newNode
final Node<E> newNode = new Node<>(l, e, null);
// 将newNode作为尾节点
last = newNode;
// 如果原尾节点为null，即原链表为null，则链表首节点也设置为newNode
if (l == null)
first = newNode;
else // 否则，原尾节点的next设置为newNode
l.next = newNode;
size++;
modCount++;
}
3.3 中间插入
/**
* 中间插入，将指定的元素(E element)插入到列表的指定位置(index)
*/
public void add(int index, E element) {
checkPositionIndex(index);
if (index == size)
linkLast(element);
else
linkBefore(element, node(index));
}
/**
* 中间插入，在非空节点succ之前插入节点值e
*/
void linkBefore(E e, Node<E> succ) {
// assert succ != null;
final Node<E> pred = succ.prev;
// 构建一个prev值为succ.prev,节点值为e,next值为succ的新节点newNode
final Node<E> newNode = new Node<>(pred, e, succ);
// 设置newNode为succ的前节点
succ.prev = newNode;
// 如果succ.prev为null，即如果succ为首节点，则将newNode设置为首节点
if (pred == null)
first = newNode;
else // 如果succ不是首节点
pred.next = newNode;
size++;
modCount++;
}
3.4 插入集合
- public boolean addAll(Collection<? extends E> c)
尾部开始插入集合
/**
* 按照指定collection的迭代器所返回的元素顺序，将该collection中的所有元素添加到此链表的尾部
* 如果指定的集合添加到链表的尾部的过程中，集合被修改，则该插入过程的后果是不确定的。
* 一般这种情况发生在指定的集合为该链表的一部分，且其非空。
* @throws NullPointerException 指定集合为null
*/
public boolean addAll(Collection<? extends E> c) {
return addAll(size, c);
}
- public boolean addAll(int index, Collection<? extends E> c)
指定位置开始插入集合
/**
* 从指定的位置开始，将指定collection中的所有元素插入到此链表中，新元素的顺序为指定collection的迭代器所返回的元素顺序
*/
public boolean addAll(int index, Collection<? extends E> c) {
checkPositionIndex(index);
Object[] a = c.toArray();
int numNew = a.length;
if (numNew == 0)
return false;
Node<E> pred, succ; // succ指向当前需要插入节点的位置，pred指向其前一个节点
if (index == size) { // 说明在列表尾部插入集合元素
succ = null;
pred = last;
} else {
succ = node(index); // 得到索引index所对应的节点
pred = succ.prev;
}
// 指定collection中的所有元素依次插入到此链表中指定位置的过程
for (Object o : a) {
@SuppressWarnings("unchecked") E e = (E) o;
// 将元素值e，前继节点pred“封装”为一个新节点newNode
Node<E> newNode = new Node<>(pred, e, null);
if (pred == null) // 如果原链表为null，则新插入的节点作为链表首节点
first = newNode;
else
pred.next = newNode;
pred = newNode; // pred指针向后移动，指向下一个需插入节点位置的前一个节点
}
// 集合元素插入完成后，与原链表index位置后面的子链表链接起来
if (succ == null) { // 说明之前是在列表尾部插入的集合元素
last = pred; // pred指向的是最后插入的那个节点
} else {
pred.next = succ;
succ.prev = pred;
}
size += numNew;
modCount++;
return true;
}
4. LinkedList的删除方法
4.1 头删除
/**
* LinkedList的API方法 移除首节点，并返回该节点的元素值
*/
public E remove() {
return removeFirst();
}
/**
* 内部调用 移除首节点，并返回该节点的元素值
*/
public E removeFirst() {
final Node<E> f = first;
if (f == null)
throw new NoSuchElementException();
return unlinkFirst(f);
}
/**
* 删除非空的首节点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节点设置为首节点
if (next == null) // 如果原链表只有一个节点，即原首节点，删除后，链表为null
last = null;
else
next.prev = null;
size--;
modCount++;
return element;
}
4.2 尾删除
/**
* 移除尾节点，并返回该节点的元素值
*/
public E removeLast() {
final Node<E> l = last;
if (l == null)
throw new NoSuchElementException();
return unlinkLast(l);
}
/**
* 删除非空的尾节点 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节点设置为尾节点
if (prev == null) // 如果原链表只有一个节点,则删除后，链表为null
first = null;
else
prev.next = null;
size--;
modCount++;
return element;
}
4.3 删除指定位置元素
/**
* 移除此列表中指定位置上的元素
*/
public E remove(int index) {
checkElementIndex(index);
return unlink(node(index));
}
/**
* 删除非空节点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;
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;
}
4.4 删除首次出现的指定元素
/**
* 移除列表中首次出现的指定元素(如果存在)，LinkedList中允许存放重复的元素
*/
public boolean remove(Object o) {
// 由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
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;
}
4.5 清空所有元素
/**
* 清除列表中所有节点
*/
public void clear() {
// Clearing all of the links between nodes is "unnecessary", but:
// - helps a generational GC if the discarded nodes inhabit
// more than one generation
// - is sure to free memory even if there is a reachable Iterator
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++;
}
5. LinkedList修改元素
/**
* 替换指定索引位置节点的元素值，并返回旧值
*/
public E set(int index, E element) {
checkElementIndex(index);
Node<E> x = node(index);
E oldVal = x.item;
x.item = element;
return oldVal;
}
6. LinkedList查找元素
/**
* 返回列表首节点元素值
*/
public E getFirst() {
final Node<E> f = first;
if (f == null) // 如果首节点为null
throw new NoSuchElementException();
return f.item;
}
/**
* 返回列表尾节点元素值
*/
public E getLast() {
final Node<E> l = last;
if (l == null) // 如果尾节点为null
throw new NoSuchElementException();
return l.item;
}
/**
* 判断列表中是否包含有元素值o，返回true当列表中至少存在一个元素值e，使得(o==null?e==null:o.equals(e))
*/
public boolean contains(Object o) {
return indexOf(o) != -1;
}
/**
* 返回指定索引处的元素值
*/
public E get(int index) {
checkElementIndex(index);
return node(index).item;
}
/**
* 返回指定索引位置的节点
*/
Node<E> node(int index) {
// assert isElementIndex(index);
// 折半思想，当index < size/2时，从列表首节点向后查找
if (index < (size >> 1)) {
Node<E> x = first;
for (int i = 0; i < index; i++)
x = x.next;
return x;
} else { // 当index >= size/2时，从列表尾节点向前查找
Node<E> x = last;
for (int i = size - 1; i > index; i--)
x = x.prev;
return x;
}
}
/**
* 正向查找，返回LinkedList中元素值Object o第一次出现的位置，如果元素不存在，则返回-1
* 不能按条件双向找了，所以通常根据索引获得元素的速度比通过元素获得索引的速度快
*/
public int indexOf(Object o) {
int index = 0;
// 由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
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中元素值Object o最后一次出现的位置，如果元素不存在，则返回-1
*/
public int lastIndexOf(Object o) {
int index = size;
// 由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
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;
}
7. 其他方法
7.1 public方法
- public Object clone()
/**
* 返回此 LinkedList实例的浅拷贝
*/
public Object clone() {
LinkedList<E> clone = superClone();
// Put clone into "virgin" state
clone.first = clone.last = null;
clone.size = 0;
clone.modCount = 0;
// Initialize clone with our elements
for (Node<E> x = first; x != null; x = x.next)
clone.add(x.item);
return clone;
}
- public Object[] toArray()
/**
* 返回一个包含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;
}
- public <T> T[] toArray(T[] a)
/**
* 如果给定的参数数组长度足够，则将ArrayList中所有元素按序存放于参数数组中，并返回
* 如果给定的参数数组长度小于LinkedList的长度，则返回一个新分配的、长度等于LinkedList长度的、包含LinkedList中所有元素的新数组
*/
@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
if (a.length < size)
a = (T[])java.lang.reflect.Array.newInstance(
a.getClass().getComponentType(), size);
int i = 0;
Object[] result = a;
for (Node<E> x = first; x != null; x = x.next)
result[i++] = x.item;
if (a.length > size)
a[size] = null;
return a;
}
7.2支持序列化的方法
/**
* 序列化：从内存中将linkedList的“大小，所有的元素值”都写出到输出流
*/
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// Write out any hidden serialization magic
s.defaultWriteObject();
// Write out size
s.writeInt(size);
// Write out all elements in the proper order.
for (Node<E> x = first; x != null; x = x.next)
s.writeObject(x.item);
}
/**
* 反序列化：从输入流中先将LinkedList的“大小”然后将“所有的元素值”读入到内存
*/
@SuppressWarnings("unchecked")
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in any hidden serialization magic
s.defaultReadObject();
// Read in size
int size = s.readInt();
// Read in all elements in the proper order.
for (int i = 0; i < size; i++)
linkLast((E)s.readObject());
}
8. 重写Deque接口的方法
// 出队（从前端），获得第一个元素，不存在会返回null，不会删除元素（节点）
public E peek() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
// 出队（从前端），不删除元素，若为null会抛出异常而不是返回null
public E element() {
return getFirst();
}
// 出队（从前端），如果不存在会返回null，存在的话会返回值并移除这个元素（节点）
public E poll() {
final Node<E> f = first;
return (f == null) ? null : unlinkFirst(f);
}
// 出队（从前端），如果不存在会抛出异常而不是返回null，存在的话会返回值并移除这个元素（节点）
public E remove() {
return removeFirst();
}
// 入队（从后端），始终返回true
public boolean offer(E e) {
return add(e);
}
// 入队（从前端），始终返回true
public boolean offerFirst(E e) {
addFirst(e);
return true;
}
// 入队（从后端），始终返回true
public boolean offerLast(E e) {
addLast(e);
return true;
}
// 出队（从前端），获得第一个元素，不存在会返回null，不会删除元素（节点）
public E peekFirst() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
// 出队（从后端），获得最后一个元素，不存在会返回null，不会删除元素（节点）
public E peekLast() {
final Node<E> l = last;
return (l == null) ? null : l.item;
}
// 出队（从前端），获得第一个元素，不存在会返回null，会删除元素（节点）
public E pollFirst() {
final Node<E> f = first;
return (f == null) ? null : unlinkFirst(f);
}
// 出队（从后端），获得最后一个元素，不存在会返回null，会删除元素（节点）
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) {
//由于LinkedList中允许存放null，因此下面通过两种情况来分别处理
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;
}
9. LinkedList的迭代器
//从第几个链表节点开始迭代
public ListIterator<E> listIterator(int index) {
checkPositionIndex(index);
return new ListItr(index);
}
/**
* ListItr是其中的一个内部类，该类是一个List迭代器
*/
public ListIterator<E> listIterator(int index) {
checkPositionIndex(index);
return new ListItr(index);
}
private class ListItr implements ListIterator<E> {
private Node<E> lastReturned; // 永远记录上一次迭代的节点
private Node<E> next;
private int nextIndex;
// 记录List修改次数，FailFast机制
private int expectedModCount = modCount;
// 从index节点开始迭代
ListItr(int index) {
// assert isPositionIndex(index);
next = (index == size) ? null : node(index);
nextIndex = index;
}
// 判断是否还有下一个元素
public boolean hasNext() {
return nextIndex < size;
}
// 从前往后迭代
public E next() {
checkForComodification();
if (!hasNext())
throw new NoSuchElementException();
lastReturned = next;
next = next.next;
nextIndex++;
return lastReturned.item;
}
// 判断是否还有上一个元素
public boolean hasPrevious() {
return nextIndex > 0;
}
// 从后往前迭代
public E previous() {
checkForComodification();
if (!hasPrevious())
throw new NoSuchElementException();
lastReturned = next = (next == null) ? last : next.prev;
nextIndex--;
return lastReturned.item;
}
public int nextIndex() {
return nextIndex;
}
public int previousIndex() {
return nextIndex - 1;
}
/**
* 删除刚得到的元素
* 当迭代过程中要想删除元素，一定要用迭代器的remove方法
*/
public void remove() {
checkForComodification();
if (lastReturned == null)
throw new IllegalStateException();
Node<E> lastNext = lastReturned.next;
unlink(lastReturned);
if (next == lastReturned)
next = lastNext;
else
nextIndex--;
lastReturned = null;
// 由于上面调用unlink时，modCount++；所以为了下一次迭代不抛出异常，这里也要进行 expectedModCount++
expectedModCount++;
}
/**
* 修改刚得到的元素
* 当迭代过程中要想修改元素，一定要用迭代器的set方法
*/
public void set(E e) {
if (lastReturned == null)
throw new IllegalStateException();
checkForComodification();
lastReturned.item = e;
}
/**
* 在刚得到的元素后新增元素
* 当迭代过程中要想新增元素，一定要用迭代器的add方法
*/
public void add(E e) {
checkForComodification();
lastReturned = null;
if (next == null)
linkLast(e);
else
linkBefore(e, next);
nextIndex++;
// 由于上面调用linkLast或LinkBefore方法时，modCount++；所以为了下一次迭代不抛出异常，这里也要进行 expectedModCount++
expectedModCount++;
}
public void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
while (modCount == expectedModCount && nextIndex < size) {
action.accept(next.item);
lastReturned = next;
next = next.next;
nextIndex++;
}
checkForComodification();
}
// 判断expectedModCount和modCount是否一致，以确保通过ListItr的修改操作正确
final void checkForComodification() {
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
}
}
