ELinkList.java

package will.zhang.linkList;

/**
 * @Author will
 * @Date 2018/5/2 0002 下午 8:31
 *
 * 链表的时间复杂度分析
 * 添加 : 综合O(n)
 * addLast(e)       O(n)
 * addFirst(e)      O(1)
 * add(index,e)     O(n)
 *
 * 删除 : 综合O(n)
 * removeLast(e)    O(n)
 * removeFirst(e)   O(1)
 * remove(index,e)  O(n)
 *
 * 修改 : 综合O(n)
 * set(index,e)     O(n)
 *
 * 查找 : 综合O(n)
 * get(index)       O(n)
 * contains(e)      O(n)
 *
 **/
public class ELinkList<E> {

    //为了方便让整个链表的所有节点都拥有上一个节点, 所以设立虚拟头节点
    //链表的虚拟头节点, 不存放任何元素, 第一个节点是hummyHead.next
    private Node dummyHead;
    //链表的元素个数
    private int size;

    public ELinkList(){
        //对于一个空的链表来说, 是存在一个对用户不可见的虚拟头节点
        dummyHead = new Node(null, null);
        size = 0;
    }

    /**
     * 获取链表的元素个数
     * @return
     */
    public int getSize(){
        return size;
    }

    /**
     * 返回链表是否为空
     * @return
     */
    public boolean isEmpty(){
        return size == 0;
    }

    /**
     * 在链表的index位置添加元素
     * 注意 : 当你选择链表的时候, 其实就已经打算不使用索引了
     * 因为在链表中是不存在索引的
     * 所以此方法当作练习即可
     * 日常工作中, 需要用到索引必须使用ArrayList
     * @param index
     * @param e
     */
    public void add(int index, E e){
        if(index < 0 || index > size) {
            throw new IllegalArgumentException("Add failed. Illegal index");
        }

        //prev表示插入位置index的前一个元素, 找到它就找到了插入位置
        //这也是为什么要使用索引就不要用链表的原因
        Node prev = dummyHead;
        for (int i = 0; i < index; i++) {
            prev = prev.next;
        }
        //Node node = new Node(e);
        //node.next = prev.next;
        //prev.next = node;
        //上面三句简写成一句
        prev.next = new Node(e, prev.next);

        size++;
    }

    /**
     * 在链表头添加元素
     * @param e
     */
    public void addFirst(E e){
        add(0, e);
    }

    /**
     * 在链表的末尾添加元素
     * @param e
     */
    public void addLast(E e){
        add(size, e);
    }

    /**
     * 获取指定索引的元素
     * 注意 : 当你选择链表的时候, 其实就已经打算不使用索引了
     * 因为在链表中是不存在索引的
     * 所以此方法当作练习即可
     * 日常工作中, 需要用到索引必须使用ArrayList
     * @param index
     * @return
     */
    public E get(int index){
        if(index < 0 || index >= size){
            throw new IllegalArgumentException("Get failed. Illegal index.");
        }

        Node cur = dummyHead.next;

        for (int i = 0; i < index; i++) {
            cur = cur.next;
        }
        return cur.e;
    }

    /**
     * 获取第一个元素
     * @return
     */
    public E getFirst(){
        return get(0);
    }

    /**
     * 获取最后一个元素
     * @return
     */
    public E getLast(){
        return get(size - 1);
    }

    /**
     * 修改指定索引的元素
     * 注意 : 当你选择链表的时候, 其实就已经打算不使用索引了
     * 因为在链表中是不存在索引的
     * 所以此方法当作练习即可
     * 日常工作中, 需要用到索引必须使用ArrayList
     * @param index
     * @param e
     */
    public void set(int index, E e){
        if(index < 0 || index >= size){
            throw new IllegalArgumentException("Set failed. Illegal index.");
        }

        Node cur = dummyHead.next;

        for (int i = 0; i < index; i++) {
            cur = cur.next;
        }

        cur.e = e;
    }

    /**
     * 查找链表是否包含元素e
     * @param e
     * @return
     */
    public boolean contains(E e){
        Node cur = dummyHead.next;
        while(cur != null){
            if(cur.e.equals(e)){
                return true;
            }
            cur = cur.next;
        }
        return false;
    }

    /**
     * 删除指定位置的元素
     * 注意 : 当你选择链表的时候, 其实就已经打算不使用索引了
     * 因为在链表中是不存在索引的
     * 所以此方法当作练习即可
     * 日常工作中, 需要用到索引必须使用ArrayList
     * @param index
     * @param index
     * @return
     */
    public E remove(int index){
        if(index < 0 || index >= size){
            throw new IllegalArgumentException("Remove failed. Illegal index.");
        }

        Node prev = dummyHead;

        for (int i = 0; i < index; i++) {
            prev = prev.next;
        }

        Node delNode = prev.next;
        prev.next = delNode.next;
        delNode.next = null;

        size--;

        return delNode.e;
    }

    /**
     * 从链表中删除元素e
     * @param e
     */
    public void removeElement(E e){

        Node prev = dummyHead;
        while(prev.next != null){
            if(prev.next.e.equals(e)){
                break;
            }
            prev = prev.next;
        }

        if(prev.next != null){
            Node delNode = prev.next;
            prev.next = delNode.next;
            delNode = null;
            size--;
        }
    }

    /**
     * 删除第一个元素
     * @return
     */
    public E removeFirst(){
        return remove(0);
    }

    /**
     * 删除最后一个元素
     * @return
     */
    public E removeLast(){
        return remove(size - 1);
    }



    @Override
    public String toString(){
        StringBuilder builder = new StringBuilder();
        Node cur = dummyHead.next;
        while (cur != null){
            builder.append(cur + "->");
            cur = cur.next;
        }
//        for (Node cur = dummyHead.next; cur != null; cur = cur.next) {
//            builder.append(cur + "->");
//        }
        builder.append("NULL");
        return builder.toString();
    }

    /**
     * 节点
     * 链表的内部类
     */
    private class Node {
        //数据存放在节点中
        public E e;
        //下一个节点
        public Node next;

        public Node(){
            this(null, null);
        }

        public Node(E e){
            this(e, null);
        }

        public Node(E e, Node next){
            this.e = e;
            this.next = next;
        }

        @Override
        public String toString() {
            return e.toString();
        }
    }

    public static void main(String[] args) {
        ELinkList<Integer> linkList = new ELinkList();
        for (int i = 0; i < 5; i++) {
            linkList.addFirst(i);
            System.out.println(linkList);
        }

        linkList.add(2, 666);
        System.out.println(linkList);

        linkList.remove(2);
        System.out.println(linkList);

        linkList.removeFirst();
        System.out.println(linkList);

        linkList.removeLast();
        System.out.println(linkList);
    }
}