list

Class AList<T>

java.lang.Object

list.AList<T>

All Implemented Interfaces:

ListInterface<T>

public class AList<T>
extends java.lang.Object
implements ListInterface<T>

A class that implements the ADT list by using a resizable array. Entries in a list have positions that begin with 1. Duplicate entries are allowed.

Version:

4.0

Author:

Frank M. Carrano, Timothy M. Henry, maellis1, indexing to start at 0, add toString, equals, to Array, clear,

Constructor Summary

Constructors

Constructor and Description
AList() AList's default constructor, makes a list with default capacity of 25.
AList(int initialCapacity) AList's constructor where you specify the initial capacity.

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.
boolean	equals(java.lang.Object obj) maellis adding these for use in testing.
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.
java.lang.String	toString() maellis adding these for use in testing.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AList

public AList()

AList's default constructor, makes a list with default capacity of 25.

AList

public AList(int initialCapacity)

AList's constructor where you specify the initial capacity. If the number provided is smaller than the default 25, then the default is used.

Parameters:

initialCapacity - capacity for the list, unless smaller than 25

Method Detail

add

public 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.

Specified by:

add in interface ListInterface<T>

Parameters:

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

add

public 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.

Specified by:

add in interface ListInterface<T>

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

public 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.

Specified by:

remove in interface ListInterface<T>

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

public void clear()

Removes all entries from this list.

Specified by:

clear in interface ListInterface<T>

replace

public T replace(int givenPosition,
                 T newEntry)

Replaces the entry at a given position in this list.

Specified by:

replace in interface ListInterface<T>

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

public T getEntry(int givenPosition)

Retrieves the entry at a given position in this list.

Specified by:

getEntry in interface ListInterface<T>

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

public java.lang.Object[] toArray()

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

Specified by:

toArray in interface ListInterface<T>

Returns:

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

contains

public boolean contains(T anEntry)

Sees whether this list contains a given entry.

Specified by:

contains in interface ListInterface<T>

Parameters:

anEntry - The object that is the desired entry.

Returns:

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

getLength

public int getLength()

Gets the length of this list.

Specified by:

getLength in interface ListInterface<T>

Returns:

The integer number of entries currently in the list.

isEmpty

public boolean isEmpty()

Sees whether this list is empty.

Specified by:

isEmpty in interface ListInterface<T>

Returns:

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

toString

public java.lang.String toString()

maellis adding these for use in testing. If the list is empty, gives "[]". Otherwise, displays the list's entires in order separated by commas. For example, a list containing numbers might look like "[23, 6, 79, 943, 5]"

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this list

equals

public boolean equals(java.lang.Object obj)

maellis adding these for use in testing. Will return true if this list and the list given contain the same values in the same order. Otherwise, returns false.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the Object to compare this list to

Returns:

boolean representation of if this list equals obj