Interface StackDriverInterface

public interface StackDriverInterface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StackDriverInterface.StackType The StackType enum has the following values: ArrayBasedStack LinkedStack
static class	StackDriverInterface.TestType The StackTestType enum has the following values: Push Pop

Method Summary

Modifier and Type	Method and Description
StackInterface<java.lang.String>	createStack(StackDriverInterface.StackType stackType, StackDriverInterface.TestType stackTestType) This method is used to create a new stack of the specified stackType.
java.lang.Object[]	runTestCase(StackDriverInterface.StackType stackType, StackDriverInterface.TestType testType, int numberOfTimes) This method is called to run a particular testType on a stack of type stackType for the specified numberOfTimes.

Method Detail

createStack

StackInterface<java.lang.String> createStack(StackDriverInterface.StackType stackType,
                                             StackDriverInterface.TestType stackTestType)

This method is used to create a new stack of the specified stackType. For the stackTestType = Push, this method will return an empty stack. For the stackTestType = Pop, this method will return a stack with 10,000 String elements: "String 1", "String 2", ...., "String 10000".

Parameters:

stackType - This parameter specifies the type of stack to create. See the enum StackDriverInterface.StackType.

stackTestType - This parameter specifies the type of test that the stack is being created for. See the enum StackDriverInterface.TestType.

Returns:

The method will return the created stack as a StackInterface<String>.

runTestCase

java.lang.Object[] runTestCase(StackDriverInterface.StackType stackType,
                               StackDriverInterface.TestType testType,
                               int numberOfTimes)

This method is called to run a particular testType on a stack of type stackType for the specified numberOfTimes. The test time and memory usage for each test is saved in the TestTimes class.

This method repeats the following numberOfTimes:

• Obtain and initialize a stack of type stackType
• Make a copy of the initialized stack
• Capture startTime
• Run the specified testType
• Capture endTime
• Calculate testTime and add it to your TestTimes class
• Make a copy of stack after testType is completed

Parameters:

stackType - The type of stack needed for the test case. See the enum StackDriverInterface.StackType.

testType - The type of test case being run. See the enum StackDriverInterface.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 stack for the first test.
• array[1] - Must contain a copy of the stack after the first test.
• array[2] - Must contain a copy of the initialized stack for the second test.
• array[3] - Must contain a copy of the stack after the second test.
• ...
• array[numberOfTimes*2-2] - Must contain a copy of the initialized stack before for the last test.
• array[numberOfTimes*2-1] - Must contain a copy of the stack after the last test.
• array[numberOfTimes*2] - Must contain the TestTimes class that was used to save the measured test times and memory usages for the testType performed.