Skip navigation links
A C D E F G H I M N O P R S T V Z 

A

average(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils
Computes and returns the mean Duration of the given collection of Durations.

C

call() - Method in class net.obvj.performetrics.monitors.MonitoredCallable
Configuration - Class in net.obvj.performetrics.config
An object that maintains common configurable parameters for Perfometrics objects.
Configuration() - Constructor for class net.obvj.performetrics.config.Configuration
 
ConfigurationHolder - Class in net.obvj.performetrics.config
A class that holds current Configuration object.
ConversionMode - Enum in net.obvj.performetrics
Defines supported conversion modes.
convert(long, TimeUnit, TimeUnit) - Method in enum net.obvj.performetrics.ConversionMode
Converts the given duration and time unit into another time unit.
convert(long, TimeUnit, TimeUnit) - Static method in class net.obvj.performetrics.util.TimeUnitConverter
Converts the given duration and time unit into another time unit, as double, with no rounding.
convertAndRound(long, TimeUnit, TimeUnit) - Static method in class net.obvj.performetrics.util.TimeUnitConverter
Converts the given duration to a different time unit, with double-precision; For example, to convert 10 minutes to milliseconds, use: TimeUnitConverter.convertAndRound(10, TimeUnit.MINUTES, TimeUnit.MILLISECONDS) Note: The number of decimal places applied is determined by calling ConfigurationHolder.getConfiguration().getScale()
convertAndRound(long, TimeUnit, TimeUnit, int) - Static method in class net.obvj.performetrics.util.TimeUnitConverter
Converts the given duration to a different time unit, with double-precision and a custom number of decimal places.
Counter - Class in net.obvj.performetrics
An object that stores time units of a particular type for elapsed time evaluation.
Counter(Counter.Type) - Constructor for class net.obvj.performetrics.Counter
Builds a Counter with a given type and default time unit.
Counter(Counter.Type, TimeUnit) - Constructor for class net.obvj.performetrics.Counter
Builds a Counter with the given type and time unit.
Counter(Counter.Type, TimeUnit, ConversionMode) - Constructor for class net.obvj.performetrics.Counter
Builds a Counter with the given type, time unit, and conversion mode.
Counter.Type - Enum in net.obvj.performetrics
Enumerates all supported counter types, defining a particular time fetch strategy for each of them.
createStarted() - Static method in class net.obvj.performetrics.Stopwatch
Provides a started stopwatch for convenience with default counter types.
createStarted(Counter.Type...) - Static method in class net.obvj.performetrics.Stopwatch
Provides a started stopwatch for convenience with specific counter types.

D

DEFAULT_FORMAT - Static variable in class net.obvj.performetrics.util.DurationFormatter
The default DurationFormat to be applied.
dividedBy(long) - Method in class net.obvj.performetrics.util.Duration
Returns a copy of this duration divided by the specified value.
Duration - Class in net.obvj.performetrics.util
A time-based amount, such as '01:59:59.987654321 (H:M:S.ns)'.
DurationFormat - Enum in net.obvj.performetrics.util
Enumerates different duration format styles, each one with particular characteristics.
DurationFormatter - Class in net.obvj.performetrics.util
A formatter for Duration objects.
DurationUtils - Class in net.obvj.performetrics.util
Common methods for working with durations.

E

elapsedTime() - Method in class net.obvj.performetrics.Counter
Returns the elapsed time.
elapsedTime(TimeUnit) - Method in class net.obvj.performetrics.Counter
Returns the elapsed time, in a given TimeUnit.
elapsedTime(TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.Counter
Returns the elapsed time, in a given TimeUnit, with a custom ConversionMode.
elapsedTime(Counter.Type) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Returns the total elapsed time of a specific counter type.
elapsedTime(Counter.Type, TimeUnit) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Returns the total elapsed time of a specific counter type, in the specified time unit.
elapsedTime(Counter.Type, TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Returns the total elapsed time of a specific counter, in the specified time unit, with a custom ConversionMode applied.
elapsedTime(Counter.Type) - Method in class net.obvj.performetrics.Stopwatch
Returns the total elapsed time for a specific counter.
elapsedTime(Counter.Type, TimeUnit) - Method in class net.obvj.performetrics.Stopwatch
Returns the total elapsed time for a specific counter, in the specified time unit.
elapsedTime(Counter.Type, TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.Stopwatch
Returns the total elapsed time for a specific counter, in the specified time unit, with a custom ConversionMode applied.
elapsedTime(Counter.Type) - Method in class net.obvj.performetrics.TimingSession
A convenient method that returns the elapsed time of a specific counter.
elapsedTime(Counter.Type, TimeUnit) - Method in class net.obvj.performetrics.TimingSession
A convenient method that returns the elapsed time of a specific counter, in the specified time unit.
elapsedTime(Counter.Type, TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.TimingSession
A convenient method that returns the elapsed time of a specific counter, in the specified time unit, by applying a custom ConversionMode.
equals(Object) - Method in class net.obvj.performetrics.util.Duration
 

F

format(Duration, boolean) - Method in enum net.obvj.performetrics.util.DurationFormat
Formats a given duration.
format(Duration) - Static method in class net.obvj.performetrics.util.DurationFormatter
Returns a string representation of the given Duration using default format.
format(Duration, DurationFormat) - Static method in class net.obvj.performetrics.util.DurationFormatter
Returns a string representation of the given Duration with a specific format.
format(Duration, DurationFormat, boolean) - Static method in class net.obvj.performetrics.util.DurationFormatter
Returns a string representation of the given Duration with a specific format.

G

getConfiguration() - Static method in class net.obvj.performetrics.config.ConfigurationHolder
Returns the current configuration.
getConversionMode() - Method in class net.obvj.performetrics.config.Configuration
Returns the conversion mode applied in supported operations if no specific mode is set.
getConversionMode() - Method in class net.obvj.performetrics.Counter
 
getCounter(Counter.Type) - Method in class net.obvj.performetrics.TimingSession
Returns the counter instance associated with a given type in this timing session.
getCounters() - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Returns all counters available in this monitored operation.
getCounters(Counter.Type) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Returns all counters associated with a given type in this monitored operation.
getCounters() - Method in class net.obvj.performetrics.Stopwatch
Returns a list of counters populated by this stopwatch.
getCounters(Counter.Type) - Method in class net.obvj.performetrics.Stopwatch
Returns a list of populated counters for a specific type in this stopwatch, or an empty list if no counter is found (for example, if the stopwatch was not yet started, or after reset).
getCounters() - Method in class net.obvj.performetrics.TimingSession
Returns the counters associated with this timing session.
getCpuTimeNanos() - Static method in class net.obvj.performetrics.util.SystemUtils
Returns the total time spent using a CPU for the current thread in nanoseconds.
getHours() - Method in class net.obvj.performetrics.util.Duration
Returns the number of hours in this duration.
getInternalDuration() - Method in class net.obvj.performetrics.util.Duration
 
getMinutes() - Method in class net.obvj.performetrics.util.Duration
Returns the number of minutes within the hour in this duration.
getNanoseconds() - Method in class net.obvj.performetrics.util.Duration
Returns the number of nanoseconds within the second in this duration.
getScale() - Method in class net.obvj.performetrics.config.Configuration
Returns the maximum number of decimal places applied if double-precision conversion mode is set.
getSeconds() - Method in class net.obvj.performetrics.util.Duration
Returns the number of seconds within the minute in this duration.
getSystemTimeNanos() - Static method in class net.obvj.performetrics.util.SystemUtils
Returns system time (the time spent running OS kernel code on behalf of your application) in nanoseconds, by calculating the difference between CPU time and user time for the current thread.
getTime(TimeUnit) - Method in enum net.obvj.performetrics.Counter.Type
Executes a particular time fetching mode that varies for each counter type.
getTimeUnit() - Method in class net.obvj.performetrics.config.Configuration
Returns the time unit maintained by default if no specific time unit is specified.
getTimeUnit() - Method in class net.obvj.performetrics.Counter
 
getType() - Method in class net.obvj.performetrics.Counter
 
getTypes() - Method in class net.obvj.performetrics.Stopwatch
Returns the counter types associated with this stopwatch instance.
getUnitsAfter() - Method in class net.obvj.performetrics.Counter
 
getUnitsBefore() - Method in class net.obvj.performetrics.Counter
 
getUserTimeNanos() - Static method in class net.obvj.performetrics.util.SystemUtils
Returns the CPU time that the current thread has executed in user mode in nanoseconds (i.e., the time spent running current thread's own code).
getWallClockTimeMillis() - Static method in class net.obvj.performetrics.util.SystemUtils
Returns the current time in milliseconds.
getWallClockTimeNanos() - Static method in class net.obvj.performetrics.util.SystemUtils
Returns the current value of the current Java Virtual Machine's high-resolution time source in nanoseconds.

H

hashCode() - Method in class net.obvj.performetrics.util.Duration
 

I

isStarted() - Method in class net.obvj.performetrics.Stopwatch
Returns true if this stopwatch is started.
isStarted() - Method in class net.obvj.performetrics.TimingSession
Returns true if this timing session is started.

M

max(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils
Computes and returns the highest/maximum Duration of the given collection of Durations.
min(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils
Computes and returns the lowest/minimum Duration of the given collection of Durations.
MonitoredCallable<V> - Class in net.obvj.performetrics.monitors
A Callable wrapper that maintains one or more counters for monitoring the time spent by the Callable's call() method.
MonitoredCallable(Callable<V>) - Constructor for class net.obvj.performetrics.monitors.MonitoredCallable
Builds this monitored operation with a given Callable.
MonitoredCallable(Callable<V>, Counter.Type...) - Constructor for class net.obvj.performetrics.monitors.MonitoredCallable
Builds this monitored operation with a given Callable and one or more specific counter types to be maintained.
MonitoredOperation - Class in net.obvj.performetrics.monitors
A base object for monitorable operations that maintains one or more counters.
MonitoredOperation(Counter.Type...) - Constructor for class net.obvj.performetrics.monitors.MonitoredOperation
Builds a monitored operation with the specified type(s).
MonitoredRunnable - Class in net.obvj.performetrics.monitors
A Runnable wrapper that maintains one or more counters for monitoring the time spent by the Runnable's run() method.
MonitoredRunnable(Runnable) - Constructor for class net.obvj.performetrics.monitors.MonitoredRunnable
Builds this monitored operation with a given Runnable.
MonitoredRunnable(Runnable, Counter.Type...) - Constructor for class net.obvj.performetrics.monitors.MonitoredRunnable
Builds this monitored operation with a given Runnable and one or more specific counter types to be maintained.
monitorOperation(Runnable) - Static method in class net.obvj.performetrics.Performetrics
Runs the specified Runnable, which can also be a lambda expression, and collects metrics for all available counter types.
monitorOperation(Runnable, Counter.Type...) - Static method in class net.obvj.performetrics.Performetrics
Runs the specified Runnable, which can also be a lambda expression, and collects metrics for the specified counter type(s).

N

net.obvj.performetrics - package net.obvj.performetrics
Provides convenient classes for extracting performance metrics of Java code.
net.obvj.performetrics.config - package net.obvj.performetrics.config
Provides classes to handle common configuration parameters used by Performetrics.
net.obvj.performetrics.monitors - package net.obvj.performetrics.monitors
Provides classes that can monitor other ones.
net.obvj.performetrics.util - package net.obvj.performetrics.util
Provides utility classes in general.
net.obvj.performetrics.util.printer - package net.obvj.performetrics.util.printer
Provides reusable static methods for printing Performetrics objects.

O

of(long, TimeUnit) - Static method in class net.obvj.performetrics.util.Duration
Obtains a Duration representing an amount in the specified time unit.

P

Performetrics - Class in net.obvj.performetrics
A Facade class meant to provide a simple interface for common parameters setup and other operations.
plus(Duration) - Method in class net.obvj.performetrics.util.Duration
Returns a copy of this duration with the specified duration added.
print(Stopwatch, PrintStream) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given stopwatch in the specified print stream.
print(Stopwatch, PrintStream, TimeUnit) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given stopwatch in the specified print stream.
print(List<Counter>, PrintStream) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given counters in the specified print stream.
print(List<Counter>, PrintStream, TimeUnit) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given counters in the specified print stream.
print(Map<Counter.Type, List<Counter>>, PrintStream) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given counters in the specified print stream.
print(Map<Counter.Type, List<Counter>>, PrintStream, TimeUnit) - Static method in class net.obvj.performetrics.util.printer.PrintUtils
Prints the statistics for the given counters in the specified print stream.
printStatistics(PrintStream) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Prints operation statistics in the specified print stream.
printStatistics(PrintStream, TimeUnit) - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Prints operation statistics in the specified print stream, with a custom time unit.
printStatistics(PrintStream) - Method in class net.obvj.performetrics.Stopwatch
Prints stopwatch statistics in the specified print stream.
printStatistics(PrintStream, TimeUnit) - Method in class net.obvj.performetrics.Stopwatch
Prints stopwatch statistics in the specified print stream, with a custom time unit.
PrintUtils - Class in net.obvj.performetrics.util.printer
This class groups all custom printing operations in a single place.

R

reset() - Static method in class net.obvj.performetrics.config.ConfigurationHolder
Resets current configuration to default.
reset() - Method in class net.obvj.performetrics.monitors.MonitoredOperation
Cleans all counters available in this monitored operation.
reset() - Method in class net.obvj.performetrics.Stopwatch
Cleans all timing sessions in this stopwatch.
reset() - Method in class net.obvj.performetrics.TimingSession
Resets all counters associated with this timing session.
run() - Method in class net.obvj.performetrics.monitors.MonitoredRunnable

S

setConfiguration(Configuration) - Static method in class net.obvj.performetrics.config.ConfigurationHolder
Sets a given configuration as current.
setConversionMode(ConversionMode) - Method in class net.obvj.performetrics.config.Configuration
Defines the default conversion mode to be applied in supported operations if no specific mode is set.
setDefaultConversionMode(ConversionMode) - Static method in class net.obvj.performetrics.Performetrics
Sets a conversion mode to be applied by supported operations if no specific mode is set.
setDefaultTimeUnit(TimeUnit) - Static method in class net.obvj.performetrics.Performetrics
Sets a time unit to be maintained by default if no specific time unit is specified.
setScale(int) - Method in class net.obvj.performetrics.config.Configuration
Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.
setScale(int) - Static method in class net.obvj.performetrics.Performetrics
Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.
setTimeUnit(TimeUnit) - Method in class net.obvj.performetrics.config.Configuration
Defines the time unit to be maintained by default if no specific time unit is specified.
setUnitsAfter(long) - Method in class net.obvj.performetrics.Counter
 
setUnitsAfter() - Method in class net.obvj.performetrics.Counter
Populates the unitsAfter field with the value retrieved by the time fetching mode defined by this counter's type.
setUnitsBefore(long) - Method in class net.obvj.performetrics.Counter
 
setUnitsBefore() - Method in class net.obvj.performetrics.Counter
Populates the unitsBefore field with the value retrieved by the time fetching mode defined by this counter's type.
start() - Method in class net.obvj.performetrics.Stopwatch
Starts a new timing session.
start() - Method in class net.obvj.performetrics.TimingSession
Starts the timing session.
stop() - Method in class net.obvj.performetrics.Stopwatch
Stops the current timing session.
stop() - Method in class net.obvj.performetrics.TimingSession
Stops the timing session.
Stopwatch - Class in net.obvj.performetrics
A convenient timing object that supports multiple counter types and timing sessions.
Stopwatch() - Constructor for class net.obvj.performetrics.Stopwatch
Creates a new stopwatch with default counter types.
Stopwatch(Counter.Type...) - Constructor for class net.obvj.performetrics.Stopwatch
Creates a new stopwatch with specific counter types.
sum(Duration, Duration) - Static method in class net.obvj.performetrics.util.Duration
Returns the sum of two durations.
SystemUtils - Class in net.obvj.performetrics.util
A utility class for retrieving system data.

T

TimeUnitConverter - Class in net.obvj.performetrics.util
A utility class for TimeUnit conversion.
TimingSession - Class in net.obvj.performetrics
A convenient timing object that supports multiple counter types.
TimingSession() - Constructor for class net.obvj.performetrics.TimingSession
Creates a new timing session with default counter types.
TimingSession(Counter.Type...) - Constructor for class net.obvj.performetrics.TimingSession
Creates a new timing session with custom counter types.
toSeconds() - Method in class net.obvj.performetrics.util.Duration
Converts this duration to the total length in seconds and fractional nanoseconds, with a fixed scale of 9, so nanoseconds precision is preserved.
toString() - Method in class net.obvj.performetrics.Counter
Returns a string representation of this object.
toString() - Method in enum net.obvj.performetrics.Counter.Type
Returns the textual representation associated with this type.
toString() - Method in class net.obvj.performetrics.util.Duration
Returns a string representation of this Duration in default format.
toString(DurationFormat) - Method in class net.obvj.performetrics.util.Duration
Returns a string representation of this Duration with a specific format.
toString(DurationFormat, boolean) - Method in class net.obvj.performetrics.util.Duration
Returns a string representation of this Duration with a specific format.
toTimeUnit(TimeUnit) - Method in class net.obvj.performetrics.util.Duration
Converts this duration to the total length in a given time unit, with default scale.
toTimeUnit(TimeUnit, int) - Method in class net.obvj.performetrics.util.Duration
Converts this duration to the total length in a given time unit, with a custom scale.

V

valueOf(String) - Static method in enum net.obvj.performetrics.ConversionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.obvj.performetrics.Counter.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.obvj.performetrics.util.DurationFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.obvj.performetrics.ConversionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.obvj.performetrics.Counter.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.obvj.performetrics.util.DurationFormat
Returns an array containing the constants of this enum type, in the order they are declared.

Z

ZERO - Static variable in class net.obvj.performetrics.util.Duration
 
A C D E F G H I M N O P R S T V Z 
Skip navigation links

Copyright © 2020. All rights reserved.