org.apache.commons.collections.list
public abstract class AbstractLinkedList extends Object implements List
Overridable methods are provided to change the storage node and to change how nodes are added to and removed. Hopefully, all you need for unusual subclasses is here.
Since: Commons Collections 3.0
Version: $Revision: 219343 $ $Date: 2005-07-16 18:08:16 +0100 (Sat, 16 Jul 2005) $
Nested Class Summary | |
---|---|
protected static class | AbstractLinkedList.LinkedListIterator
A list iterator over the linked list. |
protected static class | AbstractLinkedList.LinkedSubList
The sublist implementation for AbstractLinkedList. |
protected static class | AbstractLinkedList.LinkedSubListIterator
A list iterator over the linked sub list. |
protected static class | AbstractLinkedList.Node
A node within the linked list.
|
Field Summary | |
---|---|
protected AbstractLinkedList.Node | header
A Node which indicates the start and end of the list and does not
hold a value. |
protected int | modCount Modification count for iterators |
protected int | size The size of the list |
Constructor Summary | |
---|---|
protected | AbstractLinkedList()
Constructor that does nothing intended for deserialization.
|
protected | AbstractLinkedList(Collection coll)
Constructs a list copying data from the specified collection.
|
Method Summary | |
---|---|
boolean | add(Object value) |
void | add(int index, Object value) |
boolean | addAll(Collection coll) |
boolean | addAll(int index, Collection coll) |
boolean | addFirst(Object o) |
boolean | addLast(Object o) |
protected void | addNode(AbstractLinkedList.Node nodeToInsert, AbstractLinkedList.Node insertBeforeNode)
Inserts a new node into the list.
|
protected void | addNodeAfter(AbstractLinkedList.Node node, Object value)
Creates a new node with the specified object as its
value and inserts it after node .
|
protected void | addNodeBefore(AbstractLinkedList.Node node, Object value)
Creates a new node with the specified object as its
value and inserts it before node .
|
void | clear() |
boolean | contains(Object value) |
boolean | containsAll(Collection coll) |
protected AbstractLinkedList.Node | createHeaderNode()
Creates a new node with previous, next and element all set to null.
|
protected AbstractLinkedList.Node | createNode(Object value)
Creates a new node with the specified properties.
|
protected Iterator | createSubListIterator(AbstractLinkedList.LinkedSubList subList)
Creates an iterator for the sublist.
|
protected ListIterator | createSubListListIterator(AbstractLinkedList.LinkedSubList subList, int fromIndex)
Creates a list iterator for the sublist.
|
protected void | doReadObject(ObjectInputStream inputStream)
Deserializes the data held in this object to the stream specified.
|
protected void | doWriteObject(ObjectOutputStream outputStream)
Serializes the data held in this object to the stream specified.
|
boolean | equals(Object obj) |
Object | get(int index) |
Object | getFirst() |
Object | getLast() |
protected AbstractLinkedList.Node | getNode(int index, boolean endMarkerAllowed)
Gets the node at a particular index.
|
int | hashCode() |
int | indexOf(Object value) |
protected void | init()
The equivalent of a default constructor, broken out so it can be called
by any constructor and by readObject .
|
boolean | isEmpty() |
protected boolean | isEqualValue(Object value1, Object value2)
Compares two values for equals.
|
Iterator | iterator() |
int | lastIndexOf(Object value) |
ListIterator | listIterator() |
ListIterator | listIterator(int fromIndex) |
Object | remove(int index) |
boolean | remove(Object value) |
boolean | removeAll(Collection coll) |
protected void | removeAllNodes()
Removes all nodes by resetting the circular list marker. |
Object | removeFirst() |
Object | removeLast() |
protected void | removeNode(AbstractLinkedList.Node node)
Removes the specified node from the list.
|
boolean | retainAll(Collection coll) |
Object | set(int index, Object value) |
int | size() |
List | subList(int fromIndexInclusive, int toIndexExclusive)
Gets a sublist of the main list.
|
Object[] | toArray() |
Object[] | toArray(Object[] array) |
String | toString() |
protected void | updateNode(AbstractLinkedList.Node node, Object value)
Updates the node with a new value.
|
next
is the first item in the
list. The value of of previous
is the last item in the list.If this constructor is used by a serializable subclass then the init() method must be called.
Parameters: coll the collection to copy
Parameters: nodeToInsert new node to insert insertBeforeNode node to insert before
Throws: NullPointerException if either node is null
value
and inserts it after node
.
This implementation uses createNode and addNode.
Parameters: node node to insert after value value of the newly added node
Throws: NullPointerException if node
is null
value
and inserts it before node
.
This implementation uses createNode and addNode.
Parameters: node node to insert before value value of the newly added node
Throws: NullPointerException if node
is null
Returns: newly created node
Parameters: value value of the new node
Parameters: subList the sublist to get an iterator for
Parameters: subList the sublist to get an iterator for fromIndex the index to start from, relative to the sublist
The first serializable subclass must call this method from
readObject
.
The first serializable subclass must call this method from
writeObject
.
Parameters: index the index, starting from 0 endMarkerAllowed whether or not the end marker can be returned if startIndex is set to the list's size
Throws: IndexOutOfBoundsException if the index is less than 0; equal to the size of the list and endMakerAllowed is false; or greater than the size of the list
readObject
.
Subclasses which override this method should make sure they call super,
so the list is initialised properly.Parameters: value1 the first value to compare, may be null value2 the second value to compare, may be null
Returns: true if equal
Parameters: node the node to remove
Throws: NullPointerException if node
is null
Parameters: fromIndexInclusive the index to start from toIndexExclusive the index to end at
Returns: the new sublist
Parameters: node node to update value new value of the node