BasicList

All Superinterfaces:

java.lang.Iterable<E>

All Known Implementing Classes:

BasicLinkedList
```
public interface BasicList<E>
extends java.lang.Iterable<E>
```

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(E element)` Adds the specfied element to the logical end of the list.
`void`	`add(int index, E 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.
`BasicListIterator<E>`	`basicListIterator()` Returns a reference to a BasicListIterator over the elements in this list in the proper sequence (first-to-last order).
`void`	`clear()` Clears the list of its contents - the list should be in the same state it is after being constructed with the default constructor.
`boolean`	`contains(E element)` Using the provided element's equals method, this method determines if the list contains the specified element or not.
`E`	`get(int index)` Returns a reference to the element at the specified index.
`int`	`indexOf(E 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.util.Iterator<E>`	`iterator()` Returns a reference to a java.util.Iterator over the elements of this list in the proper sequence (first-to-last order).
`E`	`remove(int index)` Removes (and returns) the specified element from the list.
`E`	`set(int index, E element)` Replaces the element at the specified index with the specified element.
`int`	`size()` The logical size of the list (the number of elements that have been added and not removed).

- Method Detail
  - add
```
void add(E 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,
       E 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.
  - basicListIterator
```
BasicListIterator<E> basicListIterator()
```
    Returns a reference to a BasicListIterator over the elements in this list in the proper sequence (first-to-last order).
    
    Returns:
    A reference to a BasicListIterator over the elements in this list.
  - clear
```
void clear()
```
    Clears the list of its contents - the list should be in the same state it is after being constructed with the default constructor.
  - contains
```
boolean contains(E 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
```
E 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(E 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.
  - iterator
```
java.util.Iterator<E> iterator()
```
    Returns a reference to a java.util.Iterator over the elements of this list in the proper sequence (first-to-last order).
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Returns:
    An iterator over the elements of this list.
  - remove
```
E 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
```
E set(int index,
    E element)
```
    Replaces the element at the specified index with the specified element.
    
    Parameters:
    index - The index of the element whose value 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.

Interface BasicList<E>

Method Summary

Method Detail

add

add

basicListIterator

clear

contains

get

indexOf

iterator

remove

set

size