Interface ListDriverInterface

public interface ListDriverInterface

Author:

Sameh A. Fakhouri

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListDriverInterface.ListType This enum is used to specify which list implementation to use.
static class	ListDriverInterface.TestType This enum is used to specify which test scenario will be executed.

Method Summary

Modifier and Type	Method and Description
ListInterface<java.lang.Integer>	createList(ListDriverInterface.ListType listType, ListDriverInterface.TestType forTestType) This method is used to create a new list of the specified listType.
ListInterface<java.lang.Integer>	initializeList(ListInterface<java.lang.Integer> list, int firstNumber, int lastNumber, int increment) This method is called by the createList() method to initialize the list with the required elements.
double	memoryUsage() This method is used to calculate the amount of memory being used in the JVM currently.
java.lang.Object[]	runTestCase(ListDriverInterface.ListType listType, ListDriverInterface.TestType testType, int numberOfTimes) This method will run the testType on a list of type listType for numberOfTimes.

Method Detail

createList

ListInterface<java.lang.Integer> createList(ListDriverInterface.ListType listType,
                                            ListDriverInterface.TestType forTestType)

This method is used to create a new list of the specified listType. If the specified testType requires the list to be initialized to contain some elements, this method will make a call to initializeList to populate the list with the required elements.

AddSortedOdd

For this test case, this method will return an empty list.

AddSortedEven

For this test case, this method will call initializeList to populate the list with all the odd numbers from 1 to 9,999 before returning the list.

AddAll

For this test case, this method will return an empty list.

AddAllAtIndexZero

For this test case, this method will return an empty list.

RemoveAllEven

For this test case, this method will call initializeList to populate the list with all the numbers from 1 to 10,000 before returning the list.

RemoveAllOdd

For this test case, this method will call initializeList to populate the list with all the numbers from 1 to 10,000 before returning the list.

See initializeList(ListInterface, int, int, int)

Parameters:

listType - This parameter specifies the type of list to create. See the enum ListDriverInterface.ListType.

forTestType - This parameter specifies the type of test that the list is being created for. See the enum ListDriverInterface.TestType.

Returns:

The method will return the created list as a ListInterface.

initializeList

ListInterface<java.lang.Integer> initializeList(ListInterface<java.lang.Integer> list,
                                                int firstNumber,
                                                int lastNumber,
                                                int increment)

This method is called by the createList() method to initialize the list with the required elements. The list could either be an ArrayList or a LinkedList. This method will add Integer objects starting with firstNumber and ending with lastNumber incrementing each time by increment. Please note that when the increment == 0, this method does not add anything to the list.

Parameters:

list - The list to be initialized.

firstNumber - The first number to be added to the list.

lastNumber - The last number to be added to the list

increment - The increment to be used by the for loop for each iteration. If the increment is zero, this method will not add anything to the list.

Returns:

The initialized list.

memoryUsage

double memoryUsage()

This method is used to calculate the amount of memory being used in the JVM currently.

Returns:

a double representing the amount of memory in megabytes currently allocated in the JVM. Please note that you must convert from kilobytes to megabytes.

runTestCase

java.lang.Object[] runTestCase(ListDriverInterface.ListType listType,
                               ListDriverInterface.TestType testType,
                               int numberOfTimes)

This method will run the testType on a list of type listType for numberOfTimes.

Create the Object array

Create instance of TestTimes class

This method repeats the following numberOfTimes:

• Obtain and initialize a list of type listType
• Make a copy of the initialized list and place the copy in the Object array
• Capture startTime
• Run the specified testType
• Capture endTime
• Calculate testTime and add it to your TestTimes class
• Make a copy of list after testType is completed and place the copy in the Object array

Add TestTimes instance to the Object array

Return the Object array

Parameters:

listType - The type of list needed. See the enum ListDriverInterface.ListType.

testType - The type of test case being run. See the enum ListDriverInterface.TestType.

numberOfTimes - This parameter specifies the number of times to run the specified test.

Returns:

The method must return an array of Object containing the following:

• array[0] - Must contain a copy of the initialized list for the first test.
• array[1] - Must contain a copy of the list after the first test.
• array[2] - Must contain a copy of the initialized list for the second test.
• array[3] - Must contain a copy of the list after the second test.
• ...
• array[numberOfTimes*2-2] - Must contain a copy of the initialized list before for the last test.
• array[numberOfTimes*2-1] - Must contain a copy of the list after the last test.
• array[numberOfTimes*2] - Must contain the TestTimes class that was used to save the measured test times for the sorts performed.