myUtil

Interface MyList<T>

Type Parameters:

T - Generic type parameter.

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

MyArrayList, MyDLinkedList, MyLinkedList, MySLinkedList, NodeAndIterators, SortedArrayList

public interface MyList<T>
extends java.lang.Iterable<T>

MyList Interface for IT179, ISU. Feb. 9 2012 Modified 9/21/2012, 10/30/2014

Author:

Chung-Chih Li

Method Summary

Modifier and Type	Method and Description
void	add(int i, T item) Add (insert) item to the ith position of this MyList.
void	add(T item) Add item to the end of this List.
T	get(int i) Get the element at index i
int	indexOf(java.lang.Object item) Find the index of the input item in this MyList.
T	remove(int i) Remove the item at the ith position from this MyArrayList.
T	set(int i, T item) Replace the element at i with new one provided by the parameter item.
int	size()
java.lang.Object[]	toArray() This method return an Object array of the same size that contains every element in this MyList;
<K> K[]	toArray(K[] a) Returns an array that contains every element in this MyList.
java.lang.String	toString() Override toString method so it will return a String started and ended by [ and ], respectively, in which all elements' results of their own toString() will be concatenated according to their order in the list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

size

int size()

Returns:

the number of elements stored in this MyList.

get

T get(int i)

Get the element at index i

Parameters:

i - is an int.

Returns:

the ith elements in this MyList, where i starts from 0.

Throws:

java.lang.IndexOutOfBoundsException - will be thrown if parameter i is not a legitimate index.

set

T set(int i,
      T item)

Replace the element at i with new one provided by the parameter item.

Parameters:

i - is an int.

item - is a T.

Returns:

the old item at i.

Throws:

java.lang.IndexOutOfBoundsException - will be thrown if parameter i is not a legitimate index.

indexOf

int indexOf(java.lang.Object item)

Find the index of the input item in this MyList.

Parameters:

item - is an Object.

Returns:

the index of the first element that equals to item, -1 if not found.

add

void add(T item)

Add item to the end of this List.

Parameters:

item - is a T.

add

void add(int i,
         T item)

Add (insert) item to the ith position of this MyList.

Parameters:

i - is an int.

item - is a T.

Throws:

java.lang.IndexOutOfBoundsException - will be thrown if parameter i is not a legitimate index.

remove

T remove(int i)

Remove the item at the ith position from this MyArrayList.

Parameters:

i - is an int.

Returns:

the item that is removed.

Throws:

java.lang.IndexOutOfBoundsException - will be thrown if parameter i is not a legitimate index.

toArray

java.lang.Object[] toArray()

This method return an Object array of the same size that contains every element in this MyList;

Returns:

an Object Array

toArray

<K> K[] toArray(K[] a)

Returns an array that contains every element in this MyList. Note, the runtime type of the returned array is that of the array in the argument. If this MyList does not fit the given array, a new array with the length same as the size will be created using the type of the given array. If the given array is bigger than needed, then null will be filled in.

Type Parameters:

K - is any type

Parameters:

a - is the specific array to receive the element

Returns:

the array that has received the elements.

Throws:

java.lang.NullPointerException - will be thrown, if the specified array is null.

toString

java.lang.String toString()

Override toString method so it will return a String started and ended by [ and ], respectively, in which all elements' results of their own toString() will be concatenated according to their order in the list. If there are more than one element, they should be separated by a comma. For example, [John,Tom,Jerry]. Note, the last element should not be followed by a comma.

Overrides:

toString in class java.lang.Object

Returns:

toString() of every element in a String.