--- jsr166/src/main/java/util/LinkedList.java 2005/05/21 17:33:09 1.33 +++ jsr166/src/main/java/util/LinkedList.java 2005/09/14 23:49:59 1.40 @@ -6,6 +6,7 @@ */ package java.util; +import java.util.*; // for javadoc (till 6280605 is fixed) /** * Linked list implementation of the List interface. Implements all @@ -25,18 +26,20 @@ package java.util; * list. Operations that index into the list will traverse the list from * the beginning or the end, whichever is closer to the specified index.

* - * Note that this implementation is not synchronized. If multiple - * threads access a list concurrently, and at least one of the threads - * modifies the list structurally, it must be synchronized - * externally. (A structural modification is any operation that adds or - * deletes one or more elements; merely setting the value of an element is not - * a structural modification.) This is typically accomplished by - * synchronizing on some object that naturally encapsulates the list. If no - * such object exists, the list should be "wrapped" using the - * Collections.synchronizedList method. This is best done at creation time, - * to prevent accidental unsynchronized access to the list:

- *     List list = Collections.synchronizedList(new LinkedList(...));
- * 
+ *

Note that this implementation is not synchronized. + * If multiple threads access a linked list concurrently, and at least + * one of the threads modifies the list structurally, it must be + * synchronized externally. (A structural modification is any operation + * that adds or deletes one or more elements; merely setting the value of + * an element is not a structural modification.) This is typically + * accomplished by synchronizing on some object that naturally + * encapsulates the list. + * + * If no such object exists, the list should be "wrapped" using the + * {@link Collections#synchronizedList Collections.synchronizedList} + * method. This is best done at creation time, to prevent accidental + * unsynchronized access to the list:

+ *   List list = Collections.synchronizedList(new LinkedList(...));
* *

The iterators returned by this class's iterator and * listIterator methods are fail-fast: if the list is @@ -65,7 +68,6 @@ package java.util; * @see List * @see ArrayList * @see Vector - * @see Collections#synchronizedList(List) * @since 1.2 * @param the type of elements held in this collection */ @@ -92,10 +94,10 @@ public class LinkedList * @param c the collection whose elements are to be placed into this list * @throws NullPointerException if the specified collection is null */ - public LinkedList(Collection c) { - this(); - addAll(c); - } + public LinkedList(Collection c) { + this(); + addAll(c); + } /** * Returns the first element in this list. @@ -144,19 +146,20 @@ public class LinkedList } /** - * Inserts the given element at the beginning of this list. + * Inserts the specified element at the beginning of this list. * - * @param e the element to be inserted at the beginning of this list + * @param e the element to add */ public void addFirst(E e) { addBefore(e, header.next); } /** - * Appends the given element to the end of this list. (Identical in - * function to the add method; included only for consistency.) + * Appends the specified element to the end of this list. + * + *

This method is equivalent to {@link #add}. * - * @param e the element to be inserted at the end of this list + * @param e the element to add */ public void addLast(E e) { addBefore(e, header); @@ -187,8 +190,10 @@ public class LinkedList /** * Appends the specified element to the end of this list. * + *

This method is equivalent to {@link #addLast}. + * * @param e element to be appended to this list - * @return true (as per the spec for {@link Collection#add}) + * @return true (as specified by {@link Collection#add}) */ public boolean add(E e) { addBefore(e, header); @@ -481,7 +486,7 @@ public class LinkedList * Adds the specified element as the tail (last element) of this list. * * @param e the element to add - * @return true (as per the spec for {@link Queue#offer}) + * @return true (as specified by {@link Queue#offer}) * @since 1.5 */ public boolean offer(E e) { @@ -493,7 +498,7 @@ public class LinkedList * Inserts the specified element at the front of this list. * * @param e the element to insert - * @return true (as per the spec for {@link Deque#offerFirst}) + * @return true (as specified by {@link Deque#offerFirst}) * @since 1.6 */ public boolean offerFirst(E e) { @@ -505,7 +510,7 @@ public class LinkedList * Inserts the specified element at the end of this list. * * @param e the element to insert - * @return true (as per the spec for {@link Deque#offerLast}) + * @return true (as specified by {@link Deque#offerLast}) * @since 1.6 */ public boolean offerLast(E e) { @@ -542,8 +547,8 @@ public class LinkedList } /** - * Retrieves and removes the first element of this list, or - * null if this list is empty. + * Retrieves and removes the first element of this list, + * or returns null if this list is empty. * * @return the first element of this list, or null if * this list is empty @@ -556,8 +561,8 @@ public class LinkedList } /** - * Retrieves and removes the last element of this list, or - * null if this list is empty. + * Retrieves and removes the last element of this list, + * or returns null if this list is empty. * * @return the last element of this list, or null if * this list is empty @@ -621,14 +626,14 @@ public class LinkedList */ public boolean removeLastOccurrence(Object o) { if (o==null) { - for (Entry e = header.previous; e != header; e = e.previous) { + for (Entry e = header.previous; e != header; e = e.previous) { if (e.element==null) { remove(e); return true; } } } else { - for (Entry e = header.previous; e != header; e = e.previous) { + for (Entry e = header.previous; e != header; e = e.previous) { if (o.equals(e.element)) { remove(e); return true; @@ -794,6 +799,32 @@ public class LinkedList } /** + * Returns an iterator over the elements in this list in reverse + * sequential order. The elements will be returned in order from + * last (tail) to first (head). + * + * @return an iterator over the elements in this list in reverse + * sequence + */ + public Iterator descendingIterator() { + return new DescendingIterator(); + } + + /** Adapter to provide descending iterators via ListItr.previous */ + 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(); + } + } + + /** * Returns a shallow copy of this LinkedList. (The elements * themselves are not cloned.) *