decaf::util::AbstractSequentialList< E > Class Template Reference

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). More...

#include <src/main/decaf/util/AbstractSequentialList.h>

Inheritance diagram for decaf::util::AbstractSequentialList< E >:

[legend]

Public Member Functions

virtual ~AbstractSequentialList ()

virtual Iterator< E > * iterator ()

virtual Iterator< E > * iterator () const

virtual ListIterator< E > * listIterator ()

virtual ListIterator< E > * listIterator () const

virtual ListIterator< E > * listIterator (int index DECAF_UNUSED)

virtual ListIterator< E > * listIterator (int index DECAF_UNUSED) const

virtual E get (int index) const

Gets the element contained at position passed.

Parameters:

index

The position to get.

Returns:: value at index specified.

Exceptions:

IndexOutOfBoundsException

if the index given is less than zero or greater than the List size.

virtual E set (int index, const E &element)

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

Parameters:

	index	The index of the element to replace.
	element	The element to be stored at the specified position.

Returns:: the element previously at the specified position.

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

virtual void add (int index, const E &element)

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).

Parameters:

	index	The index at which the specified element is to be inserted.
	element	The element to be inserted in this List.

Exceptions:

	IndexOutOfBoundsException	if the index is greater than size of the List.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

virtual bool addAll (int index, const Collection< E > &source)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined 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.)

Parameters:

	index	The index at which to insert the first element from the specified collection
	source	The Collection containing elements to be added to this list

Returns:: true if this list changed as a result of the call

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

virtual E removeAt (int index)

Removes the element at the specified position in this list.Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters:

index

- the index of the element to be removed.

Returns:: the element previously at the specified position.

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.

Detailed Description

template<typename E>
class decaf::util::AbstractSequentialList< E >

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, E element), add(int index, E 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.

Since:: 1.0

Constructor & Destructor Documentation

template<typename E>

virtual decaf::util::AbstractSequentialList< E >::~AbstractSequentialList ( ) [inline, virtual]

Member Function Documentation

template<typename E>

virtual void decaf::util::AbstractSequentialList< E >::add	(	int index	,
		const E &	element
	)			`[inline, 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).

Parameters:

	index	The index at which the specified element is to be inserted.
	element	The element to be inserted in this List.

Exceptions:

	IndexOutOfBoundsException	if the index is greater than size of the List.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

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

Implements decaf::util::List< E >.

template<typename E>

virtual bool decaf::util::AbstractSequentialList< E >::addAll	(	int	index,
		const Collection< E > &	source
	)			`[inline, virtual]`

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined 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.)

Parameters:

	index	The index at which to insert the first element from the specified collection
	source	The Collection containing elements to be added to this list

Returns:: true if this list changed as a result of the call

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

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 (to skip over the added element).

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual E decaf::util::AbstractSequentialList< E >::get ( int index ) const [inline, virtual]

Gets the element contained at position passed.

Parameters:

index

The position to get.

Returns:: value at index specified.

Exceptions:

IndexOutOfBoundsException

if the index given is less than zero or greater than the List size.

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.

Implements decaf::util::List< E >.

template<typename E>

virtual Iterator<E>* decaf::util::AbstractSequentialList< E >::iterator ( ) const [inline, virtual]

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual Iterator<E>* decaf::util::AbstractSequentialList< E >::iterator ( ) [inline, virtual]

Returns:: an iterator over a set of elements of type T.

Reimplemented from decaf::util::AbstractList< E >.

Referenced by decaf::util::LinkedList< cms::Connection * >::removeFirstOccurrence().

template<typename E>

virtual ListIterator<E>* decaf::util::AbstractSequentialList< E >::listIterator ( int index DECAF_UNUSED ) const [inline, virtual]

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual ListIterator<E>* decaf::util::AbstractSequentialList< E >::listIterator ( int index index ) [inline, virtual]

Parameters:

index

index of first element to be returned from the list iterator (by a call to the next method).

Returns:: a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

Exceptions:

IndexOutOfBoundsException

if the index is out of range (index < 0 || index > size())

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual ListIterator<E>* decaf::util::AbstractSequentialList< E >::listIterator ( ) const [inline, virtual]

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual ListIterator<E>* decaf::util::AbstractSequentialList< E >::listIterator ( ) [inline, virtual]

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

Reimplemented from decaf::util::AbstractList< E >.

Referenced by decaf::util::AbstractSequentialList< cms::Connection * >::add(), decaf::util::AbstractSequentialList< cms::Connection * >::addAll(), decaf::util::AbstractSequentialList< cms::Connection * >::get(), decaf::util::AbstractSequentialList< cms::Connection * >::iterator(), decaf::util::AbstractSequentialList< cms::Connection * >::listIterator(), decaf::util::AbstractSequentialList< cms::Connection * >::removeAt(), and decaf::util::AbstractSequentialList< cms::Connection * >::set().

template<typename E>

virtual E decaf::util::AbstractSequentialList< E >::removeAt ( int index ) [inline, virtual]

Removes the element at the specified position in this list.Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters:

index

- the index of the element to be removed.

Returns:: the element previously at the specified position.

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.

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

Reimplemented from decaf::util::AbstractList< E >.

template<typename E>

virtual E decaf::util::AbstractSequentialList< E >::set	(	int index	,
		const E &	element
	)			`[inline, virtual]`

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

Parameters:

	index	The index of the element to replace.
	element	The element to be stored at the specified position.

Returns:: the element previously at the specified position.

Exceptions:

	IndexOutOfBoundsException	if the index given is less than zero or greater than the List size.
	UnsupportedOperationExceptio	if this is an unmodifiable collection.
	NullPointerException	if the Collection is a container of pointers and does not allow NULL values.
	IllegalArgumentException	if some property of the element prevents it from being added to this collection
	IllegalStateException	if the element cannot be added at this time due to insertion restrictions.

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.

Implements decaf::util::List< E >.

The documentation for this class was generated from the following file:

src/main/decaf/util/AbstractSequentialList.h

decaf::util::AbstractSequentialList< E > Class Template Reference

Public Member Functions

Detailed Description

template<typename E> class decaf::util::AbstractSequentialList< E >

Constructor & Destructor Documentation

Member Function Documentation

template<typename E>
class decaf::util::AbstractSequentialList< E >