net.obvj.performetrics.util.print

Class PrintUtils

java.lang.Object

net.obvj.performetrics.util.print.PrintUtils

public class PrintUtils
extends Object

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

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static void	printDetails(Stopwatch stopwatch, PrintStream printStream) Prints detailed information about timing sessions from the given stopwatch in the specified print stream.
static void	printDetails(Stopwatch stopwatch, PrintStream printStream, PrintStyle printStyle) Prints detailed information about timing sessions from the given stopwatch in the specified print stream, with a custom PrintStyle.
static void	printSummary(Stopwatch stopwatch, PrintStream printStream) Prints summarized elapsed times from the given stopwatch in the specified print stream.
static void	printSummary(Stopwatch stopwatch, PrintStream printStream, PrintStyle printStyle) Prints summarized elapsed times from the given stopwatch in the specified print stream, with a custom PrintStyle.
static String	summaryToString(Stopwatch stopwatch) Returns a string containing a formatted summary from the given stopwatch.
static String	summaryToString(Stopwatch stopwatch, PrintStyle printStyle) Returns a string containing a formatted summary from the given stopwatch, with a custom PrintStyle.

Methods inherited from class java.lang.Object

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

Method Detail

printSummary

public static void printSummary(Stopwatch stopwatch,
                                PrintStream printStream)

Prints summarized elapsed times from the given stopwatch in the specified print stream.

The default PrintStyle will be applied.

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which data will be sent

Throws:

NullPointerException - if a null stopwatch or print stream is received

Since:

2.2.1

printSummary

public static void printSummary(Stopwatch stopwatch,
                                PrintStream printStream,
                                PrintStyle printStyle)

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

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which data will be sent

printStyle - the PrintStyle to be applied; if null, the default PrintStyle will be applied

Throws:

NullPointerException - if a null stopwatch or print stream is received

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

Since:

2.2.1

printDetails

public static void printDetails(Stopwatch stopwatch,
                                PrintStream printStream)

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

The default PrintStyle will be applied.

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which information will be sent

Throws:

NullPointerException - if a null stopwatch or print stream is received

Since:

2.2.1

printDetails

public static void printDetails(Stopwatch stopwatch,
                                PrintStream printStream,
                                PrintStyle printStyle)

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

Parameters:

stopwatch - the stopwatch to be printed

printStream - the print stream to which information will be sent

printStyle - the PrintStyle to be applied; if null, the default PrintStyle will be applied

Throws:

NullPointerException - if a null stopwatch or print stream is received

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

Since:

2.2.1

summaryToString

public static String summaryToString(Stopwatch stopwatch)

Returns a string containing a formatted summary from the given stopwatch.

Parameters:

stopwatch - to stopwatch to be used

Returns:

string containing a formatted summary from the given stopwatch

Since:

2.2.4

summaryToString

public static String summaryToString(Stopwatch stopwatch,
                                     PrintStyle printStyle)

Returns a string containing a formatted summary from the given stopwatch, with a custom PrintStyle.

Parameters:

stopwatch - to stopwatch to be used

printStyle - the PrintStyle to be applied; if null, the default PrintStyle will be applied

Returns:

string containing a formatted summary from the given stopwatch

Since:

2.2.4