CodeStopWatch

A Java library that helps developers benchmark their code

Usage

Using CodeStopWatch is so simple, first of all you add it to your POM file:

<dependency>
    <groupId>ps.purelogic</groupId>
    <artifactId>CodeStopWatch</artifactId>
    <version>1</version>
</dependency>

Android Implementation

Update your settings.gradle file with the following dependency.

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // this one
    }
}

Update your module level build.gradle file with the following dependency.

dependencies {
 implementation 'com.github.mkhoudary:CodeStopWatch:-SNAPSHOT'
}

Now you can use CodeStopWatch in one of the following use cases.

Testing Code Speed as a Whole

You can test any code speed with stopwatch by using benchmark method as follows:

long totalTimeInMillis = CodeStopWatch.instance().benchmark("Your Purpose of testing", () -> {
            //Your testing code goes here
        });

Then after you're done you can call:

CodeStopWatch.instance().print();

Testing Code Speed with Marks

You can mark parts of code as you go to benchmark which part is slow or suffering from poor performance:

CodeStopWatch.instance().start("We want to test some code");
//Code block 1
CodeStopWatch.instance().mark("Finished executing block 1");
//Code block 2
CodeStopWatch.instance().mark("Finished executing block 2");
//Code block 3
CodeStopWatch.instance().mark("Finished executing block 3");
//Code block 4
CodeStopWatch.instance().mark("Finished executing block 4");

long totalRunTimeInMillis = CodeStopWatch.instance().stop();

CodeStopWatch.instance().print();

Print output in console or in log file will look like this:

INFO: Stopwatch for We want to test some code started in 10/4/22 7:38 PM
INFO: -----------------------------------------
INFO: Finished executing block 1	10/4/22 7:38 PM	1.01s
INFO: Finished executing block 2	10/4/22 7:38 PM	1.20s
INFO: Finished executing block 3	10/4/22 7:38 PM	0.81s
INFO: Finished executing block 4	10/4/22 7:42 PM	2.00s
INFO: -----------------------------------------
INFO: Stopwatch for We want to test some code stopped in 10/4/22 7:38 PM after 5.01s

Testing Multiple Scenarios

You can compare multiple scenarios using the compare method as follows:

CodeStopWatch.instance().compare("Testing some code", () -> {
            //Scenario 1 code
        }, () -> {
            //Scenario 2 code
        }, () -> {
            //Scenario 3 code
        });
        
CodeStopWatch.instance().print()

Execution result will look like this:

INFO: Stopwatch for Testing some code started in 10/4/22 7:59 PM
INFO: -----------------------------------------
INFO: Executing scenario 1	10/4/22 7:59 PM	0.01s
INFO: Finished executing scenario 1	10/4/22 7:59 PM	1.00s
INFO: Executing scenario 2	10/4/22 7:59 PM	0.00s
INFO: Finished executing scenario 2	10/4/22 7:59 PM	1.50s
INFO: Executing scenario 3	10/4/22 7:59 PM	0.00s
INFO: Finished executing scenario 3	10/4/22 7:59 PM	2.00s
INFO: -----------------------------------------
INFO: Stopwatch for Testing some code stopped in 10/4/22 7:59 PM after 4.51s

Conditional warnings using printIfExceeds

You can use printIfExceeds(long timeTakenInMillis) to optionally print to log the stopwatch result if and only if the overall time taken exceeds the entered time in milliseconds.

Other Utility Methods

Method	Descrption
reset	Resets stopwatch parameters
destroy	Destroys current instance
entries	Returns a list of StopWatchEntry which contains timestamp for mark, timeFromLastMark, message

CodeStopWatch and Threads

CodeStopWatch runs an instance for each thread, running CodeStopWatch among multiple threads will spawn an instance for each thread while benchmarking, this helps in using CodeStopWatch in J2EE environment for example along with a request lifecycle listener and make it begin when request begins and finishes when it finishes, and allowing it to be used throughout application without worrying about threading.

mkhoudary/CodeStopWatch