Interface BasicList

All Known Implementing Classes:

BasicArrayList

public interface BasicList

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, java.lang.Object element) Adds (inserts) the specfied element at the specfied index of the list - note that it does not overwrite any existing data at that location.
void	add(java.lang.Object element) Adds the specfied element to the logical end of the list.
void	clear() Clears the list of its contents - the size of the list should be zero and its capacity should be unaffected.
boolean	contains(java.lang.Object element) Using the provided element's equals method, this method determines if the list contains the specified element or not.
java.lang.Object	get(int index) Returns a reference to the element at the specified index.
int	indexOf(java.lang.Object element) Using the provided element's equals method, this method returns the index of the first element in the list that is equal to the provided element, if any.
java.lang.Object	remove(int index) Removes (and returns) the specified element from the list.
java.lang.Object	set(int index, java.lang.Object element) Sets (replaces) the element at the specfied index.
int	size() The logical size of the list (the number of elements that have been added and not removed).

Method Detail

add

void add(java.lang.Object element)

Adds the specfied element to the logical end of the list.

Parameters:

element - The element to add to the logical end of the list.

add

void add(int index,
       java.lang.Object element)

Adds (inserts) the specfied element at the specfied index of the list - note that it does not overwrite any existing data at that location. This method does allow adding to the first index beyond the end of the list. For example, if a list had a size of 10, the index 9 is its logical end but this method allows added an element at index 10.

Parameters:

index - The index to add (insert) the specfied element.

element - The element to add (insert) to the speficfied position.

Throws:

java.lang.IndexOutOfBoundsException - when the specified index is negative or past the logical end of the list.

clear

void clear()

Clears the list of its contents - the size of the list should be zero and its capacity should be unaffected.

contains

boolean contains(java.lang.Object element)

Using the provided element's equals method, this method determines if the list contains the specified element or not.

Parameters:

element - The element to search for in the list.

Returns:

true if the list constains an element logically equal to the specified element, otherwise false.

get

java.lang.Object get(int index)

Returns a reference to the element at the specified index.

Parameters:

index - The index of the element you want to get.

Returns:

The element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - Thrown when the specified index is negative or past the logical end of the list.

indexOf

int indexOf(java.lang.Object element)

Using the provided element's equals method, this method returns the index of the first element in the list that is equal to the provided element, if any.

Parameters:

element - The element to search for.

Returns:

The index of the first matching element in the list.

Throws:

java.util.NoSuchElementException - if the list does not contain the specified element.

remove

java.lang.Object remove(int index)

Removes (and returns) the specified element from the list.

Parameters:

index - The index of the element you want to remove.

Returns:

The element that was removed from the list.

Throws:

java.lang.IndexOutOfBoundsException - Thown when the specified index is negative or past the logical end of the list.

set

java.lang.Object set(int index,
                   java.lang.Object element)

Sets (replaces) the element at the specfied index.

Parameters:

index - The index of the element whose you want to set (change).

Returns:

The old element (before you changed it) at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - Thown when the specified index is negative or past the logical end of the list.

size

int size()

The logical size of the list (the number of elements that have been added and not removed).

Returns:

The number of elements currently in the list.