net.obvj.performetrics.util.print

Class PrintStyleBuilder

java.lang.Object

net.obvj.performetrics.util.print.PrintStyleBuilder

public class PrintStyleBuilder
extends Object

A builder for creating PrintStyle objects. Example:

 
 PrintStyle printStyle = new PrintStyleBuilder()
     .withHeader()
     .withRowFormat("%-15s  %19s")
     .withDurationFormat(DurationFormat.FULL)
     .withoutLegends()
     .withSimpleLine('-', 36)
     .build();
 
 

Since:

2.2.1

Author:

oswaldo.bapvic.jr

See Also:

PrintFormat

Constructor Summary

Constructors

Constructor and Description
PrintStyleBuilder(PrintFormat printFormat) Creates an empty PrintStyle builder.
PrintStyleBuilder(PrintStyle source) Creates a new PrintStyle builder with the same attributes of an existing PrintStyle.

Method Summary

Modifier and Type	Method and Description
PrintStyle	build() Builds the PrintStyle.
static String	generateLine(char character, int length) Generates a string using the specified character repeated to a given length.
static boolean	isEmpty(String string) Returns true if the specified string is either null or empty.
PrintStyleBuilder	withAlternativeLine(char character, int length) Defines an alternative line, to be generated using the specified character repeated to a given length.
PrintStyleBuilder	withAlternativeLine(String string) Defines an alternative line.
PrintStyleBuilder	withDurationFormat(DurationFormat format) Defines the DurationFormat to be applied on all rows containing a time duration.
PrintStyleBuilder	withHeader() Enables the header row, to be formatted using the same general row format and preset column names.
PrintStyleBuilder	withHeader(String format) Enables the header row and defines a specific string format to be applied.
PrintStyleBuilder	withLegends() Enables printing legends after time durations.
PrintStyleBuilder	withoutHeader() Explicitly disables the header row.
PrintStyleBuilder	withoutLegends() Explicitly disables legends after time durations.
PrintStyleBuilder	withoutSectionSummary() Explicitly disables the section summary row.
PrintStyleBuilder	withRowFormat(String format) Defines a string format to be applied for all rows.
PrintStyleBuilder	withSectionHeaderFormat(String format) Defines a string format to the applied for the section headers.
PrintStyleBuilder	withSectionSummary(String format) Enables the section summary row and defines the string format to be applied.
PrintStyleBuilder	withSimpleLine(char character, int length) Defines a simple line, to be generated using the specified character repeated to a given length.
PrintStyleBuilder	withSimpleLine(String string) Defines a simple line.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintStyleBuilder

public PrintStyleBuilder(PrintFormat printFormat)

Creates an empty PrintStyle builder.

Parameters:

printFormat - the target PrintFormat, not null

Throws:

NullPointerException - if the specified PrintFormat is null

Since:

2.2.2

PrintStyleBuilder

public PrintStyleBuilder(PrintStyle source)

Creates a new PrintStyle builder with the same attributes of an existing PrintStyle.

Parameters:

source - the PrintStyle whose attributes are to be copied

Throws:

NullPointerException - if the specified PrintStyle is null

Method Detail

withRowFormat

public PrintStyleBuilder withRowFormat(String format)

Defines a string format to be applied for all rows.

The number and sequence of string positions must be defined according to the target stopwatch formatter:

SUMMARIZED:	Counter type (e.g.: "Wall-clock time") Elapsed time
DETAILED:	Sequential timing session identifier Elapsed time Elapsed time (accumulated) (Optional) Counter type (e.g.: "Wall-clock time")

Parameters:

format - the string format to be applied

Returns:

a reference to this builder object for chained calls

See Also:

Formatter

withHeader

public PrintStyleBuilder withHeader()

Enables the header row, to be formatted using the same general row format and preset column names.

To specify a different format for the header row, use withHeader(String).

Returns:

a reference to this builder object for chained calls

withHeader

public PrintStyleBuilder withHeader(String format)

Enables the header row and defines a specific string format to be applied.

The number and sequence of string positions must be defined according to the target stopwatch formatter:

SUMMARIZED:	Counter type Elapsed time
DETAILED:	Sequential timing session identifier Elapsed time Elapsed time (accumulated) (Optional) Counter type

To enable the header without specifying a custom format, use the zero-argument option withHeader().

Parameters:

format - the string format to be applied for the header row

Returns:

a reference to this builder object for chained calls

See Also:

Formatter

withoutHeader

public PrintStyleBuilder withoutHeader()

Explicitly disables the header row.

Returns:

a reference to this builder object for chained calls

withSectionHeaderFormat

public PrintStyleBuilder withSectionHeaderFormat(String format)

Defines a string format to the applied for the section headers.

Parameters:

format - the string format to be applied for each section header row

Returns:

a reference to this builder object for chained calls

withoutSectionSummary

public PrintStyleBuilder withoutSectionSummary()

Explicitly disables the section summary row.

Returns:

a reference to this builder object for chained calls

withSectionSummary

public PrintStyleBuilder withSectionSummary(String format)

Enables the section summary row and defines the string format to be applied.

Note: The property modified by this method is only applicable for the detailed stopwatch formatter.

Parameters:

format - the string format to be applied for the section summary row

Returns:

a reference to this builder object for chained calls

withSimpleLine

public PrintStyleBuilder withSimpleLine(char character,
                                        int length)

Defines a simple line, to be generated using the specified character repeated to a given length.

Parameters:

character - a character to compose the string

length - number of times to repeat the character; must be > 0

Returns:

a reference to this builder object for chained calls

withSimpleLine

public PrintStyleBuilder withSimpleLine(String string)

Defines a simple line.

Parameters:

string - the string to be used as the simple line

Returns:

a reference to this builder object for chained calls

withAlternativeLine

public PrintStyleBuilder withAlternativeLine(char character,
                                             int length)

Defines an alternative line, to be generated using the specified character repeated to a given length.

Parameters:

character - a character to compose the string

length - number of times to repeat the character; must be > 0

Returns:

a reference to this builder object for chained calls

withAlternativeLine

public PrintStyleBuilder withAlternativeLine(String string)

Defines an alternative line.

Parameters:

string - the string to be used as the alternative line

Returns:

a reference to this builder object for chained calls

withDurationFormat

public PrintStyleBuilder withDurationFormat(DurationFormat format)

Defines the DurationFormat to be applied on all rows containing a time duration.

Parameters:

format - the DurationFormat to be applied

Returns:

a reference to this builder object for chained calls

withLegends

public PrintStyleBuilder withLegends()

Enables printing legends after time durations.

Returns:

a reference to this builder object for chained calls

withoutLegends

public PrintStyleBuilder withoutLegends()

Explicitly disables legends after time durations.

Returns:

a reference to this builder object for chained calls

build

public PrintStyle build()

Builds the PrintStyle.

Returns:

an immutable PrintStyle; not null

isEmpty

public static boolean isEmpty(String string)

Returns true if the specified string is either null or empty.

Parameters:

string - the string to be checked

Returns:

true if the specified string is either null or empty.

generateLine

public static String generateLine(char character,
                                  int length)

Generates a string using the specified character repeated to a given length.

Parameters:

character - a character to compose the string

length - number of times to repeat the character; must be > 0

Returns:

a string with repeated character