Tables

The TableFormatter and SortedTableFormatter classes provide mechanisms for building and printing tabular data.

Basic Tables

Examples

Without Headers

TableFormatter()
  .addRow("Apples", "25")
  .addRow("Pears", "10")
  .addRow("Bananas", "4")
  .print()

Will output:

Apples   25
Pears    10
Bananas  4

With Headers

TableFormatter("Produce", "Remaining")
  .addRow("Apples", "25")
  .addRow("Pears", "10")
  .addRow("Bananas", "4")
  .print()

Will output:

| Produce | Remaining |
-----------------------
| Apples  | 25        |
| Pears   | 10        |
| Bananas | 4         |

Sorting Table Contents

SortedTableFormatter extends the basic TableFormatter to sort the contents by a column. The default sort ordering is by the first column.

Examples

SortedTableFormatter()
  .addRow("Apples", "25")
  .addRow("Pears", "10")
  .addRow("Bananas", "4")
  .print()

Will output:

Apples   25
Bananas  4
Pears    10

Or with a different sort column:

SortedTableFormatter()
  .withSortColumnIndex(1)
  .addRow("Apples", "25")
  .addRow("Pears", "10")
  .addRow("Bananas", "4")
  .print()

Will output:

Pears    10
Apples   25
Bananas  4

Configuration

Prefix, Separator & Suffix

The prefix before the first column, separator between columns and the suffix after the last column can be configured:

Stripping Trailing Newlines

In some scenarios the newline at the end of the final row may interfere with other formatting. This can be fixed by setting stripTrailingNewline:

TableFormatter()
  .withStripTrailingNewline
  .addRow("Foo", "Bar")
  .print()