一、LinkedList的定义:
public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, java.io.Serializable
从上述定义可以看出:
1. LinkedList继承自AbstractSequentialList类,实现了List接口,所以它是一个队列,支持相关的添加、删除、修改、遍历等功能。
2. LinkedList实现了Deque接口。
3. LinkedList实现了Cloneable接口,即实现clone()函数。它能被克隆。
4. LinkedList实现了java.io.Serializable接口,支持序列化。
5. LinkedList是支持泛型的。
二、LinkedList的基本属性:
LinkedList包含2个基本属性:存放元素的链表和链表中存放元素的个数。
/**
* 链表的头结点
*/
private transient Entry<E> header = new Entry<E>(null, null, null);
/**
* 存放元素的个数
*/
private transient int size = 0;
私有内部类 Entry<E> 源码:
private static class Entry<E> {
E element;
Entry<E> next;
Entry<E> previous;
Entry(E element, Entry<E> next, Entry<E> previous) {
this.element = element;
this.next = next;
this.previous = previous;
}
}
只定义了存储的元素、前一个元素、后一个元素,这就是双向链表的节点的定义,每个节点只知道自己的前一个节点和后一个节点。
三、LinkedList的构造方法:
1. 第一个构造方法(不带参数):
public LinkedList() {
header.next = header.previous = header;
}
将header节点的前一节点和后一节点都设置为自身(注意,这个是一个双向循环链表,如果不是循环链表,空链表的情况应该是header节点的前一节点和后一节点均为null),这样整个链表其实就只有header一个节点,用于表示一个空的链表。
2. 第二个构造方法(传入一个Collection集合):
public LinkedList(Collection<? extends E> c) {
this();
addAll(c);
}
接收一个Collection参数c,调用第一个构造方法构造一个空的链表,之后通过addAll将c中的元素全部添加到链表中。
四、LinkedList的添加元素方法:
1. add(E e):添加一个元素。
public boolean add(E e) {
addBefore(e, header);
return true;
}
从上面的代码可以看出,add(E e)方法只是调用了addBefore(E e,Entry<E> entry)方法,并且返回true。
2. addBefore(E e,Entry<E> entry):添加一个元素。
private Entry<E> addBefore(E e, Entry<E> entry) {
Entry<E> newEntry = new Entry<E>(e, entry, entry.previous);
newEntry.previous.next = newEntry;
newEntry.next.previous = newEntry;
size++;
modCount++;
return newEntry;
}
先通过Entry的构造方法创建e的节点newEntry(包含了将其下一个节点设置为entry,上一个节点设置为entry.previous的操作,相当于修改newEntry的“指针”),之后修改插入位置后newEntry的前一节点的next引用和后一节点的previous引用,使链表节点间的引用关系保持正确。之后修改和size大小和记录modCount,然后返回新插入的节点。
总结:addBefore(E e,Entry<E> entry)实现在entry之前插入由e构造的新节点。而add(E e)实现在header节点之前插入由e构造的新节点。
3. add(int index,E e):在指定index位置添加一个元素。
public void add(int index, E element) {
addBefore(element, (index==size ? header : entry(index)));
}
也是调用了addBefore(E e,Entry<E> entry)方法,只是entry节点由index的值决定。
4. addFirst(E e):只需实现在header元素的下一个元素之前插入。
public void addFirst(E e) {
addBefore(e, header.next);
}
5. addLast(E e):只需在实现在header节点前(因为是循环链表,所以header的前一个节点就是链表的最后一个节点)插入节点。
public void addLast(E e) {
addBefore(e, header);
}
6. addAll(Collection<? extends E> c):
public boolean addAll(Collection<? extends E> c) {
return addAll(size, c);
}
// index参数指定collection中插入的第一个元素的位置
public boolean addAll(int index, Collection<? extends E> c) {
// 插入位置超过了链表的长度或小于0,报IndexOutOfBoundsException异常
if (index < 0 || index > size)
throw new IndexOutOfBoundsException("Index: "+index+", Size: "+size);
Object[] a = c.toArray();
int numNew = a.length;
// 若需要插入的节点个数为0则返回false,表示没有插入元素
if (numNew==0)
return false;
modCount++;
// 保存index处的节点。插入位置如果是size,则在头结点前面插入,否则获取index处的节点
Entry<E> successor = (index==size ? header : entry(index));
// 获取前一个节点,插入时需要修改这个节点的next引用
Entry<E> predecessor = successor.previous;
// 按顺序将a数组中的第一个元素插入到index处,将之后的元素插在这个元素后面
for (int i=0; i<numNew; i++) {
// 结合Entry的构造方法,这条语句是插入操作,相当于C语言中链表中插入节点并修改指针
Entry<E> e = new Entry<E>((E)a[i], successor, predecessor);
// 插入节点后将前一节点的next指向当前节点,相当于修改前一节点的next指针
predecessor.next = e;
// 相当于C语言中成功插入元素后将指针向后移动一个位置以实现循环的功能
predecessor = e;
}
// 插入元素前index处的元素链接到插入的Collection的最后一个节点
successor.previous = predecessor;
// 修改size
size += numNew;
return true;
}
五、LinkedList的删除元素方法:
1. remove():删除链表中第一个元素。
public E remove() {
return removeFirst();
}
2. remove(int index):删除链表中指定位置的元素。
public E remove(int index) {
return remove(entry(index));
}
3. remove(Object o):删除链表中指定元素。
public boolean remove(Object o) {
if (o==null) {
for (Entry<E> e = header.next; e != header; e = e.next) {
if (e.element==null) {
remove(e);
return true;
}
}
} else {
for (Entry<E> e = header.next; e != header; e = e.next) {
if (o.equals(e.element)) {
remove(e);
return true;
}
}
}
return false;
}
4. removeFirst():删除链表中第一个元素。
public E removeFirst() {
return remove(header.next);
}
5. removeLast():删除链表中最后一个元素。
public E removeLast() {
return remove(header.previous);
}
6. removeFirstOccurrence():
public boolean removeFirstOccurrence(Object o) {
return remove(o);
}
7. removeLastOccurence():
public boolean removeLastOccurrence(Object o) {
if (o==null) {
for (Entry<E> e = header.previous; e != header; e = e.previous) {
if (e.element==null) {
remove(e);
return true;
}
}
} else {
for (Entry<E> e = header.previous; e != header; e = e.previous) {
if (o.equals(e.element)) {
remove(e);
return true;
}
}
}
return false;
}
几个remove方法最终都是调用了一个私有方法:remove(Entry<E> e),只是其他简单逻辑上的区别。下面分析remove(Entry<E> e)方法。
remove(Entry<E> e):删除一个Entry。
private E remove(Entry<E> e) {
if (e == header)
throw new NoSuchElementException();
// 保留将被移除的节点e的内容
E result = e.element;
// 将前一节点的next引用赋值为e的下一节点
e.previous.next = e.next;
// 将e的下一节点的previous赋值为e的上一节点
e.next.previous = e.previous;
// 上面两条语句的执行已经导致了无法在链表中访问到e节点,而下面解除了e节点对前后节点的引用
e.next = e.previous = null;
// 将被移除的节点的内容设为null
e.element = null;
// 修改size大小
size--;
modCount++;
// 返回移除节点e的内容
return result;
}
8. clear():清空整个LinkedList。
public void clear() {
Entry<E> e = header.next;
// e可以理解为一个移动的“指针”,因为是循环链表,所以回到header的时候说明已经没有节点了
while (e != header) {
// 保留e的下一个节点的引用
Entry<E> next = e.next;
// 接触节点e对前后节点的引用
e.next = e.previous = null;
// 将节点e的内容置空
e.element = null;
// 将e移动到下一个节点
e = next;
}
// 将header构造成一个循环链表,同构造方法构造一个空的LinkedList
header.next = header.previous = header;
// 修改size
size = 0;
modCount++;
}
六、LinkedList的修改元素方法:
1. set(int index,E element):修改指定位置的元素。
public E set(int index, E element) {
Entry<E> e = entry(index);
E oldVal = e.element;
e.element = element;
return oldVal;
}
七、LinkedList的获取元素方法:
1. get(int index):获取链表中指定位置的元素。
public E get(int index) {
return entry(index).element;
}
2. getFirst():获取链表中第一个元素。
public E getFirst() {
if (size==0)
throw new NoSuchElementException();
return header.next.element;
}
3. getLast():获取链表中最后一个元素。
public E getLast() {
if (size==0)
throw new NoSuchElementException();
return header.previous.element;
}
4. element():获取链表中第一个元素。
public E element() {
return getFirst();
}
八、LinkedList的特有的常用方法:
下面这三个方法也很简单,只是调用了对应的get方法。
1. peek():获取链表中第一个元素。
public E peek() {
if (size==0)
return null;
return getFirst();
}
2. peekFirst():获取链表中第一个元素。
public E peekFirst() {
if (size==0)
return null;
return getFirst();
}
3. peekLast():获取链表中最后一个元素。
public E peekLast() {
if (size==0)
return null;
return getLast();
}
poll相关的方法都是获取并移除某个元素。都是和remove操作相关。
4. poll():删除链表中第一个元素。
public E poll() {
if (size==0)
return null;
return removeFirst();
}
5. pollFirst():删除链表中第一个元素。
public E pollFirst() {
if (size==0)
return null;
return removeFirst();
}
6. pollLast():删除链表中最后一个元素。
public E pollLast() {
if (size==0)
return null;
return removeLast();
}
以下这两个方法对应栈的操作,即弹出一个元素和压入一个元素,仅仅是调用了removeFirst()和addFirst()方法。
7. pop():弹出一个元素(删除链表中第一个元素)。
public E pop() {
return removeFirst();
}
8. push(E e):压入一个元素(向链表中的头部添加一个元素)。
public void push(E e) {
addFirst(e);
}
九、LinkedList的其他常用方法:
1. toArray():将LinkedList转换成Array。
public Object[] toArray() {
Object[] result = new Object[size];
int i = 0;
for (Entry<E> e = header.next; e != header; e = e.next)
result[i++] = e.element;
return result;
}
创建大小和LinkedList相等的数组result,遍历链表,将每个节点的元素element复制到数组中,返回数组。
2. toArray(T[] a):泛型写法。
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 (Entry<E> e = header.next; e != header; e = e.next)
result[i++] = e.element;
if (a.length > size)
a[size] = null;
return a;
}
先判断出入的数组a的大小是否足够,若大小不够则拓展。这里用到了发射的方法,重新实例化了一个大小为size的数组。之后将数组a赋值给数组result,遍历链表向result中添加的元素。最后判断数组a的长度是否大于size,若大于则将size位置的内容设置为null。返回a。
从代码中可以看出,数组a的length小于等于size时,a中所有元素被覆盖,被拓展来的空间存储的内容都是null;若数组a的length的length大于size,则0至size-1位置的内容被覆盖,size位置的元素被设置为null,size之后的元素不变。