Java Doc for CursorableLinkedList.java in  » Library » Apache-common-Collections » org » apache » commons » collections » list » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This implementation supports all of the optional List operations. It extends AbstractLinkedList and thus provides the stack/queue/dequeue operations available in java.util.LinkedList .

The main feature of this class is the ability to modify the list and the iterator at the same time. Both the CursorableLinkedList.listIterator() and CursorableLinkedList.cursor() methods provides access to a Cursor instance which extends ListIterator. The cursor allows changes to the list concurrent with changes to the iterator. Note that the CursorableLinkedList.iterator() method and sublists do not provide this cursor behaviour.

The Cursor class is provided partly for backwards compatibility and partly because it allows the cursor to be directly closed. Closing the cursor is optional because references are held via a WeakReference. For most purposes, simply modify the iterator and list at will, and then let the garbage collector to the rest.

Note that this implementation is not synchronized.
See Also:   java.util.LinkedList
since:
   Commons Collections 1.0
version:
   $Revision: 348013 $ $Date: 2005-11-21 23:24:45 +0000 (Mon, 21 Nov 2005) $
author:
   Rodney Waldhoff
author:
   Janek Bogucki
author:
   Simon Kitching
author:
   Stephen Colebourne

A Cursor is a ListIterator with an additional close() method.

A Cursor is a ListIterator with an additional close() method.

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread).

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread).

A Cursor is a ListIterator with an additional close() method. Calling this method immediately discards the references to the cursor. If it is not called, then the garbage collector will still remove the reference as it is held via a WeakReference.

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread). When elements are added to the list, an event is fired to all active cursors enabling them to adjust to the change in the list.

When the "current" (i.e., last returned by ListIterator.next or ListIterator.previous ) element of the list is removed, the cursor automatically adjusts to the change (invalidating the last returned value such that it cannot be removed).

The CursorableLinkedList.listIterator() method returns the same as this method, and can be cast to a Cursor if the close method is required. a new cursor iterator

A Cursor is a ListIterator with an additional close() method. Calling this method immediately discards the references to the cursor. If it is not called, then the garbage collector will still remove the reference as it is held via a WeakReference.

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread). When elements are added to the list, an event is fired to all active cursors enabling them to adjust to the change in the list.

When the "current" (i.e., last returned by ListIterator.next or ListIterator.previous ) element of the list is removed, the cursor automatically adjusts to the change (invalidating the last returned value such that it cannot be removed).

The CursorableLinkedList.listIterator(int) method returns the same as this method, and can be cast to a Cursor if the close method is required.
Parameters:
  fromIndex - the index to start from a new cursor iterator
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index > size()).

If the underlying list is modified while iterating using this iterator a ConcurrentModificationException will occur. The cursor behaviour is available via CursorableLinkedList.listIterator() . a new iterator that does not support concurrent modification

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread). When elements are added to the list, an event is fired to all active cursors enabling them to adjust to the change in the list.

When the "current" (i.e., last returned by ListIterator.next or ListIterator.previous ) element of the list is removed, the cursor automatically adjusts to the change (invalidating the last returned value such that it cannot be removed). a new cursor iterator

The cursor enables iteration and list changes to occur in any order without invalidating the iterator (from one thread). When elements are added to the list, an event is fired to all active cursors enabling them to adjust to the change in the list.

When the "current" (i.e., last returned by ListIterator.next or ListIterator.previous ) element of the list is removed, the cursor automatically adjusts to the change (invalidating the last returned value such that it cannot be removed).
Parameters:
  fromIndex - the index to start from a new cursor iterator