Class BasicArrayList

java.lang.Object

BasicArrayList

All Implemented Interfaces:

BasicList

public class BasicArrayList
extends java.lang.Object
implements BasicList

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CAPACITY

Constructor Summary

Constructors

Constructor and Description
BasicArrayList() Default constructor - initializes the list to have a capacitiy equal to the DEFAULT_CAPACITY and a logical size of zero.
BasicArrayList(int capacity) Constructor - initializes the list to have the specified capacity (but never less than the DEFAULT_CAPACITY) and a logical size of 0.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, java.lang.Object o) Adds (inserts) the specfied element at the specfied index of the list - note that it does not overwrite any existing data at that location.
void	add(java.lang.Object o) Adds the specfied element to the logical end of the list.
int	capacity() Provides access to the current capacity (.length) of the private array to allow for rigorous unit testing - note that this method is not available in the Java Standard Library ArrayList class.
void	clear() Clears the list of its contents - the size of the list should be zero and its capacity should be unaffected.
boolean	contains(java.lang.Object o) Using the provided element's equals method, this method determines if the list contains the specified element or not.
java.lang.Object	get(int index) Returns a reference to the element at the specified index.
int	indexOf(java.lang.Object element) Using the provided element's equals method, this method returns the index of the first element in the list that is equal to the provided element, if any.
java.lang.Object	remove(int index) Removes (and returns) the specified element from the list.
java.lang.Object	set(int index, java.lang.Object o) Sets (replaces) the element at the specfied index.
int	size() The logical size of the list (the number of elements that have been added and not removed).
void	trimToSize() Frees up any unused space in the list by reducing the capacity of the list to its size but never less than the DEFAULT_CAPACITY.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

See Also:

Constant Field Values

Constructor Detail

BasicArrayList

public BasicArrayList()

Default constructor - initializes the list to have a capacitiy equal to the DEFAULT_CAPACITY and a logical size of zero.

BasicArrayList

public BasicArrayList(int capacity)

Constructor - initializes the list to have the specified capacity (but never less than the DEFAULT_CAPACITY) and a logical size of 0.

Parameters:

capacity - The capacity of the list. In other words, the size to allocate for your internal array.

Method Detail

add

public void add(java.lang.Object o)

Description copied from interface: BasicList

Adds the specfied element to the logical end of the list.

Specified by:

add in interface BasicList

Parameters:

o - The element to add to the logical end of the list.

add

public void add(int index,
       java.lang.Object o)

Description copied from interface: BasicList

Adds (inserts) the specfied element at the specfied index of the list - note that it does not overwrite any existing data at that location. This method does allow adding to the first index beyond the end of the list. For example, if a list had a size of 10, the index 9 is its logical end but this method allows added an element at index 10.

Specified by:

add in interface BasicList

Parameters:

index - The index to add (insert) the specfied element.

o - The element to add (insert) to the speficfied position.

Throws:

java.lang.IndexOutOfBoundsException - See BasicList interface documentation for details.

get

public java.lang.Object get(int index)

Description copied from interface: BasicList

Returns a reference to the element at the specified index.

Specified by:

get in interface BasicList

Parameters:

index - The index of the element you want to get.

Returns:

The element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - See BasicList interface documentation for details.

set

public java.lang.Object set(int index,
                   java.lang.Object o)

Description copied from interface: BasicList

Sets (replaces) the element at the specfied index.

Specified by:

set in interface BasicList

Parameters:

index - The index of the element whose you want to set (change).

Returns:

The old element (before you changed it) at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - See BasicList interface documentation for details.

remove

public java.lang.Object remove(int index)

Description copied from interface: BasicList

Removes (and returns) the specified element from the list.

Specified by:

remove in interface BasicList

Parameters:

index - The index of the element you want to remove.

Returns:

The element that was removed from the list.

Throws:

java.lang.IndexOutOfBoundsException - See BasicList interface documentation for details.

size

public int size()

Description copied from interface: BasicList

The logical size of the list (the number of elements that have been added and not removed).

Specified by:

size in interface BasicList

Returns:

The number of elements currently in the list.

contains

public boolean contains(java.lang.Object o)

Description copied from interface: BasicList

Using the provided element's equals method, this method determines if the list contains the specified element or not.

Specified by:

contains in interface BasicList

Parameters:

o - The element to search for in the list.

Returns:

true if the list constains an element logically equal to the specified element, otherwise false.

clear

public void clear()

Description copied from interface: BasicList

Clears the list of its contents - the size of the list should be zero and its capacity should be unaffected.

Specified by:

clear in interface BasicList

indexOf

public int indexOf(java.lang.Object element)

Description copied from interface: BasicList

Using the provided element's equals method, this method returns the index of the first element in the list that is equal to the provided element, if any.

Specified by:

indexOf in interface BasicList

Parameters:

element - The element to search for.

Returns:

The index of the first matching element in the list.

Throws:

java.util.NoSuchElementException - See BasicList interface documentation for details.

capacity

public int capacity()

Provides access to the current capacity (.length) of the private array to allow for rigorous unit testing - note that this method is not available in the Java Standard Library ArrayList class.

Returns:

The current capacity (.length) of the private array.

trimToSize

public void trimToSize()

Frees up any unused space in the list by reducing the capacity of the list to its size but never less than the DEFAULT_CAPACITY. This method takes advantage of the fact that the Java Garbage Collector will reclaim any memory that is no longer in use - we love the Garbage Collector!