net.obvj.performetrics

Class Stopwatch

java.lang.Object

net.obvj.performetrics.Stopwatch

public class Stopwatch
extends Object

A convenient object for timings that support multiple counter types

This class is not thread-safe.

Author:

oswaldo.bapvic.jr

Constructor Summary

Constructors

Constructor and Description
Stopwatch() Creates a new stopwatch with default counter types
Stopwatch(Counter.Type... types) Creates a new stopwatch with specific counter types

Method Summary

Modifier and Type	Method and Description
static Stopwatch	createStarted() Provides a started stopwatch for convenience with default counter types
static Stopwatch	createStarted(Counter.Type... types) Provides a started stopwatch for convenience with specific counter types
Collection<Counter>	getAllCounters()
Counter	getCounter(Counter.Type type)
void	printStatistics(PrintStream printStream) Prints stopwatch statistics in the specified print stream.
void	printStatistics(PrintStream printStream, TimeUnit timeUnit) Prints stopwatch statistics in the specified print stream, with a custom time unit.
void	reset() Resets all counters for this stopwatch
void	start() Starts the stopwatch
void	stop() Stops the stopwatch

Methods inherited from class java.lang.Object

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

Constructor Detail

Stopwatch

public Stopwatch()

Creates a new stopwatch with default counter types

Stopwatch

public Stopwatch(Counter.Type... types)

Creates a new stopwatch with specific counter types

Parameters:

types - the types to be set

Method Detail

createStarted

public static Stopwatch createStarted()

Provides a started stopwatch for convenience with default counter types

Returns:

a new, started stopwatch

createStarted

public static Stopwatch createStarted(Counter.Type... types)

Provides a started stopwatch for convenience with specific counter types

Parameters:

types - the types to be set

Returns:

a new, started stopwatch

reset

public void reset()

Resets all counters for this stopwatch

start

public void start()

Starts the stopwatch

stop

public void stop()

Stops the stopwatch

getAllCounters

public Collection<Counter> getAllCounters()

Returns:

all counters in this stopwatch

getCounter

public Counter getCounter(Counter.Type type)

Parameters:

type - the counter type to be fetched

Returns:

the counter matching the given type inside this stopwatch

printStatistics

public void printStatistics(PrintStream printStream)

Prints stopwatch statistics in the specified print stream.

Parameters:

printStream - the print stream to which statistics will be sent

printStatistics

public void printStatistics(PrintStream printStream,
                            TimeUnit timeUnit)

Prints stopwatch statistics in the specified print stream, with a custom time unit.

Parameters:

printStream - the print stream to which statistics will be sent

timeUnit - the time unit for the elapsed times to be displayed