com.github.chrisgleissner.jutil.table

Class TablePrinter

java.lang.Object

com.github.chrisgleissner.jutil.table.TablePrinter

public class TablePrinter
extends Object

Pretty prints a table. A table consists of an optional header, followed by a random number of rows. Ideally, the number of columns in the header and in each row should be identical, but the printer handles diverging number of columns by padding missing data.

Field Summary

Fields

Modifier and Type	Field and Description
static TablePrinter	DefaultTablePrinter

Constructor Summary

Constructors

Constructor and Description
TablePrinter()

Method Summary

Modifier and Type	Method and Description
String	print(Iterable<String> headers, Iterable<? extends Iterable<String>> data) Prints the specified headers and data to a string.
void	print(Iterable<String> headers, Iterable<? extends Iterable<String>> data, OutputStream os) Prints the specified headers and data to the specified OutputStream.
String	print(TableProvider tableProvider) Prints the headers and data exposed by the specified TableProvider to the specified OutputStream.
void	print(TableProvider tableProvider, OutputStream os) Prints the headers and data exposed by the specified TableProvider to the specified OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

DefaultTablePrinter

public static TablePrinter DefaultTablePrinter

Constructor Detail

TablePrinter

public TablePrinter()

Method Detail

print

public String print(TableProvider tableProvider)

Prints the headers and data exposed by the specified TableProvider to the specified OutputStream.

Parameters:

tableProvider - that describes the table to print

Returns:

String representation of the table

print

public String print(Iterable<String> headers,
                    Iterable<? extends Iterable<String>> data)

Prints the specified headers and data to a string.

Parameters:

headers - describes the table's columns. Should have the same number of columns as each of the data rows.

data - describes the table's rows. Each element in the outer Iterable is a row and each element in the inner Iterable represents this row's columns.

Returns:

String representation of the headers and data

print

public void print(TableProvider tableProvider,
                  OutputStream os)

Prints the headers and data exposed by the specified TableProvider to the specified OutputStream.

Parameters:

tableProvider - that describes the table to print

os - to which the String representation of the table will be written

print

public void print(Iterable<String> headers,
                  Iterable<? extends Iterable<String>> data,
                  OutputStream os)

Prints the specified headers and data to the specified OutputStream.

Parameters:

headers - describes the table's columns. Should have the same number of columns as each of the data rows.

data - describes the table's rows. Each element in the outer Iterable is a row and each element in the inner Iterable represents this row's columns.

os - to which the String representation of the headers and data will be written