Interface IList<E>

Type Parameters:

E - the type of elements in this list

All Known Subinterfaces:

IArrayList<E>, ILinkedList<E>

All Known Implementing Classes:

MyArrayList, MyLinkedList

public interface IList<E>

IList.java - List interface for data structure assignment Author: Chris Wilcox Date: 2/17/2017 Class: CS165 Email: wilcox@cs.colostate.edu javadoc created or copied from oracle by garethhalladay, Fall17.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e) Appends the specified element to the end of this list.
void	add(int index, E e) Inserts the specified element at the specified position in this list.
void	clear() Removes all of the elements from this list.
boolean	contains(java.lang.Object o) Returns true if this list contains the specified element.
E	get(int index) Returns the element at the specified position in this list.
int	indexOf(java.lang.Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
boolean	isEmpty()
int	lastIndexOf(java.lang.Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
E	remove(int index) Removes the element at the specified position in this list.
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element from this list, if it is present.
void	removeRange(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
E	set(int index, E e)
int	size()

Method Detail

add

boolean add(E e)

Appends the specified element to the end of this list.

Parameters:

e - element to be appended to this list

Returns:

true (as specified by Collection.add(Object)

add

void add(int index,
         E e)

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 - index at which the specified element is to be inserted

e - element to be inserted

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

remove

boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element from this list, if it is present. If the list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters:

o - element to be removed from this list, if present

Returns:

true if this list contained the specified element

remove

E remove(int index)

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

Parameters:

index - the index of the element to be removed

Returns:

the element that was removed from the list

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

removeRange

void removeRange(int fromIndex,
                 int toIndex)

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)

Parameters:

fromIndex - index of first element to be removed

toIndex - index after last element to be removed

Throws:

java.lang.IndexOutOfBoundsException - if fromIndex or toIndex is out of range: fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex

get

E get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

set

E set(int index,
      E e)

Parameters:

index - index of the element to replace

e - element to be stored at the specified position

Returns:

the element previously at the specified position

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

contains

boolean contains(java.lang.Object o)

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).

Parameters:

o - element whose presence in this list is to be tested

Returns:

true if this list contains the specified element

indexOf

int indexOf(java.lang.Object o)

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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Parameters:

o - element to search for

Returns:

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

lastIndexOf

int lastIndexOf(java.lang.Object o)

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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Parameters:

o - element to search for

Returns:

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

clear

void clear()

Removes all of the elements from this list. The list will be empty after this call returns.

size

int size()

Returns:

Returns the number of elements in this list.

isEmpty

boolean isEmpty()

Returns:

Returns true if this list contains no elements.