net.obvj.performetrics.util.print

Class PrintStyle

java.lang.Object

net.obvj.performetrics.util.print.PrintStyle

public class PrintStyle
extends Object

Defines a set of attributes used by a PrintFormat to generate a String output out of a Stopwatch object.

Since:

2.2.1

Author:

oswaldo.bapvic.jr

Field Summary

Fields

Modifier and Type	Field and Description
static PrintStyle	DETAILED_CSV A string-based style for the detailed stopwatch formatter, which prints data as CSV (comma-separated values).
static PrintStyle	DETAILED_CSV_NO_HEADER A string-based style for the detailed stopwatch formatter, which prints data as CSV (comma-separated values), without header.
static PrintStyle	DETAILED_TABLE_FULL A string-based style for use with the detailed stopwatch formatter, with horizontal lines separating each row, and total elapsed time for each counter.
static PrintStyle	SUMMARIZED_CSV A string-based style for the summarized stopwatch formatter, which prints data as CSV (comma-separated values).
static PrintStyle	SUMMARIZED_CSV_NO_HEADER A string-based style for the summarized stopwatch formatter, which prints data as CSV (comma-separated values), without header.
static PrintStyle	SUMMARIZED_TABLE_FULL A string-based style for the summarized stopwatch formatter, which prints data in tabular format, with horizontal lines separating each row.
static PrintStyle	SUMMARIZED_TABLE_NO_HEADER A string-based style for the summarized stopwatch formatter, which prints data in tabular format without header.

Method Summary

Modifier and Type	Method and Description
static PrintStyleBuilder	builder(PrintFormat printFormat) Returns an empty PrintStyle builder.
static PrintStyleBuilder	builder(PrintStyle source) Returns a PrintStyle builder with the same attributes of an existing PrintStyle.
String	getAlternativeLine()
DurationFormat	getDurationFormat()
String	getHeaderFormat()
PrintFormat	getPrintFormat()
String	getRowFormat()
String	getSectionHeaderFormat()
String	getSectionSummaryRowFormat()
String	getSimpleLine()
boolean	isPrintHeader()
boolean	isPrintLegend()
boolean	isPrintSectionSummary()

Methods inherited from class java.lang.Object

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

Field Detail

SUMMARIZED_TABLE_NO_HEADER

public static final PrintStyle SUMMARIZED_TABLE_NO_HEADER

A string-based style for the summarized stopwatch formatter, which prints data in tabular format without header.

Sample output:

 Wall clock time    0:00:04.455383500
 CPU time           0:00:00.109375000
 User time          0:00:00.046875000
 System time        0:00:00.062500000
 

See Also:

PrintFormat.SUMMARIZED

SUMMARIZED_TABLE_FULL

public static final PrintStyle SUMMARIZED_TABLE_FULL

A string-based style for the summarized stopwatch formatter, which prints data in tabular format, with horizontal lines separating each row.

Sample output:

 ====================================
 Counter                 Elapsed time
 ------------------------------------
 Wall clock time    0:00:04.455383500
 CPU time           0:00:00.109375000
 User time          0:00:00.046875000
 System time        0:00:00.062500000
 ====================================
 

See Also:

PrintFormat.SUMMARIZED

SUMMARIZED_CSV

public static final PrintStyle SUMMARIZED_CSV

A string-based style for the summarized stopwatch formatter, which prints data as CSV (comma-separated values).

Sample output:

 "Counter","Elapsed time"
 "Wall clock time","0:00:04.455383500"
 "CPU time","0:00:00.109375000"
 "User time","0:00:00.046875000"
 "System time","0:00:00.062500000"
 

See Also:

PrintFormat.SUMMARIZED

SUMMARIZED_CSV_NO_HEADER

public static final PrintStyle SUMMARIZED_CSV_NO_HEADER

A string-based style for the summarized stopwatch formatter, which prints data as CSV (comma-separated values), without header.

Sample output:

 "Wall clock time","0:00:04.455383500"
 "CPU time","0:00:00.109375000"
 "User time","0:00:00.046875000"
 "System time","0:00:00.062500000"
 

See Also:

PrintFormat.SUMMARIZED

DETAILED_TABLE_FULL

public static final PrintStyle DETAILED_TABLE_FULL

A string-based style for use with the detailed stopwatch formatter, with horizontal lines separating each row, and total elapsed time for each counter.

Sample output:

 ===============================================
     #         Elapsed time     Elapsed time (+)
 ===============================================
 Wall clock time
 -----------------------------------------------
     1    0:00:01.055824100    0:00:01.055824100
     2    0:00:00.836569500    0:00:01.892393600
     3    0:00:00.836091100    0:00:02.728484700
     4    0:00:00.837092700    0:00:03.565577400
 -----------------------------------------------
 TOTAL                         0:00:03.565577400
 ===============================================
 CPU time
 -----------------------------------------------
     1    0:00:00.109375000    0:00:00.109375000
     2    0:00:00.000000000    0:00:00.109375000
     3    0:00:00.000000000    0:00:00.109375000
     4    0:00:00.015625000    0:00:00.125000000
 -----------------------------------------------
 TOTAL                         0:00:00.125000000
 ===============================================
 

See Also:

PrintFormat.DETAILED

DETAILED_CSV

public static final PrintStyle DETAILED_CSV

A string-based style for the detailed stopwatch formatter, which prints data as CSV (comma-separated values).

Sample output:

 "Counter","Session","Elapsed time","Elapsed time (+)"
 "Wall clock time",1,"0:00:00.032319200","0:00:00.032319200"
 "Wall clock time",2,"0:00:00.016766500","0:00:00.049085700"
 "Wall clock time",3,"0:00:00.014459500","0:00:00.063545200"
 "CPU time",1,"0:00:00.031250000","0:00:00.031250000"
 "CPU time",2,"0:00:00.015625000","0:00:00.046875000"
 "CPU time",3,"0:00:00.015625000","0:00:00.062500000"
 

Since:

2.2.2

See Also:

PrintFormat.DETAILED

DETAILED_CSV_NO_HEADER

public static final PrintStyle DETAILED_CSV_NO_HEADER

A string-based style for the detailed stopwatch formatter, which prints data as CSV (comma-separated values), without header.

Sample output:

 "Wall clock time",1,"0:00:00.032319200","0:00:00.032319200"
 "Wall clock time",2,"0:00:00.016766500","0:00:00.049085700"
 "Wall clock time",3,"0:00:00.014459500","0:00:00.063545200"
 "CPU time",1,"0:00:00.031250000","0:00:00.031250000"
 "CPU time",2,"0:00:00.015625000","0:00:00.046875000"
 "CPU time",3,"0:00:00.015625000","0:00:00.062500000"
 

Since:

2.2.2

See Also:

PrintFormat.DETAILED

Method Detail

builder

public static PrintStyleBuilder builder(PrintFormat printFormat)

Returns an empty PrintStyle builder.

Parameters:

printFormat - the target PrintFormat, not null

Returns:

a PrintStyleBuilder instance

Throws:

NullPointerException - if the specified PrintFormat is null

Since:

2.2.2

builder

public static PrintStyleBuilder builder(PrintStyle source)

Returns a PrintStyle builder with the same attributes of an existing PrintStyle.

Parameters:

source - the PrintStyle whose attributes are to be copied

Returns:

a new PrintStyleBuilder instance with the same attributes of the specified source object

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.2.2

getPrintFormat

public PrintFormat getPrintFormat()

Returns:

the target PrintFormat

getDurationFormat

public DurationFormat getDurationFormat()

Returns:

the DurationFormat to be applied on all rows

isPrintLegend

public boolean isPrintLegend()

Returns:

a flag indicating whether or not duration legends shall be printed

isPrintHeader

public boolean isPrintHeader()

Returns:

a flag indicating whether or not the header shall be printed

isPrintSectionSummary

public boolean isPrintSectionSummary()

Returns:

a flag indicating whether or not a summary shall be printed for each section

getHeaderFormat

public String getHeaderFormat()

Returns:

the string format to be applied to the table header

getRowFormat

public String getRowFormat()

Returns:

the string format to be applied to all rows in general

getSectionHeaderFormat

public String getSectionHeaderFormat()

Returns:

the string format to be applied to each section header

getSectionSummaryRowFormat

public String getSectionSummaryRowFormat()

Returns:

the string format for the total/summary row(s)

getSimpleLine

public String getSimpleLine()

Returns:

a string to be used as simple split line

getAlternativeLine

public String getAlternativeLine()

Returns:

a string to be used as alternative split line