Module watamebot

Package net.foxgenesis.util

Class MethodTimer

java.lang.Object

net.foxgenesis.util.MethodTimer

public final class MethodTimer
extends Object

Utility class that check the amount of time it takes to run a method

Author:

Ashley

Constructor Summary

Constructors

Constructor	Description
MethodTimer()

Method Summary

Modifier and Type	Method	Description
static String	format(long time, int decimals, double div)	NEED_JAVADOC
static String	formatToMilli(long time)	NEED_JAVADOC
static String	formatToMilli(long time, int decimals)	NEED_JAVADOC
static String	formatToSeconds(long time)	NEED_JAVADOC
static String	formatToSeconds(long time, int decimals)	NEED_JAVADOC
static double	run(Runnable r)	Time how long it takes to execute Runnable r.
static double	run(Runnable r, int n)	Time how long it takes to execute Runnable r, n amount of times.
static String	runFormatMS(Runnable r)	Time how long it takes to execute Runnable r.
static String	runFormatMS(Runnable r, int decimals)	Time how long it takes to execute Runnable r.
static String	runFormatMS(Runnable r, int n, int decimals)	Time the average elapsed time it takes to execute Runnable r, n amount of times.
static String	runFormatSec(Runnable r)	Time how long it takes to execute Runnable r.
static String	runFormatSec(Runnable r, int decimals)	Time how long it takes to execute Runnable r.
static String	runFormatSec(Runnable r, int n, int decimals)	Time the average elapsed time it takes to execute Runnable r, n amount of times.
static double	runNano(Runnable r)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MethodTimer

public MethodTimer()

Method Details

runNano

public static double runNano(Runnable r)

run

public static double run(Runnable r)

Time how long it takes to execute Runnable r. Time is calculated in nano seconds and returned as milliseconds.

Parameters:

r - - Runnable to time

Returns:

elapsed time in milliseconds

See Also:

• run(Runnable, int)

run

public static double run(Runnable r,
 int n)

Time how long it takes to execute Runnable r, n amount of times. Then calculate the average elapsed time taken.

Parameters:

r - - Runnable to time

n - - Amount of times to run

Returns:

average elapsed time milliseconds

See Also:

• run(Runnable)

runFormatMS

public static String runFormatMS(Runnable r)

Time how long it takes to execute Runnable r. Time is calculated in nano seconds and returned as a formatted string with two decimal places.

This method is effectively equivalent to

 MethodTimer.runFormatMS(r, 2)
 

Parameters:

r - - Runnable to time

Returns:

formatted string with two decimal places

See Also:

• runFormatMS(Runnable, int)
• runFormatMS(Runnable, int, int)

runFormatMS

public static String runFormatMS(Runnable r,
 int decimals)

Time how long it takes to execute Runnable r. Time is calculated in nano seconds and returned as a formatted string with decimals decimal places.

This method is effectively equivalent to

 String.format("%." + decimals + "f ms", run(r))
 

Parameters:

r - - Runnable to time

decimals - - Amount of decimal places to format

Returns:

formatted string with decimals decimal places

See Also:

• runFormatMS(Runnable)
• runFormatMS(Runnable, int, int)

runFormatMS

public static String runFormatMS(Runnable r,
 int n,
 int decimals)

Time the average elapsed time it takes to execute Runnable r, n amount of times. Time is calculated in nano seconds and returned as a formatted string with decimals decimal places.

This method is effectively equivalent to

 String.format("%." + decimals + "f ms", run(r, n));
 

Parameters:

r - - Runnable to time

n - - Amount of times to execute r

decimals - - Amount of decimal places to format

Returns:

formatted string with decimals decimal places

See Also:

• runFormatMS(Runnable)
• runFormatMS(Runnable, int, int)

runFormatSec

public static String runFormatSec(Runnable r)

Time how long it takes to execute Runnable r. Time is calculated in nano seconds and returned as a formatted string with two decimal places.

This method is effectively equivalent to

 MethodTimer.runFormatMS(r, 2)
 

Parameters:

r - - Runnable to time

Returns:

formatted string with two decimal places

See Also:

• runFormatMS(Runnable, int)
• runFormatMS(Runnable, int, int)

runFormatSec

public static String runFormatSec(Runnable r,
 int decimals)

Time how long it takes to execute Runnable r. Time is calculated in nano seconds and returned as a formatted string with decimals decimal places.

This method is effectively equivalent to

 String.format("%." + decimals + "f ms", run(r))
 

Parameters:

r - - Runnable to time

decimals - - Amount of decimal places to format

Returns:

formatted string with decimals decimal places

See Also:

• runFormatMS(Runnable)
• runFormatMS(Runnable, int, int)

runFormatSec

public static String runFormatSec(Runnable r,
 int n,
 int decimals)

Time the average elapsed time it takes to execute Runnable r, n amount of times. Time is calculated in nano seconds and returned as a formatted string with decimals decimal places.

This method is effectively equivalent to

 String.format("%." + decimals + "f ms", run(r, n));
 

Parameters:

r - - Runnable to time

n - - Amount of times to execute r

decimals - - Amount of decimal places to format

Returns:

formatted string with decimals decimal places

See Also:

• runFormatMS(Runnable)
• runFormatMS(Runnable, int, int)

formatToMilli

public static String formatToMilli(long time)

NEED_JAVADOC

Parameters:

time -

Returns:

formatted string

formatToMilli

public static String formatToMilli(long time,
 int decimals)

NEED_JAVADOC

Parameters:

time -

decimals -

Returns:

formatted string

formatToSeconds

public static String formatToSeconds(long time)

NEED_JAVADOC

Parameters:

time -

Returns:

formatted string

formatToSeconds

public static String formatToSeconds(long time,
 int decimals)

NEED_JAVADOC

Parameters:

time -

decimals -

Returns:

formatted string

format

public static String format(long time,
 int decimals,
 double div)

NEED_JAVADOC

Parameters:

time -

decimals -

div -

Returns:

formatted string