一、介紹
Java常用的List實現有ArrayList和LinkedList。ArrayList通過數組實現,LinkedList通過鏈表實現。由于Java中沒有指針的概念,所以通過一個對象保存下一對象引用的方式實現鏈表。
public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, java.io.Serializable
二、數據成員
LinkedList中保存元素的總數量,每次增刪元素都會修改此值。
transient int size = 0;
頭指針
/**
* Invariant: (first == null && last == null) ||
* (first.prev == null && first.item != null)
*/
transient Node<E> first;
尾指針
/**
* Invariant: (first == null && last == null) ||
* (last.next == null && last.item != null)
*/
transient Node<E> last;
三、構造方法
用指定集合構建列表,元素保存的順序由集合的迭代器輸出決定
public LinkedList(Collection<? extends E> c) {
this();
addAll(c); // 若c為空拋空指針異常
}
四、成員方法
4.1 頭插法、尾插法、選擇插入
把元素作為第一個節點進入列表
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.prev = newNode;
size++;
modCount++;
}
把元素作為最后一個節點加入
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++;
}
把元素添加到列表的首位
public void addFirst(E e) {
linkFirst(e);
}
把元素添加到列表的末尾
public void addLast(E e) {
linkLast(e);
}
在一個非空節點之前插入元素:
void linkBefore(E e, Node<E> succ) {
// succ的前一個節點pred
final Node<E> pred = succ.prev;
// 在pred和succ創建并插入一個新的節點
final Node<E> newNode = new Node<>(pred, e, succ);
// 把succ向前方向的指針從指向pred改為指向newNode
succ.prev = newNode;
if (pred == null)
first = newNode;
else
pred.next = newNode;
size++;
modCount++;
}
4.2 解除鏈接
解鏈接第一個非空的節點,私有方法
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; // 幫助GC
first = next;
if (next == null)
last = null;
else
next.prev = null;
size--;
modCount++;
return element;
}
解鏈接最后一個非空節點,私有方法
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; // 幫助GC
last = prev;
if (prev == null)
first = null;
else
prev.next = null;
size--;
modCount++;
return element;
}
解連接非空節點
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;
} 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.3 獲取頭元素和尾元素
獲取列表的第一個元素
public E getFirst() {
final Node<E> f = first;
if (f == null)
throw new NoSuchElementException();
return f.item;
}
獲取列表的最后一個元素,由于有尾指針,所以不需要整條鏈表遍歷,時間復雜度o(1)。
public E getLast() {
final Node<E> l = last;
if (l == null)
throw new NoSuchElementException();
return l.item;
}
4.4 移除頭元素和尾元素
如果僅有一個元素,那么頭指針和尾指針指向的是同一個元素。頭指針為空或尾指針為空,有且只有在列表為空時成立,并且是同時成立。
// 移除并返回列表的第一個元素
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);
}
4.5 增刪查改
// 當列表中至少存在一個該對象時返回true,否則返回false
public boolean contains(Object o) {
return indexOf(o) != -1;
}
// 返回列表元素的數量
public int size() {
return size;
}
// 把指定元素附加到列表最后,和addLast()一樣,尾插法
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);
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 = 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);
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;
}
// 檢查參數index是否是一個迭代器的有效索引值或是一個添加操作
private boolean isPositionIndex(int index) {
return index >= 0 && index <= size;
}
// 返回指定索引位置的非空節點
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;
}
}
// 查找遇到的第一個與指定元素相同的節點的下標
// 列表不包含該元素則返回-1
public int indexOf(Object o) {
int index = 0;
// 如果o為空,就查找第一個遇到item為null的節點的下標
if (o == null) {
for (Node<E> x = first; x != null; x = x.next) {
if (x.item == null)
return index;
index++;
}
} else {
// 否則會對標每個節點下的item是否與指定對象一致
for (Node<E> x = first; x != null; x = x.next) {
if (o.equals(x.item))
return index;
index++;
}
}
return -1;
}
// 查找遇到的最后一個與指定元素相同的節點的下標
// 列表不包含該元素則返回-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 {
// 否則會對標每個節點下的item是否與指定對象一致
for (Node<E> x = last; x != null; x = x.prev) {
index--;
if (o.equals(x.item))
return index;
}
}
return -1;
}
// 獲取頭指針指向的節點的item,該操作不會移除節點
public E peek() {
final Node<E> f = first;
return (f == null) ? null : f.item;
}
// 獲取頭指針指向的節點的item,該操作不會移除節點
public E element() {
return getFirst();
}
// 獲取頭指針指向的節點的item,該操作會移除節點
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);
}
// 把元素作為列表頭結點加入
public boolean offerFirst(E e) {
addFirst(e);
return 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);
}
// 把一個元素從一個相當于棧的列表中彈出。換句話說,就是移除并返回列表的第一個元素
// 這個功能相當于removeFirst()
public E pop() {
return removeFirst();
}
// 移除第一個包含指定實例的節點,成功返回true,否者返回false,且列表不做改變
// 此方法順序遍歷
public boolean removeFirstOccurrence(Object o) {
return remove(o);
}
// 移除最后一個包含指定實例的節點,成功返回true,否者返回false,且列表不做改變
// 此方法倒序遍歷
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;
}
}
七、倒序迭代器
public Iterator<E> descendingIterator() {
return new DescendingIterator();
}
/**
* Adapter to provide descending iterators via ListItr.previous
*/
private class DescendingIterator implements Iterator<E> {
private final ListItr itr = new ListItr(size());
public boolean hasNext() {
return itr.hasPrevious();
}
public E next() {
return itr.previous();
}
public void remove() {
itr.remove();
}
}
八、列表轉數組
返回一個包含所有元素的數組,元素順序從鏈表第一位到最后一位。如果列表是空列表,會安全返回一個元素數量為0的有效數組對象。
由于返回的數組與原鏈表無關,所以對數組的修改不會影響原鏈表。
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;
}
返回一個包含所有鏈表元素的數組,數組元素保存順序與鏈表順序一致。數組的返回類型由數組聲明的類型為準,而不是鏈表節點保存類型為準。
如果數組空間足夠保存所有鏈表元素,則正常返回傳入數組,否則會創建一個與數組類型一致,容量與鏈表長度一致的新數組。
如果傳入數組的容量大于鏈表的長度,則當最后一個鏈表節點存入數組位置
下一個數組空間會被置為null。這樣有助于計算數組實際包含的元素數。
@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;
// 還有剩余的數組空間,則把第一個遇到的空閑空間置為null
if (a.length > size)
a[size] = null;
return a;
}