Aprog/src/net/sourceforge/aprog/tools/TicToc.java

   1 package net.sourceforge.aprog.tools;
   2
   3 import static java.lang.System.currentTimeMillis;
   4
   5 /**
   6  * Simple time measuring class to manually instrument blocks of code.
   7  * <br>Call {@link #tic()} at the beginning and {@link #toc()} at the end.
   8  * <br>{@link #getTotalTime()} gives the total time (cumulative) spent in {@link #tic()} {@link #toc()} intervals.
   9  *
  10  * @author codistmonk (creation 2013-01-25)
  11  */
  12 public final class TicToc {
  13
  14         private long totalTime;
  15
  16         private long ticTocTime;
  17
  18         private long t0;
  19
  20         /**
  21          * Starts a time interval.
  22          *
  23          * @return The current time in milliseconds
  24          */
  25         public final long tic() {
  26                 this.totalTime += this.ticTocTime;
  27                 this.ticTocTime = 0L;
  28                 return this.t0 = currentTimeMillis();
  29         }
  30
  31         /**
  32          * @return The time in milliseconds since the last call to {@link #tic()}
  33          */
  34         public final long toc() {
  35                 this.ticTocTime = currentTimeMillis() - this.t0;
  36
  37                 return this.ticTocTime;
  38         }
  39
  40         /**
  41          * @return The cumulative time of this timer (sum of tic toc intervals)
  42          */
  43         public final long getTotalTime() {
  44                 return this.totalTime + this.ticTocTime;
  45         }
  46
  47 }