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	print(Stopwatch stopwatch, PrintStream printStream) Prints elapsed times from the given stopwatch in the specified print stream.
static void	print(Stopwatch stopwatch, PrintStream printStream, PrintStyle printStyle) Prints elapsed times from the given stopwatch in the specified print stream, with a custom PrintStyle.
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) Deprecated. Use toString(Stopwatch) instead.
static String	summaryToString(Stopwatch stopwatch, PrintStyle printStyle) Deprecated. Use toString(Stopwatch, PrintStyle) instead.
static String	toString(Stopwatch stopwatch) Returns a string containing a formatted summary from the given stopwatch in default style.
static String	toString(Stopwatch stopwatch, PrintStyle printStyle) Returns a string containing a formatted output from the given stopwatch in 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 (defined by Performetrics.setDefaultPrintStyleForSummary(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; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyleForSummary(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 (defined by Performetrics.setDefaultPrintStyleForDetails(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; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyleForDetails(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

@Deprecated
public static String summaryToString(Stopwatch stopwatch)

Deprecated. Use toString(Stopwatch) instead.

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

@Deprecated
public static String summaryToString(Stopwatch stopwatch,
                                                  PrintStyle printStyle)

Deprecated. Use toString(Stopwatch, PrintStyle) instead.

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

print

public static void print(Stopwatch stopwatch,
                         PrintStream printStream)

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

The default PrintStyle (defined by Performetrics.setDefaultPrintStyle(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.4.0

print

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

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

The PrintFormat (whether to generate a summarized or detailed view) will be determined by the specified PrintStyle.

Parameters:

stopwatch - the stopwatch to be printed; not null

printStream - the print stream to which data will be sent; not null

printStyle - the PrintStyle; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied

Throws:

NullPointerException - if a null stopwatch or print stream is received

Since:

2.4.0

toString

public static String toString(Stopwatch stopwatch)

Returns a string containing a formatted summary from the given stopwatch in default style.

The default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied.

Parameters:

stopwatch - to stopwatch to be used; not null

Returns:

string containing a formatted output from the given stopwatch

Since:

2.4.0

toString

public static String toString(Stopwatch stopwatch,
                              PrintStyle printStyle)

Returns a string containing a formatted output from the given stopwatch in a custom PrintStyle.

The PrintFormat (whether to generate a summarized or detailed view) will be determined by the specified PrintStyle.

Parameters:

stopwatch - to stopwatch to be used

printStyle - the PrintStyle; if null, the default PrintStyle (defined by Performetrics.setDefaultPrintStyle(PrintStyle)) will be applied

Returns:

string containing a formatted output from the given stopwatch

Since:

2.4.0