Package org.apache.ofbiz.base.util

Class UtilTimer

java.lang.Object
org.apache.ofbiz.base.util.UtilTimer
public class UtilTimer extends Object
Timer handling utility Utility class for simple reporting of the progress of a process. Steps are labelled, and the time between each label (or message) and the time since the start are reported in each call to timerString.

  • Constructor Details

    • UtilTimer

      public UtilTimer()
      Default constructor. Starts the timer.

    • UtilTimer

      public UtilTimer(String timerName, boolean start)

    • UtilTimer

      public UtilTimer(String timerName, boolean start, boolean log)

  • Method Details

    • makeTimer

      public static UtilTimer makeTimer()

    • getName

      public String getName()
      Gets name.
      Returns:
      the name

    • isRunning

      public boolean isRunning()
      Is running boolean.
      Returns:
      the boolean

    • timerString

      public String timerString(String message)
      Creates a string with information including the passed message, the last passed message and the time since the last call, and the time since the beginning
      Parameters:
      message - A message to put into the timer String
      Returns:
      A String with the timing information, the timer String

    • timerString

      public String timerString(String message, String className)
      Creates a string with information including the passed message, the last passed message and the time since the last call, and the time since the beginning
      Parameters:
      message - A message to put into the timer String
      className - The debug/log className/thread to use, can be null for root className
      Returns:
      A String with the timing information, the timer String

    • timeSinceLast

      public long timeSinceLast()
      Returns the number of milliseconds since the last time timerString was called
      Returns:
      The number of milliseconds since the last time timerString was called

    • setLog

      public void setLog(boolean log)
      Sets the value of the log member, denoting whether log output is off or not
      Parameters:
      log - The new value of log

    • getLog

      public boolean getLog()
      Gets the value of the log member, denoting whether log output is off or not
      Returns:
      The value of log

    • timerString

      public String timerString(int level, String message)
      Creates a string with information including the passed message, the time since the last call, and the time since the beginning. This version allows an integer level to be specified to improve readability of the output.
      Parameters:
      level - Integer specifying how many levels to indent the timer string so the output can be more easily read through nested method calls.
      message - A message to put into the timer String
      Returns:
      A String with the timing information, the timer String

    • timerLog

      public static void timerLog(String timerName, String message, String className)

    • closeTimer

      public static void closeTimer(String timerName)

    • closeTimer

      public static void closeTimer(String timerName, String message)

    • closeTimer

      public static void closeTimer(String timerName, String message, String className)