Index (Performetrics 2.5.3 API)

A B C D E F G H I L M N O P R S T U V W Z
All Classes All Packages

A

ALL_TYPES - Static variable in class net.obvj.performetrics.Performetrics: A list containing all the available counter types.
average(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils: Computes and returns the mean Duration of the given collection of Durations.

B

build() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Builds the PrintStyle.
builder(PrintFormat) - Static method in class net.obvj.performetrics.util.print.PrintStyle: Returns an empty PrintStyle builder.
builder(PrintStyle) - Static method in class net.obvj.performetrics.util.print.PrintStyle: Returns a PrintStyle builder with the same attributes of an existing PrintStyle.

C

call() - Method in class net.obvj.performetrics.monitors.MonitoredCallable
checkCompatibility(PrintStyle) - Method in enum net.obvj.performetrics.util.print.PrintFormat: Checks if a given PrintStyle is compatible with this PrintFormat.
compareTo(Duration) - Method in class net.obvj.performetrics.util.Duration: Compares this duration to the specified Duration based on the total length of the durations, as defined by Comparable.
configuration() - Static method in class net.obvj.performetrics.Performetrics: Returns the current Configuration.
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: Builds a new Configuration with all initial values.
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.
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 for a particular counter type (in nanoseconds) 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, 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.
CPU_TIME - net.obvj.performetrics.Counter.Type: The total time spent using a CPU for the current thread.
createStarted() - Static method in class net.obvj.performetrics.Stopwatch: Provides a started stopwatch with default counter types, for convenience.
createStarted(Counter.Type...) - Static method in class net.obvj.performetrics.Stopwatch: Provides a started stopwatch with specific counter types, for convenience.

D

DEFAULT_FORMAT - Static variable in class net.obvj.performetrics.util.Duration: The default DurationFormat to be applied by Duration.toString() and Duration.parse(String) operations, if no format is specified.
DETAILED - net.obvj.performetrics.util.print.PrintFormat: Generates a detailed view of each counter type and timing session available in the timing-session container, one row for each timing session, and the total elapsed time for each type, as well.
DETAILED_CSV - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as CSV (comma-separated values).
DETAILED_CSV_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as CSV (comma-separated values), with elapsed times expressed using the ISO-8601 duration format.
DETAILED_CSV_ISO_8601_NO_HEADER - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as CSV (comma-separated values), with elapsed times expressed using the ISO-8601 duration format and no header.
DETAILED_CSV_NO_HEADER - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as CSV (comma-separated values), without header.
DETAILED_TABLE_FULL - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, with horizontal lines separating each row, and total elapsed time for each counter.
DETAILED_XML - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data in XML format.
DETAILED_XML_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as XML with elapsed times expressed using the ISO-8601 duration format.
DETAILED_YAML - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data in YAML format.
DETAILED_YAML_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the detailed timing-session-container format, which prints data as YAML with elapsed times expressed using the ISO-8601 duration format.
dividedBy(long) - Method in class net.obvj.performetrics.util.Duration: Returns a copy of this duration divided by the specified value.
DOUBLE_PRECISION - net.obvj.performetrics.ConversionMode: This mode implements a more robust conversion logic that avoids truncation from finer to coarser granularities.
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.
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() - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time for a single counter type, provided that this object is keeping a single type.
elapsedTime() - Method in class net.obvj.performetrics.UnmodifiableCounter
elapsedTime(TimeUnit) - Method in class net.obvj.performetrics.Counter: Returns the elapsed time in the specified TimeUnit.
elapsedTime(TimeUnit) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time in the specified time unit for a single counter type, provided that this object is keeping a single type.
elapsedTime(TimeUnit) - Method in class net.obvj.performetrics.UnmodifiableCounter
elapsedTime(TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.Counter: Returns the elapsed time, in a given TimeUnit, with a custom ConversionMode.
elapsedTime(TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time in the specified time unit for a single counter type, provided that this object is keeping a single type.
elapsedTime(TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.UnmodifiableCounter
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) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time for a specific counter type.
elapsedTime(Counter.Type) - Method in class net.obvj.performetrics.UnmodifiableTimingSession
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) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time for a specific counter type, in the specified time unit.
elapsedTime(Counter.Type, TimeUnit) - Method in class net.obvj.performetrics.UnmodifiableTimingSession
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.
elapsedTime(Counter.Type, TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the total elapsed time for a specific counter type, in the specified time unit, with a custom ConversionMode applied.
elapsedTime(Counter.Type, TimeUnit, ConversionMode) - Method in class net.obvj.performetrics.UnmodifiableTimingSession
equals(Object) - Method in class net.obvj.performetrics.util.Duration

F

FAST - net.obvj.performetrics.ConversionMode: A fast conversion mode uses Java-standard TimeUnit class to convert a given duration to a different time unit.
format(TimingSessionContainer, PrintStyle) - Method in enum net.obvj.performetrics.util.print.PrintFormat: Generates a formatted string containing data from the specified timing-session container, in a custom style.
format(Duration, boolean) - Method in enum net.obvj.performetrics.util.DurationFormat: Formats a given duration.
FULL - net.obvj.performetrics.util.DurationFormat: Formats a time duration in the following format: H:M:S.ns.

G

generateLine(char, int) - Static method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Generates a string using the specified character repeated to a given length.
getAllCountersByType() - Method in class net.obvj.performetrics.TimingSessionContainer: Returns a map of counters grouped by type, where each entry in the counters list represents a timing session.
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: Returns the ConversionMode associated with this counter.
getCounters(Counter.Type) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns a list of available counters for a specific type in this object, or an empty list if no counter is found -- for example, if no timing session was started, or after calling reset().
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.
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.
getPrintStyle() - Method in class net.obvj.performetrics.config.Configuration: Returns the default PrintStyle to be applied when no style is specified.
getPrintStyleForDetails() - Method in class net.obvj.performetrics.config.Configuration: Returns the default PrintStyle for the detailed stopwatch formatter.
getPrintStyleForSummary() - Method in class net.obvj.performetrics.config.Configuration: Returns the default PrintStyle for the summarized stopwatch formatter.
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.
getSystemTimeNanos(ThreadMXBean) - Static method in class net.obvj.performetrics.util.SystemUtils
getTime() - Method in enum net.obvj.performetrics.Counter.Type: Executes a particular time fetching mode that varies for each counter type.
getType() - Method in class net.obvj.performetrics.Counter: Returns the Counter.Type associated with this counter.
getTypes() - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the counter types associated with this object.
getUnitsAfter() - Method in class net.obvj.performetrics.Counter: Returns the value of the unitsAfter field.
getUnitsAfter() - Method in class net.obvj.performetrics.UnmodifiableCounter
getUnitsBefore() - Method in class net.obvj.performetrics.Counter: Returns the value of the unitsBefore field.
getUnitsBefore() - Method in class net.obvj.performetrics.UnmodifiableCounter
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).
getUserTimeNanos(ThreadMXBean) - Static method in class net.obvj.performetrics.util.SystemUtils
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

isEmpty(String) - Static method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Returns true if the specified string is either null or empty.
isNegative() - Method in class net.obvj.performetrics.util.Duration: Checks if this duration is negative, excluding zero.
ISO_8601 - net.obvj.performetrics.util.DurationFormat: Formats a time duration using ISO-8601 seconds-based representation.
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.
isStarted() - Method in class net.obvj.performetrics.UnmodifiableTimingSession
isZero() - Method in class net.obvj.performetrics.util.Duration: Checks if this duration is zero length.

L

lastSession() - Method in class net.obvj.performetrics.TimingSessionContainer: Returns the current/last timing session recorded in this object.
LINUX - net.obvj.performetrics.util.DurationFormat: Formats a time duration in Linux style, applying the form M'm':S.ms's'.
LINUX - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style which prints data from a timing-session-container in Linux style.

M

max(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils: Returns the highest/maximum Duration of a given collection.
min(Collection<Duration>) - Static method in class net.obvj.performetrics.util.DurationUtils: Returns the lowest/minimum Duration of a given collection.
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.
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) only.
multipliedBy(long) - Method in class net.obvj.performetrics.util.Duration: Returns a copy of this duration multiplied by the scalar.

N

negated() - Method in class net.obvj.performetrics.util.Duration: Returns a copy of this duration with the length negated.
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.print - package net.obvj.performetrics.util.print: Provides classes for printing stopwatch data.

O

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

P

parse(String) - Static method in class net.obvj.performetrics.util.Duration: Obtains a Duration from a string in default format.
parse(String) - Method in enum net.obvj.performetrics.util.DurationFormat: Parses a textual representation of a Duration.
parse(String, DurationFormat) - Static method in class net.obvj.performetrics.util.Duration: Obtains a Duration from a string in a specific DurationFormat.
Performetrics - Class in net.obvj.performetrics: A Facade class meant to provide a simple interface for common parameters setup and other operations.
plus(long, TimeUnit) - Method in class net.obvj.performetrics.util.Duration: Returns a copy of this duration with the specified duration added.
plus(Duration) - Method in class net.obvj.performetrics.util.Duration: Returns a copy of this duration with the specified duration added.
print(PrintStream) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints elapsed times in the specified print stream.
print(PrintStream, PrintStyle) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints elapsed times in the specified print stream with a custom PrintStyle.
print(TimingSessionContainer, PrintStream) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints elapsed times from the given TimingSessionContainer into the specified print stream.
print(TimingSessionContainer, PrintStream, PrintStyle) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints elapsed times from the given TimingSessionContainer into the specified print stream, with a custom PrintStyle.
printDetails(PrintStream) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints detailed information about timing sessions in the specified print stream.
printDetails(PrintStream, PrintStyle) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints detailed information about timing sessions in the specified print stream, with a custom PrintStyle.
printDetails(TimingSessionContainer, PrintStream) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints detailed information about timing sessions from the given TimingSessionContainer into the specified print stream.
printDetails(TimingSessionContainer, PrintStream, PrintStyle) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints detailed information about timing sessions from the given TimingSessionContainer into the specified print stream, with a custom PrintStyle.
PrintFormat - Enum in net.obvj.performetrics.util.print: Provides different formatters for printing data from a timing-session container as strings in tabular layout.
PrintStyle - Class in net.obvj.performetrics.util.print: Defines a set of attributes used by a PrintFormat to generate a String output out of a timing-session container.
PrintStyleBuilder - Class in net.obvj.performetrics.util.print: A builder for creating PrintStyle objects.
PrintStyleBuilder(PrintFormat) - Constructor for class net.obvj.performetrics.util.print.PrintStyleBuilder: Creates an empty PrintStyle builder.
PrintStyleBuilder(PrintStyle) - Constructor for class net.obvj.performetrics.util.print.PrintStyleBuilder: Creates a new PrintStyle builder with the same attributes of an existing PrintStyle.
printSummary(PrintStream) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints summarized elapsed times in the specified print stream.
printSummary(PrintStream, PrintStyle) - Method in class net.obvj.performetrics.TimingSessionContainer: Prints summarized elapsed times in the specified print stream, with a custom PrintStyle.
printSummary(TimingSessionContainer, PrintStream) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints summarized elapsed times from the given TimingSessionContainer into the specified print stream.
printSummary(TimingSessionContainer, PrintStream, PrintStyle) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Prints summarized elapsed times from the given TimingSessionContainer into the specified print stream, with a custom PrintStyle.
PrintUtils - Class in net.obvj.performetrics.util.print: 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.Stopwatch: Cleans all timing sessions in this stopwatch.
reset() - Method in class net.obvj.performetrics.TimingSession: Resets all counters associated with this timing session.
reset() - Method in class net.obvj.performetrics.TimingSessionContainer: Cleans all timing sessions in this object.
reset() - Method in class net.obvj.performetrics.UnmodifiableTimingSession
resetCustomCounterNames() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Resets any preset custom counter names in the target PrintStyle.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Use Performetrics.configuration().setConversionMode(ConversionMode) instead.
setDefaultPrintStyle(PrintStyle) - Static method in class net.obvj.performetrics.Performetrics: Deprecated, for removal: This API element is subject to removal in a future version.
Use Performetrics.configuration().setPrintStyle(PrintStyle) instead.
setDefaultPrintStyleForDetails(PrintStyle) - Static method in class net.obvj.performetrics.Performetrics: Deprecated, for removal: This API element is subject to removal in a future version.
Use Performetrics.configuration().setPrintStyleForDetails(PrintStyle) instead.
setDefaultPrintStyleForSummary(PrintStyle) - Static method in class net.obvj.performetrics.Performetrics: Deprecated, for removal: This API element is subject to removal in a future version.
Use Performetrics.configuration().setPrintStyleForSummary(PrintStyle) instead.
setPrintStyle(PrintStyle) - Method in class net.obvj.performetrics.config.Configuration: Defines the default PrintStyle to be applied when no style is specified.
setPrintStyleForDetails(PrintStyle) - Method in class net.obvj.performetrics.config.Configuration: Defines the default PrintStyle for the detailed stopwatch formatter.
setPrintStyleForSummary(PrintStyle) - Method in class net.obvj.performetrics.config.Configuration: Defines the default PrintStyle for the summarized stopwatch formatter.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Use Performetrics.configuration().setScale(int) instead.
setUnitsAfter(long) - Method in class net.obvj.performetrics.Counter: Populates the unitsAfter field with an arbitrary value.
setUnitsAfter(long) - Method in class net.obvj.performetrics.UnmodifiableCounter
setUnitsBefore(long) - Method in class net.obvj.performetrics.Counter: Populates the unitsBefore field with an arbitrary value.
setUnitsBefore(long) - Method in class net.obvj.performetrics.UnmodifiableCounter
SHORT - net.obvj.performetrics.util.DurationFormat: Formats a time duration in any of the following formats: H:M:S.ns, M:S.ns, or S.ns, always choosing the shortest possible format.
SHORTER - net.obvj.performetrics.util.DurationFormat: Formats a time duration in any of the following formats: H:M:S.ns, M:S.ns, or S.ns, always choosing the shortest possible format and suppressing trailing zeros from the nanoseconds part.
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.
start() - Method in class net.obvj.performetrics.UnmodifiableTimingSession
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.
stop() - Method in class net.obvj.performetrics.UnmodifiableTimingSession
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.
SUMMARIZED - net.obvj.performetrics.util.print.PrintFormat: Generates a summarized view which represents the total elapsed time for each counter type available in the timing-session container, one row for each type.
SUMMARIZED_CSV - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as CSV (comma-separated values).
SUMMARIZED_CSV_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as CSV (comma-separated values), with elapsed times expressed using the ISO-8601 duration format.
SUMMARIZED_CSV_ISO_8601_NO_HEADER - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as CSV (comma-separated values), with elapsed times expressed using the ISO-8601 duration format and no header.
SUMMARIZED_CSV_NO_HEADER - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as CSV (comma-separated values), without header.
SUMMARIZED_TABLE_FULL - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data in tabular format, with horizontal lines separating each row.
SUMMARIZED_TABLE_NO_HEADER - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data in tabular format without header.
SUMMARIZED_XML - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data in XML format.
SUMMARIZED_XML_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as XML with elapsed times expressed using the ISO-8601 duration format.
SUMMARIZED_YAML - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data in YAML format.
SUMMARIZED_YAML_ISO_8601 - Static variable in class net.obvj.performetrics.util.print.PrintStyle: A string-based style for the summarized timing-session-container format, which prints data as YAML with elapsed times expressed using the ISO-8601 duration format.
SYSTEM_TIME - net.obvj.performetrics.Counter.Type: The time spent by the OS kernel to execute system level operations on behalf of the application, such as context switching, resource allocation, etc.
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(List<Counter.Type>) - Constructor for class net.obvj.performetrics.TimingSession: Creates a new timing session with custom counter types.
TimingSessionContainer - Class in net.obvj.performetrics: An object that maintains multiple timing sessions for different counter types, and provides methods to retrieve elapsed times is different formats.
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.TimingSessionContainer: Returns a string containing a formatted output for this timing-session container in default style.
toString() - Method in class net.obvj.performetrics.UnmodifiableCounter
toString() - Method in class net.obvj.performetrics.util.Duration: Returns a string representation of this Duration in default format.
toString(TimingSessionContainer) - Method in class net.obvj.performetrics.util.print.PrintStyle: Generates a string containing the formatted timing-session-container output in this style.
toString(TimingSessionContainer) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Returns a string containing a formatted summary from the given TimingSessionContainer in default style.
toString(TimingSessionContainer, PrintStyle) - Static method in class net.obvj.performetrics.util.print.PrintUtils: Returns a string containing a formatted output from the given TimingSessionContainer in a custom PrintStyle.
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.
toString(PrintStyle) - Method in class net.obvj.performetrics.TimingSessionContainer: Returns a string containing a formatted output for this timing-session container in a custom PrintStyle.
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.

U

UnmodifiableCounter - Class in net.obvj.performetrics: A "wrapper" class that allows retrieving values from a pre-existing Counter but prevents users from modifying it.
UnmodifiableCounter(Counter) - Constructor for class net.obvj.performetrics.UnmodifiableCounter: Creates an unmodifiable Counter.
UnmodifiableTimingSession - Class in net.obvj.performetrics: A "wrapper" class that allows retrieving values from an existing TimingSession but prevents users from modifying it.
UnmodifiableTimingSession(TimingSession) - Constructor for class net.obvj.performetrics.UnmodifiableTimingSession: Creates an unmodifiable object for a pre-existing TimingSession.
USER_TIME - net.obvj.performetrics.Counter.Type: The total CPU time that the current thread has executed in user mode (i.e., the time spent running current thread's code).

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.
valueOf(String) - Static method in enum net.obvj.performetrics.util.print.PrintFormat: 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.
values() - Static method in enum net.obvj.performetrics.util.print.PrintFormat: Returns an array containing the constants of this enum type, in the order they are declared.

W

WALL_CLOCK_TIME - net.obvj.performetrics.Counter.Type: The elapsed time experienced by a user waiting for a task to complete.
withAllTypes() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Removes any type exclusion configuration at the target print style.
withAlternativeLine(char, int) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines an alternative line, to be generated using the specified character repeated to a given length.
withAlternativeLine(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines an alternative line.
withCustomCounterName(Counter.Type, String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines a custom counter name for a specific counter type.
withDurationFormat(DurationFormat) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines the DurationFormat to be applied on all rows containing a time duration.
withHeader() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables the header row, to be formatted using the same general row format and preset column names.
withHeader(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables the header row and defines a specific format string in printf-style to be applied.
withLegends() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables printing legends after time durations.
withoutHeader() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Explicitly disables the header row.
withoutLegends() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Explicitly disables legends after time durations.
withoutSectionSummary() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Explicitly disables the section summary row.
withoutSectionTrailer() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Explicitly disables the section trailer row.
withoutTrailer() - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Explicitly disables the trailer row.
withoutTypes(Counter.Type...) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Removes the specified type(s) from the output, if present in the stopwatch.
withRowFormat(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines a format string in printf-style to be applied for all rows.
withSectionHeader(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines a format string in printf-style to the applied for the section headers.
withSectionSummary(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables the section summary row and defines the format string in printf-style to be applied.
withSectionTrailer(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables the section trailer row and defines the format string in printf-style to be applied.
withSimpleLine(char, int) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines a simple line, to be generated using the specified character repeated to a given length.
withSimpleLine(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Defines a simple line.
withTrailer(String) - Method in class net.obvj.performetrics.util.print.PrintStyleBuilder: Enables the trailer row and defines a specific format string in printf-style to be applied.

Z

ZERO - Static variable in class net.obvj.performetrics.util.Duration: Constant for a duration of zero.

A B C D E F G H I L M N O P R S T U V W Z
All Classes All Packages