list

Interface ListInterface<T>

All Known Implementing Classes:

AList

public interface ListInterface<T>

An interface for the ADT list. Entries in a list have positions that begin with 1.

Version:

4.0

Author:

Frank M. Carrano, Timothy M. Henry

Method Summary

Modifier and Type	Method and Description
void	add(int newPosition, T newEntry) Adds a new entry at a specified position within this list.
void	add(T newEntry) Adds a new entry to the end of this list.
void	clear() Removes all entries from this list.
boolean	contains(T anEntry) Sees whether this list contains a given entry.
T	getEntry(int givenPosition) Retrieves the entry at a given position in this list.
int	getLength() Gets the length of this list.
boolean	isEmpty() Sees whether this list is empty.
T	remove(int givenPosition) Removes the entry at a given position from this list.
T	replace(int givenPosition, T newEntry) Replaces the entry at a given position in this list.
java.lang.Object[]	toArray() Retrieves all entries that are in this list in the order in which they occur in the list.

Method Detail

add

void add(T newEntry)

Adds a new entry to the end of this list. Entries currently in the list are unaffected. The list's size is increased by 1.

Parameters:

newEntry - The object to be added as a new entry.

add

void add(int newPosition,
         T newEntry)

Adds a new entry at a specified position within this list. Entries originally at and above the specified position are at the next higher position within the list. The list's size is increased by 1.

Parameters:

newPosition - An integer that specifies the desired position of the new entry.

newEntry - The object to be added as a new entry.

Throws:

java.lang.IndexOutOfBoundsException - if either newPosition less than 0 or newPosition greater than getLength() + 1.

remove

T remove(int givenPosition)

Removes the entry at a given position from this list. Entries originally at positions higher than the given position are at the next lower position within the list, and the list's size is decreased by 1.

Parameters:

givenPosition - An integer that indicates the position of the entry to be removed.

Returns:

A reference to the removed entry.

Throws:

java.lang.IndexOutOfBoundsException - if either givenPosition less than 0 or givenPosition greater than getLength().

clear

void clear()

Removes all entries from this list.

replace

T replace(int givenPosition,
          T newEntry)

Replaces the entry at a given position in this list.

Parameters:

givenPosition - An integer that indicates the position of the entry to be replaced.

newEntry - The object that will replace the entry at the position givenPosition.

Returns:

The original entry that was replaced.

Throws:

java.lang.IndexOutOfBoundsException - if either givenPosition less than 0 or givenPosition greater than getLength().

getEntry

T getEntry(int givenPosition)

Retrieves the entry at a given position in this list.

Parameters:

givenPosition - An integer that indicates the position of the desired entry.

Returns:

A reference to the indicated entry.

Throws:

java.lang.IndexOutOfBoundsException - if either givenPosition less than 0 or givenPosition greater than getLength().

toArray

java.lang.Object[] toArray()

Retrieves all entries that are in this list in the order in which they occur in the list.

Returns:

A newly allocated array of all the entries in the list. If the list is empty, the returned array is empty.

contains

boolean contains(T anEntry)

Sees whether this list contains a given entry.

Parameters:

anEntry - The object that is the desired entry.

Returns:

True if the list contains anEntry, or false if not.

getLength

int getLength()

Gets the length of this list.

Returns:

The integer number of entries currently in the list.

isEmpty

boolean isEmpty()

Sees whether this list is empty.

Returns:

True if the list is empty, or false if not.