net.obvj.performetrics.monitors

Class MonitoredOperation

java.lang.Object

net.obvj.performetrics.monitors.MonitoredOperation

Direct Known Subclasses:

MonitoredCallable, MonitoredRunnable

public abstract class MonitoredOperation
extends Object

A base object for monitorable operations that maintains one or more counters.

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
Duration	elapsedTime() Returns the total elapsed time for a single counter type, provided that this monitor is keeping a single type.
Duration	elapsedTime(Counter.Type type) Returns the total elapsed time of a specific counter type.
double	elapsedTime(Counter.Type type, TimeUnit timeUnit) Returns the total elapsed time of a specific counter type, in the specified time unit.
double	elapsedTime(Counter.Type type, TimeUnit timeUnit, ConversionMode conversionMode) Returns the total elapsed time of a specific counter, in the specified time unit, with a custom ConversionMode applied.
double	elapsedTime(TimeUnit timeUnit) Returns the total elapsed time in the specified time unit for a single counter type, provided that this monitor is keeping a single type.
double	elapsedTime(TimeUnit timeUnit, ConversionMode conversionMode) Returns the total elapsed time in the specified time unit for a single counter type, provided that this monitor is keeping a single type.
Map<Counter.Type,List<Counter>>	getAllCountersByType() Returns a map of populated counters grouped by type, where each entry in the counters list represents a timing session.
List<Counter>	getCounters(Counter.Type type) Returns all counters associated with a given type in this monitored operation.
void	print(PrintStream printStream) Prints elapsed times in the specified print stream.
void	print(PrintStream printStream, PrintStyle printStyle) Prints elapsed times in the specified print stream with a custom PrintStyle.
void	printDetails(PrintStream printStream) Prints detailed information about timing sessions in the specified print stream.
void	printDetails(PrintStream printStream, PrintStyle printStyle) Prints detailed information about timing sessions in the specified print stream, with a custom PrintStyle.
void	printSummary(PrintStream printStream) Prints summarized elapsed times in the specified print stream.
void	printSummary(PrintStream printStream, PrintStyle printStyle) Prints summarized elapsed times in the specified print stream, with a custom PrintStyle.
void	reset() Cleans all counters available in this monitored operation.
String	toString() Returns a string containing a formatted output for this operation.
String	toString(PrintStyle printStyle) Returns a string containing a formatted output for this operation in a custom PrintStyle.

Methods inherited from class java.lang.Object

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

Method Detail

getCounters

public List<Counter> getCounters(Counter.Type type)

Returns all counters associated with a given type in this monitored operation.

Parameters:

type - the counter type to be fetched

Returns:

all counters associated with the given type

Throws:

IllegalArgumentException - if the specified type was not assigned to the operation during instantiation

elapsedTime

public Duration elapsedTime()

Returns the total elapsed time for a single counter type, provided that this monitor is keeping a single type.

Returns:

the elapsed time for a single counter type in this monitor

Throws:

IllegalStateException - if this monitor is keeping more than one counter type

Since:

2.2.4

elapsedTime

public double elapsedTime(TimeUnit timeUnit)

Returns the total elapsed time in the specified time unit for a single counter type, provided that this monitor is keeping a single type.

Parameters:

timeUnit - the time unit to which the elapsed time will be converted

Returns:

the elapsed time for a single counter type in this monitor, converted to the given time unit with the default conversion mode

Throws:

IllegalStateException - if this monitor is keeping more than one counter type

Since:

2.2.4

elapsedTime

public double elapsedTime(TimeUnit timeUnit,
                          ConversionMode conversionMode)

Returns the total elapsed time in the specified time unit for a single counter type, provided that this monitor is keeping a single type.

Parameters:

timeUnit - the time unit to which the elapsed time will be converted

conversionMode - the ConversionMode to be applied

Returns:

the elapsed time for a single counter type in this monitor, converted to the given time unit with the given conversion mode

Throws:

IllegalStateException - if this monitor is keeping more than one counter type

Since:

2.2.4

elapsedTime

public Duration elapsedTime(Counter.Type type)

Returns the total elapsed time of a specific counter type.

Parameters:

type - the counter type to be fetched

Returns:

the total elapsed time for the specified counter

Throws:

IllegalArgumentException - if the specified type was not assigned to the operation during instantiation

Since:

2.1.0

elapsedTime

public double elapsedTime(Counter.Type type,
                          TimeUnit timeUnit)

Returns the total elapsed time of a specific counter type, in the specified time unit.

Parameters:

type - the counter type to be fetched

timeUnit - the time unit to which the elapsed time will be converted

Returns:

the elapsed time for the specified counter, converted to the given time unit using the default conversion mode.

Throws:

IllegalArgumentException - if the specified type was not assigned to the operation during instantiation

Since:

2.1.0

elapsedTime

public double elapsedTime(Counter.Type type,
                          TimeUnit timeUnit,
                          ConversionMode conversionMode)

Returns the total elapsed time of a specific counter, in the specified time unit, with a custom ConversionMode applied.

Parameters:

type - the counter type to be fetched

timeUnit - the time unit to which the elapsed time will be converted

conversionMode - the ConversionMode to be applied

Returns:

the elapsed time for the specified counter, converted to the given time unit using the given conversion mode.

Throws:

IllegalArgumentException - if the specified type was not assigned to the operation during instantiation

Since:

2.1.0

print

public void print(PrintStream printStream)

Prints elapsed times in the specified print stream.

The default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied.

For a custom PrintStyle, use print(PrintStream, PrintStyle).

Parameters:

printStream - the print stream to which data will be sent

Throws:

NullPointerException - if the PrintStream is null

Since:

2.4.0

print

public void print(PrintStream printStream,
                  PrintStyle printStyle)

Prints elapsed times in the specified print stream with a custom PrintStyle.

The format (whether to generate a summarized or detailed view) will be determined by the specified PrintStyle.

Parameters:

printStream - the print stream to which data will be sent

printStyle - the PrintStyle; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied

Throws:

NullPointerException - if the PrintStream is null

Since:

2.4.0

printSummary

public void printSummary(PrintStream printStream)

Prints summarized elapsed times in the specified print stream.

Parameters:

printStream - the print stream to which data will be sent

Throws:

NullPointerException - if the PrintStream is null

Since:

2.2.1

printSummary

public void printSummary(PrintStream printStream,
                         PrintStyle printStyle)

Prints summarized elapsed times in the specified print stream, with a custom PrintStyle.

Parameters:

printStream - the print stream to which data will be sent

printStyle - the PrintStyle to be applied

Throws:

NullPointerException - if the PrintStream is null

IllegalArgumentException - if the specified PrintStyle is not compatible with PrintFormat.SUMMARIZED

Since:

2.2.1

printDetails

public void printDetails(PrintStream printStream)

Prints detailed information about timing sessions in the specified print stream.

Parameters:

printStream - the print stream to which information will be sent

Throws:

NullPointerException - if the PrintStream is null

Since:

2.2.1

printDetails

public void printDetails(PrintStream printStream,
                         PrintStyle printStyle)

Prints detailed information about timing sessions in the specified print stream, with a custom PrintStyle.

Parameters:

printStream - the print stream to which information will be sent

printStyle - the PrintStyle to be applied

Throws:

NullPointerException - if the PrintStream is null

IllegalArgumentException - if the specified PrintStyle is not compatible with PrintFormat.DETAILED

Since:

2.2.1

getAllCountersByType

public Map<Counter.Type,List<Counter>> getAllCountersByType()

Returns a map of populated counters grouped by type, where each entry in the counters list represents a timing session.

Returns:

a map of populated counters grouped by type

Since:

2.2.1

reset

public void reset()

Cleans all counters available in this monitored operation.

Since:

2.2.0

toString

public String toString()

Returns a string containing a formatted output for this operation.

The default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied.

Overrides:

toString in class Object

Returns:

a string containing formatted elapsed times for this opearation

Since:

2.2.4

toString

public String toString(PrintStyle printStyle)

Returns a string containing a formatted output for this operation in a custom PrintStyle.

The PrintFormat (whether to generate a summarized or detailed view) will be determined by the specified PrintStyle.

Parameters:

printStyle - the PrintStyle; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied

Returns:

a string containing formatted elapsed times for this operation in the specified PrintStyle

Since:

2.4.0