Package com.github.rlacher.sortbench.util

Class AsciiTableFormatter

java.lang.Object

com.github.rlacher.sortbench.util.AsciiTableFormatter

public class AsciiTableFormatter
extends Object

Formats a list of AggregatedResult into an ASCII table.

Constructor Summary

Constructors

Constructor	Description
AsciiTableFormatter()	Parameterless constructor initialising class fields to defaults (i.e.
AsciiTableFormatter(Locale locale, char titleRowDelimiter, char columnDelimiter)	Overloaded constructor initialising class fields with provided Locale and delimiters.

Method Summary

Modifier and Type	Method	Description
String	format(List<AggregatedResult> results)	Entry point for formatting a list of AggregatedResult into an ASCII table.

Methods inherited from class java.lang.Object

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

Constructor Details

AsciiTableFormatter

public AsciiTableFormatter()

Parameterless constructor initialising class fields to defaults (i.e. delimiters, number formatter).

AsciiTableFormatter

public AsciiTableFormatter(Locale locale,
 char titleRowDelimiter,
 char columnDelimiter)

Overloaded constructor initialising class fields with provided Locale and delimiters.

Parameters:

locale - The Locale to use for number formatting. Must not be null.

titleRowDelimiter - The character to use for the title row delimiter.

columnDelimiter - The character to use for the column delimiter.

Throws:

IllegalArgumentException - If locale is null or if the delimiters are not printable ASCII characters.

Method Details

format

public String format(List<AggregatedResult> results)

Entry point for formatting a list of AggregatedResult into an ASCII table.

Uses the delimiters and number formatter defined in the constructor.

Parameters:

results - The list of AggregatedResult to format.

Returns:

The formatted ASCII table as a String.

Throws:

IllegalArgumentException - If the results list is null or empty.