Interface DriverInterface

All Known Implementing Classes:

Driver

public interface DriverInterface

This is the DriverInterface for Homework 3 of CMP-338 in the Spring 2017 semester.

Author:

Sameh A. Fakhouri

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DriverInterface.ListType This enum is used to specify which list implementation to use.
static class	DriverInterface.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(DriverInterface.ListType listType, DriverInterface.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 test list.
double	memoryUsage() This method is used to calculate the amount of memory being used in the JVM currently.
RunTime	runTestCase(DriverInterface.ListType listType, DriverInterface.TestType testType, int numberOfTimes) This method is called to run a particular test case on a list type a total of ten times.

Method Detail

createList

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

This method is used to create a new list of the specified listType. Depending on the specified testType, this method may need to initialize the list with some entries. For example, for the AddSortedOdd test case, the list will need to be initialized to contain all the even numbers from 2 to 10,000. In that case, this method will initialize the list to contain the even numbers after creating the list. See .

Parameters:

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

forTestType - This parameter specifies the type of test that the list is being created for. See the enum DriverInterface.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 test list. The test list could either be an ArrayList or a LinkedList. In either case, it will implement the ListInterface.

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, the test list is left empty.

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

RunTime runTestCase(DriverInterface.ListType listType,
                    DriverInterface.TestType testType,
                    int numberOfTimes)

This method is called to run a particular test case on a list type a total of ten times. The run time for each run is saved in the runTimes array.

Parameters:

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

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

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

Returns: