sirius.kernel.commons

Class Watch

java.lang.Object

sirius.kernel.commons.Watch

public class Watch
extends Object

Provides a mechanism to measure the duration.

Measures the duration between start and elapsed or duration in nanosecond resolution. The returned value is however not necessarily that exact: System.nanoTime().

This is intended to replace code like:

 
             long start = System.currentTimeMillis();
             //do something
             System.out.println("Duration: "+(System.currentTimeMillis() - start));
 
 

See Also:

System.nanoTime()

Method Summary

Modifier and Type	Method and Description
String	duration() Boilerplate method for calling duration(false)
String	duration(boolean reset) Returns the formatted duration.
long	elapsed(TimeUnit unit, boolean reset) Returns the number of units since the last call to reset or start.
long	elapsedMillis() Returns the number of millis since the last call to reset or start.
void	reset() Resets the watch, so that every duration returned by this instance will be measured from this call on.
static Watch	start() Creates and starts a new watch.
void	submitMicroTiming(String category, String key) Submits the value for this watch to the Microtiming framework using the given key
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

start

public static Watch start()

Creates and starts a new watch.

Returns:

a new watch, started with the invocation of this method.

reset

public void reset()

Resets the watch, so that every duration returned by this instance will be measured from this call on.

elapsedMillis

public long elapsedMillis()

Returns the number of millis since the last call to reset or start.

Returns:

returns the number of milliseconds since the start of this watch.

elapsed

public long elapsed(TimeUnit unit,
                    boolean reset)

Returns the number of units since the last call to reset or start.

Parameters:

unit - determines the desired output unit

reset - determines if the watch should be reset, after the duration has be computed.

Returns:

returns the duration since the start of this watch in the given TimeUnit

duration

public String duration(boolean reset)

Returns the formatted duration.

This method tries to generate a string which is as short as possible. Therefore, if the duration is less than one microsecond, the number of nanoseconds is returned. If the duration is less than one millisecond, the number of microseconds (rounded) is returned. Otherwise, the value is rounded to milliseconds and returned as formatted by NLS.convertDuration(long).

Parameters:

reset - determines if the watch should be reset, after the duration has be computed.

Returns:

a string representing the duration since the last call to reset or start.

duration

public String duration()

Boilerplate method for calling duration(false)

Returns:

a string representation as generated by duration(boolean)

submitMicroTiming

public void submitMicroTiming(@Nonnull
                              String category,
                              @Nonnull
                              String key)

Submits the value for this watch to the Microtiming framework using the given key

Parameters:

category - selects the category for the given key

key - the key used to store the elapsed time for

toString

public String toString()

Overrides:

toString in class Object