structure5
Interface List<E>

All Superinterfaces:

java.lang.Iterable<E>, Structure<E>

All Known Implementing Classes:

AbstractList, CircularList, DoublyLinkedList, SinglyLinkedList, Vector

public interface List<E>
extends Structure<E>

Interface describing lists. Lists are collections of data with a head and tail. Values may be added or removed from either end, as well as by value from the middle. The structure package provides several implementations of the List interface, each of which has its particular strengths and weaknesses.

Example usage:

To place a copy of every unique parameter passed to a program into a List, we could use the following:

 public static void main(String[] arguments)
 {
     List argList = new SinglyLinkedList();
     for (int i = 0; i < arguments.length; i++){
         if (!argList.contains(arguments[i])){
             argList.add(arguments[i]);
         }
    }
    System.out.println(argList);
 }
 

See Also:

SinglyLinkedList, DoublyLinkedList, CircularList

Method Summary

void	add(E value) Add an object to tail of list.
void	add(int i, E o) Insert value at location.
void	addFirst(E value) Add a value to the head of the list.
void	addLast(E value) Add a value to tail of list.
void	clear() Remove all elements of list.
boolean	contains(E value) Check to see if a value is in list.
E	get() Retrieves value from tail of list.
E	get(int i) Get value at location i.
E	getFirst() Fetch first element of list.
E	getLast() Fetch last element of list.
int	indexOf(E value) Determine first location of a value in list.
boolean	isEmpty() Determine if list is empty.
java.util.Iterator<E>	iterator() Construct an iterator to traverse elements of list from head to tail, in order.
int	lastIndexOf(E value) Determine last location of a value in list.
E	remove() Removes value from tail of list.
E	remove(E value) Remove a value from list.
E	remove(int i) Remove and return value at location i.
E	removeFirst() Remove a value from first element of list.
E	removeLast() Remove last value from list.
E	set(int i, E o) Set value stored at location i to object o, returning old value.
int	size() Determine size of list.

Methods inherited from interface structure5.Structure

elements, values

Method Detail

size

int size()

Determine size of list.

Specified by:

size in interface Structure<E>

Returns:

The number of elements in list.

Postcondition:

returns number of elements in list

isEmpty

boolean isEmpty()

Determine if list is empty.

Specified by:

isEmpty in interface Structure<E>

Returns:

True if list has no elements.

Postcondition:

returns true iff list has no elements

clear

void clear()

Remove all elements of list.

Specified by:

clear in interface Structure<E>

Postcondition:

empties list

addFirst

void addFirst(E value)

Add a value to the head of the list.

Parameters:

value - The value to be added to the head of the list.

Postcondition:

value is added to beginning of list

addLast

void addLast(E value)

Add a value to tail of list.

Parameters:

value - The value to be added to tail of list.

Postcondition:

value is added to end of list

getFirst

E getFirst()

Fetch first element of list.

Returns:

A reference to first element of list.

Precondition:

list is not empty

Postcondition:

returns first value in list

getLast

E getLast()

Fetch last element of list.

Returns:

A reference to last element of list.

Precondition:

list is not empty

Postcondition:

returns last value in list

removeFirst

E removeFirst()

Remove a value from first element of list.

Returns:

The value actually removed.

Precondition:

list is not empty

Postcondition:

removes first value from list

removeLast

E removeLast()

Remove last value from list.

Returns:

The value actually removed.

Precondition:

list is not empty

Postcondition:

removes last value from list

remove

E remove(E value)

Remove a value from list. At most one of value will be removed.

Specified by:

remove in interface Structure<E>

Parameters:

value - The value to be removed.

Returns:

The actual value removed.

Postcondition:

removes and returns element equal to value otherwise returns null

add

void add(E value)

Add an object to tail of list.

Specified by:

add in interface Structure<E>

Parameters:

value - The value to be added to tail of list.

See Also:

addLast(E)

Postcondition:

value is added to tail of list

remove

E remove()

Removes value from tail of list.

Returns:

object removed.

Precondition:

list has at least one element

Postcondition:

removes last value found in list

get

E get()

Retrieves value from tail of list.

Returns:

object found at end of list

Precondition:

list has at least one element

Postcondition:

returns last value found in list

contains

boolean contains(E value)

Check to see if a value is in list.

Specified by:

contains in interface Structure<E>

Parameters:

value - value sought.

Returns:

True if value is within list.

Precondition:

value is not null

Postcondition:

returns true iff list contains an object equal to value

indexOf

int indexOf(E value)

Determine first location of a value in list.

Parameters:

value - The value sought.

Returns:

index (0 is first element) of value, or -1

Precondition:

value is not null

Postcondition:

returns (0-origin) index of value, or -1 if value is not found

lastIndexOf

int lastIndexOf(E value)

Determine last location of a value in list.

Parameters:

value - value sought.

Returns:

index (0 is first element) of value, or -1

Precondition:

value is not null

Postcondition:

returns (0-origin) index of value, or -1 if value is not found

get

E get(int i)

Get value at location i.

Parameters:

i - position of value to be retrieved.

Returns:

value retrieved from location i (returns null if i invalid)

Precondition:

0 <= i < size()

Postcondition:

returns object found at that location

set

E set(int i,
      E o)

Set value stored at location i to object o, returning old value.

Parameters:

i - location of entry to be changed.

o - new value

Returns:

former value of ith entry of list.

Precondition:

0 <= i < size()

Postcondition:

sets ith entry of list to value o; returns old value

add

void add(int i,
         E o)

Insert value at location.

Parameters:

i - index of this new value

o - value to be stored

Precondition:

0 <= i <= size()

Postcondition:

adds ith entry of list to value o

remove

E remove(int i)

Remove and return value at location i.

Parameters:

i - position of value to be retrieved.

Returns:

value retrieved from location i (returns null if i invalid)

Precondition:

0 <= i < size()

Postcondition:

removes and returns object found at that location

iterator

java.util.Iterator<E> iterator()

Construct an iterator to traverse elements of list from head to tail, in order.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface Structure<E>

Returns:

Iterator that traverses list.

See Also:

AbstractIterator, Iterator, Enumeration, Structure.elements()

Postcondition:

returns an iterator allowing ordered traversal of elements in list