net.obvj.performetrics

Class Performetrics

java.lang.Object

net.obvj.performetrics.Performetrics

public class Performetrics
extends Object

A Facade class meant to provide a simple interface for common parameters setup and other operations.

Since:

2.0.0

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static MonitoredOperation	monitorOperation(Runnable runnable) Runs the specified Runnable, which can also be a lambda expression, and collects metrics for all available counter types.
static MonitoredOperation	monitorOperation(Runnable runnable, Counter.Type... types) Runs the specified Runnable, which can also be a lambda expression, and collects metrics for the specified counter type(s) only.
static void	setDefaultConversionMode(ConversionMode conversionMode) Sets a conversion mode to be applied by supported operations if no specific mode is set.
static void	setDefaultPrintStyle(PrintStyle printStyle) Defines the default PrintStyle to be applied when no style is specified.
static void	setDefaultPrintStyleForDetails(PrintStyle printStyle) Defines the default PrintStyle to be applied by the detailed stopwatch formatter.
static void	setDefaultPrintStyleForSummary(PrintStyle printStyle) Defines the default PrintStyle to be applied by the summarized stopwatch formatter.
static void	setDefaultTimeUnit(TimeUnit timeUnit) Sets a time unit to be maintained by default if no specific time unit is specified.
static void	setScale(int scale) Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.

Methods inherited from class java.lang.Object

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

Method Detail

setDefaultTimeUnit

public static void setDefaultTimeUnit(TimeUnit timeUnit)

Sets a time unit to be maintained by default if no specific time unit is specified.

Parameters:

timeUnit - the TimeUnit to set

setDefaultConversionMode

public static void setDefaultConversionMode(ConversionMode conversionMode)

Sets a conversion mode to be applied by supported operations if no specific mode is set.

Parameters:

conversionMode - the ConversionMode to set

setScale

public static void setScale(int scale)

Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.

Parameters:

scale - a number between 0 and 16 to be set

Throws:

IllegalArgumentException - if a number outside the allowed range is received

setDefaultPrintStyle

public static void setDefaultPrintStyle(PrintStyle printStyle)

Defines the default PrintStyle to be applied when no style is specified.

The object will be used by the following operations:

• Stopwatch.print(java.io.PrintStream)
• Stopwatch.toString()
• MonitoredOperation.print(java.io.PrintStream)
• MonitoredOperation.toString()

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.4.0

setDefaultPrintStyleForSummary

public static void setDefaultPrintStyleForSummary(PrintStyle printStyle)

Defines the default PrintStyle to be applied by the summarized stopwatch formatter.

The object will be used by the following operations:

• Stopwatch.printSummary(java.io.PrintStream)
• MonitoredOperation.printSummary(java.io.PrintStream)

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.2.1

setDefaultPrintStyleForDetails

public static void setDefaultPrintStyleForDetails(PrintStyle printStyle)

Defines the default PrintStyle to be applied by the detailed stopwatch formatter.

The object will be used by the following operations:

• Stopwatch.printDetails(java.io.PrintStream)
• MonitoredOperation.printDetails(java.io.PrintStream)

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.2.1

monitorOperation

public static MonitoredOperation monitorOperation(Runnable runnable)

Runs the specified Runnable, which can also be a lambda expression, and collects metrics for all available counter types.

For example:

  MonitoredOperation operation =
          Performetrics.monitorOperation(() -> myObj.exec());
  Duration elapsedTime = operation.elapsedTime(Type.WALL_CLOCK_TIME);
 

Parameters:

runnable - the Runnable to be run and monitored

Returns:

the resulting MonitoredOperation, which can be used to retrieve the collected results.

Since:

2.2.0

monitorOperation

public static MonitoredOperation monitorOperation(Runnable runnable,
                                                  Counter.Type... types)

Runs the specified Runnable, which can also be a lambda expression, and collects metrics for the specified counter type(s) only.

For example:

  MonitoredOperation operation = Performetrics
          .monitorOperation(() -> myObj.exec(), Type.CPU_TIME);
  Duration elapsedTime = operation.elapsedTime(Type.CPU_TIME);
 

Note: If no type is specified, then all of the available types will be maintained.

Parameters:

runnable - the Runnable to be run and monitored

types - the counter types to be measured in the operation

Returns:

the resulting MonitoredOperation, which can be used to retrieve the collected results.

Since:

2.2.0