An ordered collection (also known as a sequence). More...

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

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

Public Member Functions
	List ()
virtual	~List ()
virtual ListIterator< E > *	listIterator ()=0
virtual ListIterator< E > *	listIterator () const =0
virtual ListIterator< E > *	listIterator (int index)=0
virtual ListIterator< E > *	listIterator (int index) const =0
virtual int	indexOf (const E &value) const =0
	Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
virtual int	lastIndexOf (const E &value) const =0
	Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
virtual E	get (int index) const =0
	Gets the element contained at position passed.
virtual E	set (int index, const E &element)=0
	Replaces the element at the specified position in this list with the specified element.
virtual void	add (int index, const E &element)=0
	Inserts the specified element at the specified position in this list.
virtual bool	addAll (int index, const Collection< E > &source)=0
	Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
virtual E	removeAt (int index)=0
	Removes the element at the specified position in this list.
Public Member Functions inherited from decaf::util::Collection< E >
virtual	~Collection ()
virtual void	copy (const Collection< E > &collection)=0
	Renders this Collection as a Copy of the given Collection.
virtual bool	add (const E &value)=0
	Returns true if this collection changed as a result of the call.
virtual bool	addAll (const Collection< E > &collection)=0
	Adds all of the elements in the specified collection to this collection.
virtual void	clear ()=0
	Removes all of the elements from this collection (optional operation).
virtual bool	contains (const E &value) const =0
	Returns true if this collection contains the specified element.
virtual bool	containsAll (const Collection< E > &collection) const =0
	Returns true if this collection contains all of the elements in the specified collection.
virtual bool	equals (const Collection< E > &value) const =0
	Compares the passed collection to this one, if they contain the same elements, i.e.
virtual bool	isEmpty () const =0
virtual bool	remove (const E &value)=0
	Removes a single instance of the specified element from the collection.
virtual bool	removeAll (const Collection< E > &collection)=0
	Removes all this collection's elements that are also contained in the specified collection (optional operation).
virtual bool	retainAll (const Collection< E > &collection)=0
	Retains only the elements in this collection that are contained in the specified collection (optional operation).
virtual int	size () const =0
	Returns the number of elements in this collection.
virtual std::vector< E >	toArray () const =0
	Returns an array containing all of the elements in this collection.
Public Member Functions inherited from decaf::lang::Iterable< E >
virtual	~Iterable ()
virtual decaf::util::Iterator < E > *	iterator ()=0
virtual decaf::util::Iterator < E > *	iterator () const =0
Public Member Functions inherited from decaf::util::concurrent::Synchronizable
virtual	~Synchronizable ()
virtual void	lock ()=0
	Locks the object.
virtual bool	tryLock ()=0
	Attempts to Lock the object, if the lock is already held by another thread than this method returns false.
virtual void	unlock ()=0
	Unlocks the object.
virtual void	wait ()=0
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	wait (long long millisecs)=0
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	wait (long long millisecs, int nanos)=0
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	notify ()=0
	Signals a waiter on this object that it can now wake up and continue.
virtual void	notifyAll ()=0
	Signals the waiters on this object that it can now wake up and continue.

Detailed Description

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

An ordered collection (also known as a sequence).

The user of this interface has precise control over where in the list each element is inserted. The user can access elements by their integer index (position in the list), and search for elements in the list.

Unlike sets, lists typically allow duplicate elements. More formally, lists typically allow pairs of elements e1 and e2 such that e1.equals(e2), and they typically allow multiple null elements if they allow null elements at all. It is not inconceivable that someone might wish to implement a list that prohibits duplicates, by throwing runtime exceptions when the user attempts to insert them, but we expect this usage to be rare.

Constructor & Destructor Documentation

template<typename E>

decaf::util::List< E >::List ( )

inline

template<typename E>

virtual decaf::util::List< E >::~List ( )

inlinevirtual

Member Function Documentation

template<typename E>

virtual void decaf::util::List< E >::add	(	int	index,
		const E &	element
	)

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

template<typename E>

virtual bool decaf::util::List< E >::addAll	(	int	index,
		const Collection< E > &	source
	)

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

template<typename E>

virtual E decaf::util::List< E >::get ( int index ) const

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

template<typename E>

virtual int decaf::util::List< E >::indexOf ( const E & value ) const

pure virtual

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

More formally, returns the lowest index i such that get(i) == value, or -1 if there is no such index.

Parameters

value The element to search for in this List.

Returns: the index of the first occurrence of the specified element in this list,

Exceptions

NullPointerException if the Collection is a container of pointers and does not allow NULL values.

template<typename E>

virtual int decaf::util::List< E >::lastIndexOf ( const E & value ) const

pure virtual

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

More formally, returns the highest index i such that get(i) == value or -1 if there is no such index.

Parameters

value The element to search for in this List.

Returns: the index of the last occurrence of the specified element in this list.

Exceptions

NullPointerException if the Collection is a container of pointers and does not allow NULL values.

template<typename E>

virtual ListIterator<E>* decaf::util::List< E >::listIterator ( )

pure virtual

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

template<typename E>

virtual ListIterator<E>* decaf::util::List< E >::listIterator ( ) const

pure virtual

template<typename E>

virtual ListIterator<E>* decaf::util::List< E >::listIterator ( int index )

pure 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())

template<typename E>

virtual ListIterator<E>* decaf::util::List< E >::listIterator ( int index ) const

pure virtual

template<typename E>

virtual E decaf::util::List< E >::removeAt ( int index )

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

template<typename E>

virtual E decaf::util::List< E >::set	(	int	index,
		const E &	element
	)

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

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

src/main/decaf/util/List.h

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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