/*

   * Copyright 1997-2006 Sun Microsystems, Inc.  All Rights Reserved.

   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

   *

   * This code is free software; you can redistribute it and/or modify it

   * under the terms of the GNU General Public License version 2 only, as

   * published by the Free Software Foundation.  Sun designates this

   * particular file as subject to the "Classpath" exception as provided

   * by Sun in the LICENSE file that accompanied this code.

  *

  * This code is distributed in the hope that it will be useful, but WITHOUT

  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

  * version 2 for more details (a copy is included in the LICENSE file that

  * accompanied this code).

  *

  * You should have received a copy of the GNU General Public License version

  * 2 along with this work; if not, write to the Free Software Foundation,

  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

  *

  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

  * CA 95054 USA or visit www.sun.com if you need additional information or

  * have any questions.

  */

 package java.util;

 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;

    }

    

    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);

    }

    

    public boolean contains(Object o) {

        return indexOf(o) != -1;

    }

    

    public int size() {

        return size;

    }

    

    public boolean add(E e) {

        addBefore(e, header);

        return true;

    }

    

    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;

    }

    

    public boolean addAll(Collection<? extends E> c) {

        return addAll(size, c);

    }

    

    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<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;

    }

    

    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

    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

    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

    public boolean offerFirst(E e) {

        addFirst(e);

        return true;

    }

    

    public boolean offerLast(E e) {

        addLast(e);

        return true;

    }

    

    public E peekFirst() {

        if (size==0)

            return null;

        return getFirst();

    }

    

    public E peekLast() {

        if (size==0)

            return null;

        return getLast();

    }

    

    public E pollFirst() {

        if (size==0)

            return null;

        return removeFirst();

    }

    

    public E pollLast() {

        if (size==0)

            return null;

        return removeLast();

    }

    

    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) {

        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;

    }

    

    public ListIterator<E> listIterator(int index) {

        return new ListItr(index);

    }

    private class ListItr implements ListIterator<E> {

        private Entry<E> lastReturned = header;

        private Entry<E> next;

        private int nextIndex;

        private int expectedModCount = modCount;

        ListItr(int index) {

            if (index < 0 || index > size)

                throw new IndexOutOfBoundsException("Index: "+index+

                                                    ", Size: "+size);

            if (index < (size >> 1)) {

                next = header.next;

                for (nextIndex=0; nextIndex<index; nextIndex++)

                    next = next.next;

            } else {

                next = header;

                for (nextIndex=size; nextIndex>index; nextIndex--)

                    next = next.previous;

            }

        }

        public boolean hasNext() {

            return nextIndex != size;

        }

        public E next() {

            checkForComodification();

            if (nextIndex == size)

                throw new NoSuchElementException();

            lastReturned = next;

            next = next.next;

            nextIndex++;

            return lastReturned.element;

        }

        public boolean hasPrevious() {

            return nextIndex != 0;

        }

        public E previous() {

            if (nextIndex == 0)

                throw new NoSuchElementException();

            lastReturned = next = next.previous;

            nextIndex--;

            checkForComodification();

            return lastReturned.element;

        }

        public int nextIndex() {

            return nextIndex;

        }

        public int previousIndex() {

            return nextIndex-1;

        }

        public void remove() {

            checkForComodification();

            Entry<E> lastNext = lastReturned.next;

            try {

                LinkedList.this.remove(lastReturned);

            } catch (NoSuchElementException e) {

                throw new IllegalStateException();

            }

            if (next==lastReturned)

                next = lastNext;

            else

                nextIndex--;

            lastReturned = header;

            expectedModCount++;

        }

        public void set(E e) {

            if (lastReturned == header)

                throw new IllegalStateException();

            checkForComodification();

            lastReturned.element = e;

        }

        public void add(E e) {

            checkForComodification();

            lastReturned = header;

            addBefore(e, next);

            nextIndex++;

            expectedModCount++;

        }

        final void checkForComodification() {

            if (modCount != expectedModCount)

                throw new ConcurrentModificationException();

        }

    }

    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;

        }

    }

    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;

    }

    private E remove(Entry<E> e) {

        if (e == header)

            throw new NoSuchElementException();

        E result = e.element;

        e.previous.next = e.next;

        e.next.previous = e.previous;

        e.next = e.previous = null;

        e.element = null;

        size--;

        modCount++;

        return result;

    }

    

    public Iterator<E> descendingIterator() {

        return new DescendingIterator();

    }

    

    private class DescendingIterator implements Iterator {

        final ListItr itr = new ListItr(size());

        public boolean hasNext() {

            return itr.hasPrevious();

        }

        public E next() {

            return itr.previous();

        }

        public void remove() {

            itr.remove();

        }

    }

    

    public Object clone() {

        LinkedList<E> clone = null;

        try {

            clone = (LinkedList<E>) super.clone();

        } catch (CloneNotSupportedException e) {

            throw new InternalError();

        }

        // Put clone into "virgin" state

        clone.header = new Entry<E>(null, null, null);

        clone.header.next = clone.header.previous = clone.header;

        clone.size = 0;

        clone.modCount = 0;

        // Initialize clone with our elements

        for (Entry<E> e = header.next; e != header; e = e.next)

            clone.add(e.element);

        return clone;

    }

    

    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;

    }

    

    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;

    }