Package org.ofbiz.core.util

Class UtilTimer

java.lang.Object
org.ofbiz.core.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.
Since:
2.0
Version:
$Revision: 1.1 $
Author:
David E. Jones

  • Constructor Summary

    Constructors
    Constructor
    Description
    UtilTimer()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getLog()
    Gets the value of the log member, denoting whether log output is off or not
    double
    secondsSinceLast()
    Returns the number of seconds since the last time timerString was called
    double
    secondsSinceStart()
    Returns the number of seconds since the timer started
    void
    setLog(boolean log)
    Sets the value of the log member, denoting whether log output is off or not
    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.
    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
    String
    timerString(String message, String module)
    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
    long
    timeSinceLast()
    Returns the number of milliseconds since the last time timerString was called
    long
    timeSinceStart()
    Returns the number of milliseconds since the timer started

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • UtilTimer

      public UtilTimer()
      Default constructor. Starts the timer.

  • Method Details

    • 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 module)
      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
      module - The debug/log module/thread to use, can be null for root module
      Returns:
      A String with the timing information, the timer String

    • secondsSinceStart

      public double secondsSinceStart()
      Returns the number of seconds since the timer started
      Returns:
      The number of seconds since the timer started

    • secondsSinceLast

      public double secondsSinceLast()
      Returns the number of seconds since the last time timerString was called
      Returns:
      The number of seconds since the last time timerString was called

    • timeSinceStart

      public long timeSinceStart()
      Returns the number of milliseconds since the timer started
      Returns:
      The number of milliseconds since the timer started

    • 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