public class CursorableLinkedList extends Object implements List, Serializable
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 FormModifier and Type | Class and Description |
---|---|
class |
CursorableLinkedList.Cursor
Deprecated.
|
Modifier and Type | Field and Description |
---|---|
protected List |
_cursors
Deprecated.
A list of the currently
CursorableLinkedList.Cursor s currently
open in this list. |
protected org.apache.commons.collections.CursorableLinkedList.Listable |
_head
Deprecated.
A sentry node.
|
protected int |
_modCount
Deprecated.
Tracks the number of structural modifications to me.
|
protected int |
_size
Deprecated.
The number of elements in me.
|
Constructor and Description |
---|
CursorableLinkedList()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
add(int index,
Object element)
Deprecated.
Inserts the specified element at the specified position in this list.
|
boolean |
add(Object o)
Deprecated.
Appends the specified element to the end of this list.
|
boolean |
addAll(Collection c)
Deprecated.
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)
Deprecated.
Inserts all of the elements in the specified collection into this
list at the specified position.
|
boolean |
addFirst(Object o)
Deprecated.
Inserts the specified element at the beginning of this list.
|
boolean |
addLast(Object o)
Deprecated.
Inserts the specified element at the end of this list.
|
protected void |
broadcastListableChanged(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Deprecated.
Informs all of my registered cursors that the specified
element was changed.
|
protected void |
broadcastListableInserted(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Deprecated.
Informs all of my registered cursors that the specified
element was just added to my list.
|
protected void |
broadcastListableRemoved(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Deprecated.
Informs all of my registered cursors that the specified
element was just removed from my list.
|
void |
clear()
Deprecated.
Removes all of the elements from this list.
|
boolean |
contains(Object o)
Deprecated.
Returns true if this list contains the specified element.
|
boolean |
containsAll(Collection c)
Deprecated.
Returns true if this list contains all of the elements of the
specified collection.
|
CursorableLinkedList.Cursor |
cursor()
Deprecated.
Returns a
ListIterator for iterating through the
elements of this list. |
CursorableLinkedList.Cursor |
cursor(int i)
Deprecated.
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 preceding it (if any). |
boolean |
equals(Object o)
Deprecated.
Compares the specified object with this list for equality.
|
Object |
get(int index)
Deprecated.
Returns the element at the specified position in this list.
|
Object |
getFirst()
Deprecated.
Returns the element at the beginning of this list.
|
Object |
getLast()
Deprecated.
Returns the element at the end of this list.
|
protected org.apache.commons.collections.CursorableLinkedList.Listable |
getListableAt(int index)
Deprecated.
Returns the
CursorableLinkedList.Listable
at the specified index. |
int |
hashCode()
Deprecated.
Returns the hash code value for this list.
|
int |
indexOf(Object o)
Deprecated.
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)
Deprecated.
Inserts a new value into my
list, after the specified before element, and before the
specified after element
|
protected void |
invalidateCursors()
Deprecated.
Informs all of my registered cursors that they are now
invalid.
|
boolean |
isEmpty()
Deprecated.
Returns true if this list contains no elements.
|
Iterator |
iterator()
Deprecated.
Returns a fail-fast iterator.
|
int |
lastIndexOf(Object o)
Deprecated.
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()
Deprecated.
Returns a fail-fast ListIterator.
|
ListIterator |
listIterator(int index)
Deprecated.
Returns a fail-fast ListIterator.
|
protected void |
registerCursor(CursorableLinkedList.Cursor cur)
Deprecated.
Registers a
CursorableLinkedList.Cursor to be notified
of changes to this list. |
Object |
remove(int index)
Deprecated.
Removes the element at the specified position in this list (optional
operation).
|
boolean |
remove(Object o)
Deprecated.
Removes the first occurrence in this list of the specified element.
|
boolean |
removeAll(Collection c)
Deprecated.
Removes from this list all the elements that are contained in the
specified collection.
|
Object |
removeFirst()
Deprecated.
Removes the first element of this list, if any.
|
Object |
removeLast()
Deprecated.
Removes the last element of this list, if any.
|
protected void |
removeListable(org.apache.commons.collections.CursorableLinkedList.Listable elt)
Deprecated.
Removes the given
CursorableLinkedList.Listable
from my list. |
boolean |
retainAll(Collection c)
Deprecated.
Retains only the elements in this list that are contained in the
specified collection.
|
Object |
set(int index,
Object element)
Deprecated.
Replaces the element at the specified position in this list with the
specified element.
|
int |
size()
Deprecated.
Returns the number of elements in this list.
|
List |
subList(int i,
int j)
Deprecated.
Returns a fail-fast sublist.
|
Object[] |
toArray()
Deprecated.
Returns an array containing all of the elements in this list in proper
sequence.
|
Object[] |
toArray(Object[] a)
Deprecated.
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()
Deprecated.
Returns a
String representation of this list, suitable for debugging. |
protected void |
unregisterCursor(CursorableLinkedList.Cursor cur)
Deprecated.
Removes a
CursorableLinkedList.Cursor from
the set of cursors to be notified of changes to this list. |
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 transient int _modCount
protected transient List _cursors
CursorableLinkedList.Cursor
s currently
open in this list.public boolean add(Object o)
add
in interface Collection
add
in interface List
o
- element to be appended to this list.public void add(int index, Object element)
add
in interface List
index
- index at which the specified element is to be inserted.element
- element to be inserted.ClassCastException
- if the class of the specified element
prevents it from being added to this list.IllegalArgumentException
- if some aspect of the specified
element prevents it from being added to this list.IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index > size()).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.)addAll
in interface Collection
addAll
in interface List
c
- collection whose elements are to be added to this list.ClassCastException
- if the class of an element in the specified
collection prevents it from being added to this list.IllegalArgumentException
- if some aspect of an element in the
specified collection prevents it from being 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.)addAll
in interface List
index
- index at which to insert first element from the specified
collection.c
- elements to be inserted into this list.ClassCastException
- if the class of one of elements of the
specified collection prevents it from being added to this
list.IllegalArgumentException
- if some aspect of one of elements of
the specified collection prevents it from being added to
this list.IndexOutOfBoundsException
- if the index is out of range (index
< 0 || index > size()).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()
clear
in interface Collection
clear
in interface List
public boolean contains(Object o)
contains
in interface Collection
contains
in interface List
o
- element whose presence in this list is to be tested.public boolean containsAll(Collection c)
containsAll
in interface Collection
containsAll
in interface List
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.
Historical Note: In previous versions of this class, the object returned from this method was required to be explicitly closed. This is no longer necessary.
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 preceding it (if any).
Unlike iterator()
, a cursor
is not bothered by concurrent modifications to the
underlying list.IndexOutOfBoundsException
- if the index is out of range (index
< 0 || index > size()).cursor()
,
listIterator(int)
,
CursorableLinkedList.Cursor
public boolean equals(Object o)
public Object get(int index)
get
in interface List
index
- index of element to return.IndexOutOfBoundsException
- if the index is out of range (index
< 0 || index >= size()).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.
hashCode
in interface Collection
hashCode
in interface List
hashCode
in class Object
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
public int indexOf(Object o)
public boolean isEmpty()
isEmpty
in interface Collection
isEmpty
in interface List
public Iterator iterator()
iterator
in interface Iterable
iterator
in interface Collection
iterator
in interface List
List.iterator()
public int lastIndexOf(Object o)
lastIndexOf
in interface List
o
- element to search for.public ListIterator listIterator()
listIterator
in interface List
List.listIterator()
public ListIterator listIterator(int index)
listIterator
in interface List
List.listIterator(int)
public boolean remove(Object o)
remove
in interface Collection
remove
in interface List
o
- element to be removed from this list, if present.public Object remove(int index)
remove
in interface List
index
- the index of the element to removed.IndexOutOfBoundsException
- if the index is out of range (index
< 0 || index >= size()).public boolean removeAll(Collection c)
removeAll
in interface Collection
removeAll
in interface List
c
- collection that defines which elements will be removed from
this list.public Object removeFirst()
public Object removeLast()
public boolean retainAll(Collection c)
retainAll
in interface Collection
retainAll
in interface List
c
- collection that defines which elements this set will retain.public Object set(int index, Object element)
set
in interface List
index
- index of element to replace.element
- element to be stored at the specified position.ClassCastException
- if the class of the specified element
prevents it from being added to this list.IllegalArgumentException
- if some aspect of the specified
element prevents it from being added to this list.IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index >= size()).public int size()
size
in interface Collection
size
in interface List
public Object[] toArray()
Collection.toArray()
method.toArray
in interface Collection
toArray
in interface List
public Object[] toArray(Object[] a)
Collection.toArray()
method.toArray
in interface Collection
toArray
in interface List
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.ArrayStoreException
- if the runtime type of the specified array
is not a supertype of the runtime type of every element in
this list.public String toString()
String
representation of this list, suitable for debugging.public List subList(int i, int j)
subList
in interface List
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.IndexOutOfBoundsException
- if index is less than zero or
greater than or equal to the size of this list.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)
Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.