Interface ListADT<E>

All Superinterfaces:

java.lang.Iterable<E>

All Known Implementing Classes:

LinkedList

public interface ListADT<E>
extends java.lang.Iterable<E>

CS367 ListADT The official List of CS367. DO NOT EDIT OR HAND IN THIS CLASS

Method Summary

Modifier and Type	Method and Description
void	add(E item) Add item to the end of the list.
void	add(int pos, E item) Add item to the pos index of the list.
boolean	contains(E item) Returns true iff item is in the List.
E	get(int pos) Returns a reference to the item at the specified position.
boolean	isEmpty() Returns true iff the list has no items.
E	remove(int pos) removes and returns the item at position pos in the List, moving the items originally in positions pos+1 through size()-1 one place to the left to fill in the gap (error if pos is less than 0 or greater than or equal to size())
int	size() Return the number of items in the List.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

void add(E item)

Add item to the end of the list. Duplicates allowed. No null items.

Parameters:

item - The item to be added.

add

void add(int pos,
         E item)

Add item to the pos index of the list. Duplicates allowed. No null items. Inserts at that position and shifts other items. May add at the next available pos (as last item in list). Error if pos index is less than zero or greater than size().

Parameters:

pos - The index where the item will be placed.

item - The item to be added.

contains

boolean contains(E item)

Returns true iff item is in the List. (i.e. there is an item x in the List such that x.equals(item) is true.

Parameters:

item - The item to match.

Returns:

true if their is a list member that is equals to the item.

size

int size()

Return the number of items in the List.

Returns:

0 if empty or the number of non-null items in the list.

isEmpty

boolean isEmpty()

Returns true iff the list has no items.

Returns:

true if the list is empty.

get

E get(int pos)

Returns a reference to the item at the specified position. Throws OutOfBoundsException if pos is negative or greater than or equal to size().

Parameters:

pos - The index of the desired item.

Returns:

The item at that position.

remove

E remove(int pos)

removes and returns the item at position pos in the List, moving the items originally in positions pos+1 through size()-1 one place to the left to fill in the gap (error if pos is less than 0 or greater than or equal to size())

Parameters:

pos - the index of the item to remove

Returns:

the item removed

Throws:

java.lang.IndexOutOfBoundsException - if pos is less than zero or greater than size - 1