|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.CursorableLinkedList
A doubly-linked list implementation of the List
interface,
supporting a ListIterator
that allows concurrent modifications
to the underlying list.
Implements all of the optional List
operations, the
stack/queue/dequeue operations available in LinkedList
and supports a ListIterator
that allows concurrent modifications
to the underlying list (see cursor()
).
Note that this implementation is not synchronized.
LinkedList
, Serialized FormInner Class Summary | |
class |
CursorableLinkedList.Cursor
|
Field Summary | |
protected List |
_cursors
A list of the currently CursorableLinkedList.Cursor s currently
open in this list. |
protected org.apache.commons.collections.CursorableLinkedList.Listable |
_head
A sentry node. |
protected int |
_modCount
Tracks the number of structural modifications to me. |
protected int |
_size
The number of elements in me. |
Constructor Summary | |
CursorableLinkedList()
|
Method Summary | |
void |
add(int index,
Object element)
Inserts the specified element at the specified position in this list. |
boolean |
add(Object o)
Appends the specified element to the end of this list. |
boolean |
addAll(Collection c)
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified Collection 's Iterator . |
boolean |
addAll(int index,
Collection c)
Inserts all of the elements in the specified collection into this list at the specified position. |
boolean |
addFirst(Object o)
Inserts the specified element at the beginning of this list. |
boolean |
addLast(Object o)
Inserts the specified element at the end of this list. |
protected void |
broadcastListableChanged(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Informs all of my registerd cursors that the specified element was changed. |
protected void |
broadcastListableInserted(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Informs all of my registered cursors tha the specifed element was just added to my list. |
protected void |
broadcastListableRemoved(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Informs all of my registered cursors tha the specifed element was just removed from my list. |
void |
clear()
Removes all of the elements from this list. |
boolean |
contains(Object o)
Returns true if this list contains the specified element. |
boolean |
containsAll(Collection c)
Returns true if this list contains all of the elements of the specified collection. |
CursorableLinkedList.Cursor |
cursor()
Returns a ListIterator for iterating through the
elements of this list. |
CursorableLinkedList.Cursor |
cursor(int i)
Returns a ListIterator for iterating through the
elements of this list, initialized such that
ListIterator.next() will return the element at
the specified index (if any) and ListIterator.previous()
will return the element immediately preceeding it (if any). |
boolean |
equals(Object o)
Compares the specified object with this list for equality. |
Object |
get(int index)
Returns the element at the specified position in this list. |
Object |
getFirst()
Returns the element at the beginning of this list. |
Object |
getLast()
Returns the element at the end of this list. |
protected org.apache.commons.collections.CursorableLinkedList.Listable |
getListableAt(int index)
Returns the CursorableLinkedList.Listable
at the specified index. |
int |
hashCode()
Returns the hash code value for this list. |
int |
indexOf(Object o)
Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. |
protected org.apache.commons.collections.CursorableLinkedList.Listable |
insertListable(org.apache.commons.collections.CursorableLinkedList.Listable before,
org.apache.commons.collections.CursorableLinkedList.Listable after,
Object value)
Inserts a new value into my list, after the specified before element, and before the specified after element |
protected void |
invalidateCursors()
Informs all of my registerd cursors that they are now invalid. |
boolean |
isEmpty()
Returns true if this list contains no elements. |
Iterator |
iterator()
Returns a fail-fast iterator. |
int |
lastIndexOf(Object o)
Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. |
ListIterator |
listIterator()
Returns a fail-fast ListIterator. |
ListIterator |
listIterator(int index)
Returns a fail-fast ListIterator. |
protected void |
registerCursor(CursorableLinkedList.Cursor cur)
Registers a CursorableLinkedList.Cursor to be notified
of changes to this list. |
Object |
remove(int index)
Removes the element at the specified position in this list (optional operation). |
boolean |
remove(Object o)
Removes the first occurrence in this list of the specified element. |
boolean |
removeAll(Collection c)
Removes from this list all the elements that are contained in the specified collection. |
Object |
removeFirst()
Removes the first element of this list, if any. |
Object |
removeLast()
Removes the last element of this list, if any. |
protected void |
removeListable(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Removes the given CursorableLinkedList.Listable
from my list. |
boolean |
retainAll(Collection c)
Retains only the elements in this list that are contained in the specified collection. |
Object |
set(int index,
Object element)
Replaces the element at the specified position in this list with the specified element. |
int |
size()
Returns the number of elements in this list. |
List |
subList(int i,
int j)
Returns a fail-fast sublist. |
Object[] |
toArray()
Returns an array containing all of the elements in this list in proper sequence. |
Object[] |
toArray(Object[] a)
Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. |
String |
toString()
Returns a String representation of this list, suitable for debugging. |
protected void |
unregisterCursor(CursorableLinkedList.Cursor cur)
Removes a CursorableLinkedList.Cursor from
the set of cursors to be notified of changes to this list. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected transient int _size
protected transient org.apache.commons.collections.CursorableLinkedList.Listable _head
_head.next() points to the first element in the list,
_head.prev() to the last. Note that it is possible for
_head.next().prev() and _head.prev().next() to be
non-null, as when I am a sublist for some larger list.
Use == _head.next() and == _head.prev() to determine
if a given
CursorableLinkedList.Listable
is the first or last element in the list.
protected int _modCount
protected List _cursors
CursorableLinkedList.Cursor
s currently
open in this list.Constructor Detail |
public CursorableLinkedList()
Method Detail |
public boolean add(Object o)
o
- element to be appended to this list.public void add(int index, Object element)
index
- index at which the specified element is to be inserted.element
- element to be inserted.public boolean addAll(Collection c)
Collection
's Iterator
. The behavior of this operation is
unspecified if the specified collection is modified while
the operation is in progress. (Note that this will occur if the
specified collection is this list, and it's nonempty.)c
- collection whose elements are to be added to this list.public boolean addAll(int index, Collection c)
Collection
's Iterator
. The behavior of this operation is
unspecified if the specified collection is modified while the
operation is in progress. (Note that this will occur if the specified
collection is this list, and it's nonempty.)index
- index at which to insert first element from the specified
collection.c
- elements to be inserted into this list.public boolean addFirst(Object o)
add(0,o)
).o
- element to be prepended to this list.public boolean addLast(Object o)
add(java.lang.Object)
).o
- element to be appended to this list.public void clear()
public boolean contains(Object o)
o
- element whose presence in this list is to be tested.public boolean containsAll(Collection c)
c
- collection to be checked for containment in this list.public CursorableLinkedList.Cursor cursor()
ListIterator
for iterating through the
elements of this list. Unlike iterator()
, a cursor
is not bothered by concurrent modifications to the
underlying list.
Specifically, when elements are added to the list before or
after the cursor, the cursor simply picks them up automatically.
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--i.e., it cannot be removed).
Note that the returned ListIterator
does not support the
ListIterator.nextIndex()
and ListIterator.previousIndex()
methods (they throw UnsupportedOperationException
when invoked.
Clients must close the cursor when they are done using it.
The returned ListIterator
will be an instance of
CursorableLinkedList.Cursor
. To close the cursor,
cast the ListIterator
to CursorableLinkedList.Cursor
and invoke the CursorableLinkedList.Cursor.close()
method.
cursor(int)
,
listIterator()
,
CursorableLinkedList.Cursor
public CursorableLinkedList.Cursor cursor(int i)
ListIterator
for iterating through the
elements of this list, initialized such that
ListIterator.next()
will return the element at
the specified index (if any) and ListIterator.previous()
will return the element immediately preceeding it (if any).
Unlike iterator()
, a cursor
is not bothered by concurrent modifications to the
underlying list.cursor()
,
listIterator(int)
,
CursorableLinkedList.Cursor
public boolean equals(Object o)
o
- the object to be compared for equality with this list.public Object get(int index)
index
- index of element to return.public Object getFirst()
public Object getLast()
public int hashCode()
hashCode = 1; Iterator i = list.iterator(); while (i.hasNext()) { Object obj = i.next(); hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); }This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode.
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
public int indexOf(Object o)
o
- element to search for.public boolean isEmpty()
public Iterator iterator()
List.iterator()
public int lastIndexOf(Object o)
o
- element to search for.public ListIterator listIterator()
List.listIterator()
public ListIterator listIterator(int index)
List.listIterator(int)
public boolean remove(Object o)
o
- element to be removed from this list, if present.public Object remove(int index)
index
- the index of the element to removed.public boolean removeAll(Collection c)
c
- collection that defines which elements will be removed from
this list.public Object removeFirst()
public Object removeLast()
public boolean retainAll(Collection c)
c
- collection that defines which elements this set will retain.public Object set(int index, Object element)
index
- index of element to replace.element
- element to be stored at the specified position.public int size()
public Object[] toArray()
Collection.toArray()
method.public Object[] toArray(Object[] a)
Collection.toArray()
method.a
- the array into which the elements of this list are to
be stored, if it is big enough; otherwise, a new array of the
same runtime type is allocated for this purpose.public String toString()
String
representation of this list, suitable for debugging.String
representation of this list, suitable for debugging.public List subList(int i, int j)
List.subList(int,int)
protected org.apache.commons.collections.CursorableLinkedList.Listable insertListable(org.apache.commons.collections.CursorableLinkedList.Listable before, org.apache.commons.collections.CursorableLinkedList.Listable after, Object value)
CursorableLinkedList.Listable
protected void removeListable(org.apache.commons.collections.CursorableLinkedList.Listable elt)
CursorableLinkedList.Listable
from my list.protected org.apache.commons.collections.CursorableLinkedList.Listable getListableAt(int index)
CursorableLinkedList.Listable
at the specified index.protected void registerCursor(CursorableLinkedList.Cursor cur)
CursorableLinkedList.Cursor
to be notified
of changes to this list.protected void unregisterCursor(CursorableLinkedList.Cursor cur)
CursorableLinkedList.Cursor
from
the set of cursors to be notified of changes to this list.protected void invalidateCursors()
protected void broadcastListableChanged(org.apache.commons.collections.CursorableLinkedList.Listable elt)
set(int,java.lang.Object)
protected void broadcastListableRemoved(org.apache.commons.collections.CursorableLinkedList.Listable elt)
protected void broadcastListableInserted(org.apache.commons.collections.CursorableLinkedList.Listable elt)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |