myUtil

Class SortedArrayList<T extends java.lang.Comparable<T>>

java.lang.Object

myUtil.MyArrayList<T>

myUtil.SortedArrayList<T>

Type Parameters:

T - has to be comparable

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<T>, java.util.RandomAccess, MyList<T>

public class SortedArrayList<T extends java.lang.Comparable<T>>
extends MyArrayList<T>

Author:

Chung-Chih Li, 2/14/2016 Modified: 2/8/2017, 2/6/2018 change from extending ArrayList to MyArrayList This object uses an internal array to store Comparable objects in ascending order determined by their compareTo method.

Constructor Summary

Constructors

Constructor and Description
SortedArrayList()
SortedArrayList(int capacity) This constructor will set the internal array to a Comparable Object array of size specified by the user.
SortedArrayList(SortedArrayList<T> s) This is a copy constructor

Method Summary

Modifier and Type	Method and Description
void	add(int i, T item) Add (insert) item to the ith position if the insertion maintains the array sorted, if not, the item will not be added and an IllegalArgumentException will be thrown.
void	add(T item) Add item to the end of this List.
int	indexOf(java.lang.Object item) Find the index of the input Object in this SortedArrayList.
T	set(int i, T item) Set (insert) item to the ith position if the new item is not out of order; otherwise an IllegalArgumentException will be thrown.

Methods inherited from class myUtil.MyArrayList

clone, get, iterator, remove, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SortedArrayList

public SortedArrayList()

SortedArrayList

public SortedArrayList(int capacity)

This constructor will set the internal array to a Comparable Object array of size specified by the user.

Parameters:

capacity - is the initial size of the internal array

SortedArrayList

public SortedArrayList(SortedArrayList<T> s)

This is a copy constructor

Parameters:

s - is a SortedArrayList

Method Detail

add

public void add(T item)

Description copied from interface: MyList

Add item to the end of this List.

Specified by:

add in interface MyList<T extends java.lang.Comparable<T>>

Overrides:

add in class MyArrayList<T extends java.lang.Comparable<T>>

Parameters:

item - will be inserted into the right place to maintain the order

See Also:

MyList.add(java.lang.Object)

add

public void add(int i,
                T item)

Add (insert) item to the ith position if the insertion maintains the array sorted, if not, the item will not be added and an IllegalArgumentException will be thrown.

Specified by:

add in interface MyList<T extends java.lang.Comparable<T>>

Overrides:

add in class MyArrayList<T extends java.lang.Comparable<T>>

Parameters:

i - is an index.

item - is an object T to be inserted at i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - will be thrown if parameter i is not an legitimate index, i.e, when i is a negative number or greater than size.

java.lang.IllegalArgumentException - will be thrown if the item can't be inserted into the position, i.e, the insertion will cause the item in the array out of order.

See Also:

MyList.add(int, java.lang.Object)

set

public T set(int i,
             T item)

Set (insert) item to the ith position if the new item is not out of order; otherwise an IllegalArgumentException will be thrown.

Specified by:

set in interface MyList<T extends java.lang.Comparable<T>>

Overrides:

set in class MyArrayList<T extends java.lang.Comparable<T>>

Parameters:

i - is an index.

item - is an object T to be set at i.

Returns:

the old item at i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - will be thrown if parameter i is not an legitimate index, i.e, when i is a negative number or greater than size.

java.lang.IllegalArgumentException - will be thrown if the item is out of order.

See Also:

MyList.set(int, java.lang.Object)

indexOf

public int indexOf(java.lang.Object item)

Find the index of the input Object in this SortedArrayList. Note to Student: A binary search should be used.

Specified by:

indexOf in interface MyList<T extends java.lang.Comparable<T>>

Overrides:

indexOf in class MyArrayList<T extends java.lang.Comparable<T>>

Parameters:

item - is an Object.

Returns:

the index where the element is equal to item (using compareTo == 0), -1 if not found.