TestTimes

java.lang.Object
- TestTimes

All Implemented Interfaces:: TestTimesInterface

public class TestTimes
extends java.lang.Object
implements TestTimesInterface

Nested Class Summary
- Nested classes/interfaces inherited from interface TestTimesInterface
  TestTimesInterface.MemoryUnits, TestTimesInterface.TimeUnits

Field Summary

Fields
Modifier and Type	Field and Description
`private static double`	`BYTES_IN_KILOBYTE`
`private static double`	`BYTES_IN_MEGABYTE`
`private int`	`index`
`private TestTimesInterface.MemoryUnits`	`memoryUnits`
`private long[]`	`memoryUsages`
`private static double`	`NANO_SECONDS_IN_A_MICRO_SECOND`
`private static double`	`NANO_SECONDS_IN_A_MILLI_SECOND`
`private static double`	`NANO_SECONDS_IN_A_SECOND`
`private java.lang.Runtime`	`rt`
`private long[]`	`testTimes`
`private TestTimesInterface.TimeUnits`	`timeUnits`

Constructor Summary

Constructors
Constructor and Description

TestTimes()

Constructors
Constructor and Description
`TestTimes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTestTime(long runTime)` This method is used to add a test time and capture the current memory usage.
`private double`	`convertMemoryUsage(double memoryUsage)`
`private double`	`convertMemoryUsage(long memoryUsage)`
`private double`	`convertTestTime(double runTime)`
`private double`	`convertTestTime(long runTime)`
`double`	`getAverageMemoryUsage()` This method is used to obtain the average memory usage.
`double`	`getAverageTestTime()` This method is used to obtain the average test time.
`double`	`getLastMemoryUsage()` This method is used to retrieve the last memory usage.
`double`	`getLastTestTime()` This method is used to retrieve the last test time.
`TestTimesInterface.MemoryUnits`	`getMemoryUnits()` This method is used to obtain the current `TestTimesInterface.MemoryUnits` configured for the `RunTime` class.
`double[]`	`getMemoryUsages()` This method returns an array of double values representing the last 10 memory usages converted to the configured `TestTimesInterface.MemoryUnits`.
`double[]`	`getTestTimes()` This method returns an array of double values representing the last 10 test times converted to the configured `TestTimesInterface.TimeUnits`.
`TestTimesInterface.TimeUnits`	`getTimeUnits()` This method is used to obtain the current `TestTimesInterface.TimeUnits` configured for the `RunTime` class.
`void`	`resetTestTimes()` This method is used to reset all 10 linear search times to zero.
`void`	`setMemoryUnits(TestTimesInterface.MemoryUnits memoryUnits)` This method is used to configure the desired `TestTimesInterface.MemoryUnits`.
`void`	`setTimeUnits(TestTimesInterface.TimeUnits timeUnits)` This method is used to configure the desired `TestTimesInterface.TimeUnits`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - memoryUnits
```
private TestTimesInterface.MemoryUnits memoryUnits
```
  - timeUnits
```
private TestTimesInterface.TimeUnits timeUnits
```
  - BYTES_IN_KILOBYTE
```
private static final double BYTES_IN_KILOBYTE
```
    See Also:
    
    Constant Field Values
  - BYTES_IN_MEGABYTE
```
private static final double BYTES_IN_MEGABYTE
```
    See Also:
    
    Constant Field Values
  - NANO_SECONDS_IN_A_SECOND
```
private static final double NANO_SECONDS_IN_A_SECOND
```
    See Also:
    
    Constant Field Values
  - NANO_SECONDS_IN_A_MILLI_SECOND
```
private static final double NANO_SECONDS_IN_A_MILLI_SECOND
```
    See Also:
    
    Constant Field Values
  - NANO_SECONDS_IN_A_MICRO_SECOND
```
private static final double NANO_SECONDS_IN_A_MICRO_SECOND
```
    See Also:
    
    Constant Field Values
  - rt
```
private java.lang.Runtime rt
```
  - testTimes
```
private long[] testTimes
```
  - memoryUsages
```
private long[] memoryUsages
```
  - index
```
private int index
```
- Constructor Detail
  - TestTimes
```
public TestTimes()
```
- Method Detail
  - convertTestTime
```
private double convertTestTime(long runTime)
```
  - convertTestTime
```
private double convertTestTime(double runTime)
```
  - convertMemoryUsage
```
private double convertMemoryUsage(long memoryUsage)
```
  - convertMemoryUsage
```
private double convertMemoryUsage(double memoryUsage)
```
  - getTimeUnits
```
public TestTimesInterface.TimeUnits getTimeUnits()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to obtain the current TestTimesInterface.TimeUnits configured for the RunTime class. Please note that the default TimeUnits is NanoSeconds
    
    Specified by:
    
    getTimeUnits in interface TestTimesInterface
    
    Returns:
    
    The currently configured TimeUnits.
  - setTimeUnits
```
public void setTimeUnits(TestTimesInterface.TimeUnits timeUnits)
```
    Description copied from interface: TestTimesInterface
    
    This method is used to configure the desired TestTimesInterface.TimeUnits.
    
    Specified by:
    
    setTimeUnits in interface TestTimesInterface
    
    Parameters:
    
    timeUnits - The desired TimeUnits
  - getMemoryUnits
```
public TestTimesInterface.MemoryUnits getMemoryUnits()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to obtain the current TestTimesInterface.MemoryUnits configured for the RunTime class. Please note that the default MemoryUnits is Bytes
    
    Specified by:
    
    getMemoryUnits in interface TestTimesInterface
    
    Returns:
    
    The currently configured MemoryUnits.
  - setMemoryUnits
```
public void setMemoryUnits(TestTimesInterface.MemoryUnits memoryUnits)
```
    Description copied from interface: TestTimesInterface
    
    This method is used to configure the desired TestTimesInterface.MemoryUnits.
    
    Specified by:
    
    setMemoryUnits in interface TestTimesInterface
    
    Parameters:
    
    memoryUnits - The desired MemoryUnits
  - getLastTestTime
```
public double getLastTestTime()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to retrieve the last test time. If no test time has been added, the method will return a zero.
    
    Specified by:
    
    getLastTestTime in interface TestTimesInterface
    
    Returns:
    
    The last test time, converted to the configured TestTimesInterface.TimeUnits, or 0.
  - getLastMemoryUsage
```
public double getLastMemoryUsage()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to retrieve the last memory usage. If no test time has been added, the method will return a zero.
    
    Specified by:
    
    getLastMemoryUsage in interface TestTimesInterface
    
    Returns:
    
    The last memory usage, converted to the configured TestTimesInterface.MemoryUnits, or 0.0.
  - getTestTimes
```
public double[] getTestTimes()
```
    Description copied from interface: TestTimesInterface
    
    This method returns an array of double values representing the last 10 test times converted to the configured TestTimesInterface.TimeUnits. If less than 10 test times are available, the remaining test times should be zero. If more than 10 test times have been added, the array should contain the last 10 test times.
    
    Specified by:
    
    getTestTimes in interface TestTimesInterface
    
    Returns:
    
    An array of double values representing the last 10 test times.
  - getMemoryUsages
```
public double[] getMemoryUsages()
```
    Description copied from interface: TestTimesInterface
    
    This method returns an array of double values representing the last 10 memory usages converted to the configured TestTimesInterface.MemoryUnits. If less than 10 memory usages are available, the remaining memory usages should be zero. If more than 10 memory usages have been added, the array should contain the last 10 memory usages.
    
    Specified by:
    
    getMemoryUsages in interface TestTimesInterface
    
    Returns:
    
    An array of double values representing the last 10 memory usages.
  - resetTestTimes
```
public void resetTestTimes()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to reset all 10 linear search times to zero.
    
    Specified by:
    
    resetTestTimes in interface TestTimesInterface
  - addTestTime
```
public void addTestTime(long runTime)
```
    Description copied from interface: TestTimesInterface
    
    This method is used to add a test time and capture the current memory usage.
    
    Specified by:
    
    addTestTime in interface TestTimesInterface
    
    Parameters:
    
    runTime - a long value representing the test time in nanoseconds.
  - getAverageTestTime
```
public double getAverageTestTime()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to obtain the average test time. The method should average all the non-zero test times that are available. If no test times are available, the method returns a zero.
    
    Specified by:
    
    getAverageTestTime in interface TestTimesInterface
    
    Returns:
    
    A double value representing the average of all the non-zero test times, converted to the configured TestTimesInterface.TimeUnits or 0.
  - getAverageMemoryUsage
```
public double getAverageMemoryUsage()
```
    Description copied from interface: TestTimesInterface
    
    This method is used to obtain the average memory usage. The method should average all the non-zero memory usages that are available. If no memory usages are available, the method returns a zero.
    
    Specified by:
    
    getAverageMemoryUsage in interface TestTimesInterface
    
    Returns:
    
    A double value representing the average of all the non-zero memory usages, converted to the configured TestTimesInterface.MemoryUnits, or 0.0.

Class TestTimes

Nested Class Summary

Nested classes/interfaces inherited from interface TestTimesInterface

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

memoryUnits

timeUnits

BYTES_IN_KILOBYTE

BYTES_IN_MEGABYTE

NANO_SECONDS_IN_A_SECOND

NANO_SECONDS_IN_A_MILLI_SECOND

NANO_SECONDS_IN_A_MICRO_SECOND

rt

testTimes

memoryUsages

index

Constructor Detail

TestTimes

Method Detail

convertTestTime

convertTestTime

convertMemoryUsage

convertMemoryUsage

getTimeUnits

setTimeUnits

getMemoryUnits

setMemoryUnits

getLastTestTime

getLastMemoryUsage

getTestTimes

getMemoryUsages

resetTestTimes

addTestTime

getAverageTestTime

getAverageMemoryUsage