java::util::AbstractSequentialList Class Reference

Inheritance diagram for java::util::AbstractSequentialList:

Inheritance graph
java::util::LinkedListjava::util::AbstractListjava::util::AbstractCollectionjava::util::Collectionjava::util::Listjava::lang::Interfacejava::lang::Object
[legend]
Collaboration diagram for java::util::AbstractSequentialList:

Collaboration graph
java::util::AbstractListjava::util::AbstractCollectionjava::util::Collectionjava::util::Listjava::lang::Interfacejava::lang::Object
[legend]

List of all members.


Detailed Description

This class provides a skeletal implementation of the List interface to minimize the effort required to implement this interface backed by a "sequential access" data store (such as a linked list).

For random access data (such as an array), AbstractList should be used in preference to this class.

This class is the opposite of the AbstractList class in the sense that it implements the "random access" methods (get(int index), set(int index, Object element), set(int index, Object element), add(int index, Object element) and remove(int index)) on top of the list's list iterator, instead of the other way around.

To implement a list the programmer needs only to extend this class and provide implementations for the listIterator and size methods. For an unmodifiable list, the programmer need only implement the list iterator's hasNext, next, hasPrevious, previous and index methods.

For a modifiable list the programmer should additionally implement the list iterator's set method. For a variable-size list the programmer should additionally implement the list iterator's remove and add methods.

The programmer should generally provide a void (no argument) and collection constructor, as per the recommendation in the Collection interface specification.

Author:
Josh Bloch
Version:
1.25, 12/03/01
See also:
Collection

List

AbstractList

AbstractCollection

Since:
1.2

Public Member Functions

virtual ObjectRef get (jint index) const
 Returns the element at the specified position in this list.
virtual ObjectRef set (jint index, const ObjectRef &element)
 Replaces the element at the specified position in this list with the specified element.
virtual void add (jint index, const ObjectRef &element)
 Inserts the specified element at the specified position in this list.
virtual ObjectRef remove (jint index)
 Removes the element at the specified position in this list.
virtual jboolean addAll (jint index, const Collection &c)
 Inserts all of the elements in in the specified collection into this list at the specified position.
virtual Ref
< ListIterator
listIterator (jint index=0) const =0
 Returns a list iterator over the elements in this list (in proper sequence).

Protected Member Functions

 AbstractSequentialList ()
 Sole constructor.

Constructor & Destructor Documentation

java::util::AbstractSequentialList::AbstractSequentialList (  )  [protected]

Sole constructor.

(For invocation by subclass constructors, typically implicit.)


Member Function Documentation

virtual ObjectRef java::util::AbstractSequentialList::get ( jint  index  )  const [virtual]

Returns the element at the specified position in this list.

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it gets the element using ListIterator.next and returns it.

Parameters:
index index of element to return.
Returns:
the element at the specified position in this list.
Exceptions:
IndexOutOfBoundsException if the specified index is out of range (index < 0 || index >= size()).

Implements java::util::AbstractList.

Reimplemented in java::util::LinkedList.

virtual ObjectRef java::util::AbstractSequentialList::set ( jint  index,
const ObjectRef element 
) [virtual]

Replaces the element at the specified position in this list with the specified element.

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it gets the current element using ListIterator.next and replaces it with ListIterator.set.

Note that this implementation will throw an UnsupportedOperationException if list iterator does not implement the set operation.

Parameters:
index index of element to replace.
element element to be stored at the specified position.
Returns:
the element previously at the specified position.
Exceptions:
UnsupportedOperationException set is not supported by this list.
NullPointerException this list does not permit null elements and one of the elements of c is null.
ClassCastException class of the specified element prevents it from being added to this list.
IllegalArgumentException some aspect of the specified element prevents it from being added to this list.
IndexOutOfBoundsException index out of range (index < 0 || index >= size()).
IllegalArgumentException fromIndex > toIndex.

Reimplemented from java::util::AbstractList.

Reimplemented in java::util::LinkedList.

virtual void java::util::AbstractSequentialList::add ( jint  index,
const ObjectRef element 
) [virtual]

Inserts the specified element at the specified position in this list.

Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it inserts the specified element with ListIterator.add.

Note that this implementation will throw an UnsupportedOperationException if list iterator does not implement the add operation.

Parameters:
index index at which the specified element is to be inserted.
element element to be inserted.
Exceptions:
UnsupportedOperationException if the add operation is not supported by this list.
NullPointerException this list does not permit null elements and one of the elements of c is null.
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 specified index is out of range (index < 0 || index > size()).

Reimplemented from java::util::AbstractList.

Reimplemented in java::util::LinkedList.

virtual ObjectRef java::util::AbstractSequentialList::remove ( jint  index  )  [virtual]

Removes the element at the specified position in this list.

Shifts any subsequent elements to the left (subtracts one from their indices).

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it removes the element with ListIterator.remove.

Note that this implementation will throw an UnsupportedOperationException if list iterator does not implement the remove operation.

Parameters:
index index of the element to be removed from the List.
Returns:
the element that was removed from the list.
Exceptions:
UnsupportedOperationException if the remove operation is not supported by this list.
IndexOutOfBoundsException if the specified index is out of range (index < 0 || index >= size()).

Reimplemented from java::util::AbstractList.

Reimplemented in java::util::LinkedList.

virtual jboolean java::util::AbstractSequentialList::addAll ( jint  index,
const Collection c 
) [virtual]

Inserts all of the elements in in the specified collection into this list at the specified position.

Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified 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.) Optional operation.

This implementation gets an iterator over the specified collection and a list iterator over this list pointing to the indexed element (with listIterator(index)). Then, it iterates over the specified collection, inserting the elements obtained from the iterator into this list, one at a time, using ListIterator.add followed by ListIterator.next (to skip over the added element).

Note that this implementation will throw an UnsupportedOperationException if the list iterator returned by the listIterator method does not implement the add operation.

Returns:
true if this list changed as a result of the call.
Parameters:
index index at which to insert first element from the specified collection.
c elements to be inserted into this list.
Exceptions:
UnsupportedOperationException if the addAll operation is not supported by this list.
NullPointerException this list does not permit null elements and one of the elements of the specified collection is null.
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 specified index is out of range (index < 0 || index > size()).
NullPointerException if the specified collection is null.

Reimplemented from java::util::AbstractList.

Reimplemented in java::util::LinkedList.

virtual Ref<ListIterator> java::util::AbstractSequentialList::listIterator ( jint  index = 0  )  const [pure virtual]

Returns a list iterator over the elements in this list (in proper sequence).

Parameters:
index index of first element to be returned from the list iterator (by a call to the next method)
Returns:
a list iterator over the elements in this list (in proper sequence).

Reimplemented from java::util::AbstractList.

Implemented in java::util::LinkedList.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:46 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3