eu.fthevenet.util.logging

Class Profiler

java.lang.Object

eu.fthevenet.util.logging.Profiler

All Implemented Interfaces:

java.lang.AutoCloseable

public final class Profiler
extends java.lang.Object
implements java.lang.AutoCloseable

A utility class that measures and reports the execution time of a portion of code.

A time interval is measured from the creation of the object to its closing. It implements AutoCloseable and can be used in conjunction with a try-with-resource statement to measure the amount of time totalTime from entering to exiting the try block.

Author:

Frederic Thevenet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Profiler.Elapsed A class that encapsulate the interval measured by a Profiler object.
static interface	Profiler.OutputDelegate A functional interface that represents the action to output the measured interval (for compatibility with < 1.8)

Method Summary

Modifier and Type	Method and Description
void	close()
static Profiler	start(Profiler.Elapsed elapsed) Returns a new instance of the Profiler class.
static Profiler	start(Profiler.Elapsed elapsed, long threshold) Returns a new instance of the Profiler class.
static Profiler	start(Profiler.OutputDelegate writeCallback) Returns a new instance of the Profiler class.
static Profiler	start(Profiler.OutputDelegate writeCallback, long threshold) Returns a new instance of the Profiler class.
static Profiler	start(java.lang.String message) Returns a new instance of the Profiler class.
static Profiler	start(java.lang.String message, long threshold) Returns a new instance of the Profiler class.
static Profiler	start(java.lang.String message, Profiler.OutputDelegate writeCallback) Returns a new instance of the Profiler class.
static Profiler	start(java.lang.String message, Profiler.OutputDelegate writeCallback, long threshold) Returns a new instance of the Profiler class.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static Profiler start(java.lang.String message,
                             Profiler.OutputDelegate writeCallback)

Returns a new instance of the Profiler class.

Parameters:

message - The message associated to the perf totalTime.

writeCallback - The callback that will be invoked to log the results of the totalTime.

Returns:

The new instance of the Profiler class

start

public static Profiler start(java.lang.String message,
                             Profiler.OutputDelegate writeCallback,
                             long threshold)

Returns a new instance of the Profiler class.

Parameters:

message - The message associated to the perf totalTime.

writeCallback - The callback that will be invoked to log the results of the totalTime.

threshold - If the elapsed time is greater or equal to that threshold value (in ms) the message is logged otherwise it isn't.

Returns:

The new instance of the Profiler class

start

public static Profiler start(java.lang.String message)

Returns a new instance of the Profiler class.

Parameters:

message - The message associated to the perf totalTime.

Returns:

The newly created Profiler instance.

start

public static Profiler start(java.lang.String message,
                             long threshold)

Returns a new instance of the Profiler class.

Parameters:

message - The message associated to the perf totalTime.

threshold - If the elapsed time is greater or equal to that threshold value (in ms) the message is logged otherwise it isn't.

Returns:

The newly created Profiler instance.

start

public static Profiler start(Profiler.OutputDelegate writeCallback)

Returns a new instance of the Profiler class.

Parameters:

writeCallback - The callback that will be invoked to log the results of the totalTime.

Returns:

The new instance of the Profiler class.

start

public static Profiler start(Profiler.OutputDelegate writeCallback,
                             long threshold)

Returns a new instance of the Profiler class.

Parameters:

writeCallback - The callback that will be invoked to log the results of the totalTime.

threshold - If the elapsed time is greater or equal to that threshold value (in ms) the message is logged otherwise it isn't.

Returns:

The new instance of the Profiler class.

start

public static Profiler start(Profiler.Elapsed elapsed)

Returns a new instance of the Profiler class.

Parameters:

elapsed - A Elapsed object that will be used to store the results of the totalTime.

Returns:

The newly created Profiler instance.

start

public static Profiler start(Profiler.Elapsed elapsed,
                             long threshold)

Returns a new instance of the Profiler class.

Parameters:

elapsed - A Elapsed object that will be used to store the results of the totalTime.

threshold - If the elapsed time is greater or equal to that threshold value (in ms) the message is logged otherwise it isn't.

Returns:

The newly created Profiler instance.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable