net.obvj.performetrics.util.printer

Class PrintUtils

java.lang.Object

net.obvj.performetrics.util.printer.PrintUtils

public class PrintUtils
extends Object

This class groups all custom printing operations in a single place.

Author:

oswaldo.bapvic.jr

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COUNTERS_TABLE_COLUMN_COUNTER
protected static String	COUNTERS_TABLE_COLUMN_ELAPSED_TIME
protected static String	COUNTERS_TABLE_COLUMN_TIME_UNIT
protected static String	COUNTERS_TABLE_HEADER
protected static String	COUNTERS_TABLE_ROW_FORMAT
protected static String	COUNTERS_TABLE_ROW_SEPARATOR
protected static String	LINE_SEPARATOR

Method Summary

Modifier and Type	Method and Description
static void	printCounters(Collection<Counter> counters, PrintStream printStream) Prints the statistics for the given counters in the specified print stream.
static void	printCounters(Collection<Counter> counters, PrintStream printStream, TimeUnit timeUnit) Prints the statistics for the given counters in the specified print stream.
static void	printStopwatch(Stopwatch stopwatch, PrintStream printStream) Prints the statistics for the given stopwatch in the specified print stream.
static void	printStopwatch(Stopwatch stopwatch, PrintStream printStream, TimeUnit timeUnit) Prints the statistics for the given stopwatch in the specified print stream.
protected static String	toRowFormat(Counter counter) Returns a row with the given counter.
protected static String	toRowFormat(Counter counter, TimeUnit timeUnit) Returns a row with the given counter.
protected static String	toTableFormat(Collection<Counter> counters) Returns a table with counters and elapsed times
protected static String	toTableFormat(Collection<Counter> counters, TimeUnit timeUnit) Returns a table with counters and elapsed times in a given time unit.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

protected static final String LINE_SEPARATOR

COUNTERS_TABLE_COLUMN_TIME_UNIT

protected static final String COUNTERS_TABLE_COLUMN_TIME_UNIT

See Also:

Constant Field Values

COUNTERS_TABLE_COLUMN_ELAPSED_TIME

protected static final String COUNTERS_TABLE_COLUMN_ELAPSED_TIME

See Also:

Constant Field Values

COUNTERS_TABLE_COLUMN_COUNTER

protected static final String COUNTERS_TABLE_COLUMN_COUNTER

See Also:

Constant Field Values

COUNTERS_TABLE_ROW_FORMAT

protected static final String COUNTERS_TABLE_ROW_FORMAT

COUNTERS_TABLE_ROW_SEPARATOR

protected static final String COUNTERS_TABLE_ROW_SEPARATOR

COUNTERS_TABLE_HEADER

protected static final String COUNTERS_TABLE_HEADER

Method Detail

printStopwatch

public static void printStopwatch(Stopwatch stopwatch,
                                  PrintStream printStream)

Prints the statistics for the given stopwatch in the specified print stream.

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which statistics will be sent

Throws:

NullPointerException - if a null stopwatch or print stream is received

printCounters

public static void printCounters(Collection<Counter> counters,
                                 PrintStream printStream)

Prints the statistics for the given counters in the specified print stream.

Parameters:

counters - the counters to be printed

printStream - the print stream to which statistics will be sent

Throws:

NullPointerException - if a null stopwatch or print stream is received

printStopwatch

public static void printStopwatch(Stopwatch stopwatch,
                                  PrintStream printStream,
                                  TimeUnit timeUnit)

Prints the statistics for the given stopwatch in the specified print stream.

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which statistics will be sent

timeUnit - the time unit in which elapsed times will be displayed; if null, the default time unit specified for each counter will be applied

Throws:

NullPointerException - if a null stopwatch or print stream is received

printCounters

public static void printCounters(Collection<Counter> counters,
                                 PrintStream printStream,
                                 TimeUnit timeUnit)

Prints the statistics for the given counters in the specified print stream.

Parameters:

counters - the counters to be printed

printStream - the print stream to which statistics will be sent

timeUnit - the time unit in which elapsed times will be displayed; if null, the default time unit specified for each counter will be applied

Throws:

NullPointerException - if a null collection or print stream is received

toTableFormat

protected static String toTableFormat(Collection<Counter> counters)

Returns a table with counters and elapsed times

Parameters:

counters - the counters whose data will be fetched

Returns:

as formatted string containing a table rows with all counters and elapsed times

toTableFormat

protected static String toTableFormat(Collection<Counter> counters,
                                      TimeUnit timeUnit)

Returns a table with counters and elapsed times in a given time unit.

Parameters:

counters - the counters whose data will be fetched

timeUnit - the time unit in which elapsed times will be displayed; if null, the default time unit specified for each counter will be applied

Returns:

as formatted string containing a table rows with all counters and elapsed times

toRowFormat

protected static String toRowFormat(Counter counter)

Returns a row with the given counter. The elapsed time will be printed using the counter's default time unit.

Parameters:

counter - the counter whose data will be fetched

Returns:

a formatted String representing a row with the data fetched from the counter

toRowFormat

protected static String toRowFormat(Counter counter,
                                    TimeUnit timeUnit)

Returns a row with the given counter. The elapsed time will be printed using the given time unit.

Parameters:

counter - the counter whose data will be fetched

timeUnit - the time unit in which the counter's elapsed time will be displayed (cannot be null)

Returns:

a formatted String representing a row with the data fetched from the counter