Java源代码走读--LinkedList

Java源代码走读--LinkedList

LinkedList是用带头结点的双向循环链表实现的，因此添加和删除的效率非常高，查找效率欠佳，需要遍历链表。

在根据下标寻找元素时，通过判断index的值的大小选择从前向后查找还是从后向前查找。

根据下标或者根据对象删除对象时，都需要遍历链表寻找要删除的结点。

因此LinkedList的基本操作是遍历。

根据双向循环链表的特性，可以用LinkedList来实现栈和队列。

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{
    private transient Entry<E> header = new Entry<E>(null, null, null);
    private transient int size = 0;

    /**
     * 构造一个空的链表，带头节点
     */
    public LinkedList() {
        header.next = header.previous = header;
    }

    /**
     * 用其他集合类构造LinkedList
     */
    public LinkedList(Collection<? extends E> c) {
	this();
	addAll(c);
    }

    /**
     * 返回第一个元素
     */
    public E getFirst() {
	if (size==0)
	    throw new NoSuchElementException();

	return header.next.element;
    }

    /**
     * 返回最后一个元素
     */
    public E getLast()  {
	if (size==0)
	    throw new NoSuchElementException();

	return header.previous.element;
    }

    /**
     *删除第一个元素
     */
    public E removeFirst() {
	return remove(header.next);
    }

    /**
     * 删除最后一个元素
     */
    public E removeLast() {
	return remove(header.previous);
    }

    /**
     * 在链表头添加元素
     */
    public void addFirst(E e) {
	addBefore(e, header.next);
    }

    /**
     * 在链表尾添加元素
     */
    public void addLast(E e) {
	addBefore(e, header);
    }

    /**
     * 寻找list当中是否包含某个元素，实际操作是遍历链表，返回下标，若不存在返回false
     */
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

    /**
     * 返回链表大小
     */
    public int size() {
	return size;
    }

    /**
     * 在链表尾添加元素
     */
    public boolean add(E e) {
	addBefore(e, header);
        return true;
    }

    /**
     * 删除某个元素，成功返回true，失败返回false
     */
    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;
    }

    /**
     * 将另一个集合类中的所有元素添加到list尾
     */
    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

    /**
     * 将集合类中的所有元素从特定下标处开始添加到list当中
     */
    public boolean addAll(int index, Collection<? extends E> c) {
        if (index < 0 || index > size)
            throw new IndexOutOfBoundsException("Index: "+index+
                                                ", Size: "+size);
        Object[] a = c.toArray();
        int numNew = a.length;
        if (numNew==0)
            return false;
	modCount++;

        Entry<E> successor = (index==size ? header : entry(index));//entry方法中如果index小于size的一半则从前向后遍历，若大于size的一半则从后向前遍历
        Entry<E> predecessor = successor.previous;
	for (int i=0; i<numNew; i++) {
            Entry<E> e = new Entry<E>((E)a[i], successor, predecessor);
            predecessor.next = e;
            predecessor = e;
        }
        successor.previous = predecessor;

        size += numNew;
        return true;
    }

    /**
     * 删除list当中的所有元素
     */
    public void clear() {
        Entry<E> e = header.next;
        while (e != header) {
            Entry<E> next = e.next;
            e.next = e.previous = null;
            e.element = null;
            e = next;
        }
        header.next = header.previous = header;
        size = 0;
	modCount++;
    }


    // Positional Access Operations

    /**
     * 返回某个位置的元素，entry也是根据index值选择从那边开始遍历
     */
    public E get(int index) {
        return entry(index).element;
    }

    /**
     * 修改某个位置的值，并将原值返回
     */
    public E set(int index, E element) {
        Entry<E> e = entry(index);
        E oldVal = e.element;
        e.element = element;
        return oldVal;
    }

    /**
     * 在某个位置出添加元素
     */
    public void add(int index, E element) {
        addBefore(element, (index==size ? header : entry(index)));
    }

    /**
     * 删除某个位置处的元素，并将删除元素返回
     */
    public E remove(int index) {
        return remove(entry(index));
    }

    /**
     * 返回某位置的结点
     */
    private Entry<E> entry(int index) {
        if (index < 0 || index >= size)
            throw new IndexOutOfBoundsException("Index: "+index+
                                                ", Size: "+size);
        Entry<E> e = header;
        if (index < (size >> 1)) {
            for (int i = 0; i <= index; i++)
                e = e.next;
        } else {
            for (int i = size; i > index; i--)
                e = e.previous;
        }
        return e;
    }


    // Search Operations

    /**
     * 遍历链表寻找某个元素的下标并返回，未找到返回-1，可存储null值
     */
    public int indexOf(Object o) {
        int index = 0;
        if (o==null) {
            for (Entry e = header.next; e != header; e = e.next) {
                if (e.element==null)
                    return index;
                index++;
            }
        } else {
            for (Entry e = header.next; e != header; e = e.next) {
                if (o.equals(e.element))
                    return index;
                index++;
            }
        }
        return -1;
    }

    /**
     * 从后向前找某个元素，并将其下标返回
     */
    public int lastIndexOf(Object o) {
        int index = size;
        if (o==null) {
            for (Entry e = header.previous; e != header; e = e.previous) {
                index--;
                if (e.element==null)
                    return index;
            }
        } else {
            for (Entry e = header.previous; e != header; e = e.previous) {
                index--;
                if (o.equals(e.element))
                    return index;
            }
        }
        return -1;
    }

    // Queue operations.

    /**
     * 返回表头元素
     */
    public E peek() {
        if (size==0)
            return null;
        return getFirst();
    }

    /**
     * 返回表头元素
     */
    public E element() {
        return getFirst();
    }

    /**
     * 删除表头元素并返回
     */
    public E poll() {
        if (size==0)
            return null;
        return removeFirst();
    }

    /**
     * 删除表头元素
     */
    public E remove() {
        return removeFirst();
    }

    /**
     * 在表尾添加元素
     */
    public boolean offer(E e) {
        return add(e);
    }

    // Deque operations
    /**
     * 表头添加元素
     * @since 1.6
     */
    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }

    /**
     * 表尾添加元素
     * @since 1.6
     */
    public boolean offerLast(E e) {
        addLast(e);
        return true;
    }

    /**
     * 返回表头元素，若为空表返回null
     * @since 1.6
     */
    public E peekFirst() {
        if (size==0)
            return null;
        return getFirst();
    }

    /**
     * 删除表尾元素，若为空返回null
     * @since 1.6
     */
    public E peekLast() {
        if (size==0)
            return null;
        return getLast();
    }

    /**
     * 删除表头元素，空表返回null
     * @since 1.6
     */
    public E pollFirst() {
        if (size==0)
            return null;
        return removeFirst();
    }

    /**
     * 删除表尾元素，空表返回null
     * @since 1.6
     */
    public E pollLast() {
        if (size==0)
            return null;
        return removeLast();
    }

    /**
     * 在表头添加元素
     * @since 1.6
     */
    public void push(E e) {
        addFirst(e);
    }

    /**
     * 删除表头元素并返回
     * @since 1.6
     */
    public E pop() {
        return removeFirst();
    }

    /**
     * 当某个元素第一次出现时，删除该元素
     * @since 1.6
     */
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

    /**
     * 某个元素最后一次出现时，删除该元素
     */
    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;
    }

}