TablePrinter (org.refcodes:refcodes-textual 0.2.0 API)

All Known Subinterfaces:

TableBuilder

All Known Implementing Classes:

TableBuilderImpl
```
public interface TablePrinter
```
In comparison to the TableBuilder, the TablePrinter just provides the methods required to print a table. This is most useful when you want to create a TablePrinter composite (which encapsulates many TablePrinter instances) which only requires the printing methods as the builder methods would make no sense: Think of a TablePrinter which is used for logging text with a LogPriority. For each LogPriority there is a dedicated TablePrinter instance configured slightly different, e.g using different text colors for the printed row depending on the LogPriority. Those "internal" TablePrinter instances would be pre-configured so that a TableBuilder composite would actually overload the composite with builder pattern functionality which must not be applied to the internal TablePrinter instance. Actually the internal TablePrinter instances would be TableBuilder instances as them are configured each Individually using the builder pattern.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TableStatus`	`getTableStatus()` Retrieves the `TablePrinter` (`TableBuilder`) status.
`void`	`printHeader(String... aColumns)` Prints the table's header to the `PrintStream` configured for this `PrintWriter` with the content of the provided columns.
`void`	`printHeaderBegin()` Prints out a header begin to the `PrintStream` configured for this `PrintWriter`, for convenience reasons, this is being encapsulated by the `printHeader(String...)` method.
`void`	`printHeaderContinue(String... aColumns)` Continues to print out a begun header to the `PrintStream` configured for this `PrintWriter`, for convenience reasons, this is being encapsulated by the `printHeader(String...)` method.
`void`	`printHeaderEnd()` Prints out a header end to the `PrintStream` configured for this `PrintWriter`, for convenience reasons, this is being encapsulated by the `printHeader(String...)` method.
`void`	`printHeaderEnd(TableBuilder aTablePrinter)` Ends the headers of the provided `TableBuilder` for this table printer to continue to the `PrintStream` configured for this `PrintWriter`; different header widths and column widths are taken care of, so it is a pleasure to mix different `TableBuilder`s, especially when empty columns may result in better using another column layout making better use of the available width.
`void`	`printRow(String... aColumns)` Prints the table's (next) row to the `PrintStream` configured for this `PrintWriter` with the content of the provided columns.
`void`	`printRowBegin()` Prints out a row begin to the `PrintStream` configured for this `PrintWriter`, for convenience reasons, this is being encapsulated by the `printRow(String...)` method.
`void`	`printRowContinue(String... aColumns)` Continues a print out begun row to the `PrintStream` configured for this `PrintWriter`, for convenience reasons, this is being encapsulated by the `printRow(String...)` method.
`void`	`printRowEnd(TableBuilder aTablePrinter)` Ends the rows of the provided `TableBuilder` for this table printer to continue to the `PrintStream` configured for this `PrintWriter`; different row widths and column widths are taken care of, so it is a pleasure to mix different `TableBuilder`s, especially when empty columns may result in better using another column layout making better use of the available width.
`void`	`printTail()` Finishes off the table by printing its closing to the `PrintStream` configured for this `PrintWriter`.
`TablePrinter`	`setTableStatus(TableStatus aTableStatus)` Set the `TablePrinter` (`TableBuilder`) status.
`String`	`toHeader(String... aColumns)` Prints the table's header with the content of the provided columns.
`String`	`toHeaderBegin()` Begins a header, for convenience reasons, this is being encapsulated by the `toHeader(String...)` method.
`String`	`toHeaderContinue(String... aColumns)` Continues a begun header, for convenience reasons, this is being encapsulated by the `toHeader(String...)` method.
`String`	`toHeaderEnd()` Ends a header, for convenience reasons, this is being encapsulated by the `toHeader(String...)` method.
`String`	`toHeaderEnd(TableBuilder aTablePrinter)` Ends the headers of the provided `TableBuilder` for this table printer to continue; different header widths and column widths are taken care of, so it is a pleasure to mix different `TableBuilder`s, especially when empty columns may result in better using another column layout making better use of the available width.
`String`	`toRow(String... aColumns)` Prints the table's (next) row with the content of the provided columns.
`String`	`toRowBegin()` Begins a row, for convenience reasons, this is being encapsulated by the `toRow(String...)` method.
`String`	`toRowContinue(String... aColumns)` Continues a begun row, for convenience reasons, this is being encapsulated by the `toRow(String...)` method.
`String`	`toRowEnd(TableBuilder aTablePrinter)` Ends the rows of the provided `TableBuilder` for this table printer to continue; different row widths and column widths are taken care of, so it is a pleasure to mix different `TableBuilder`s, especially when empty columns may result in better using another column layout making better use of the available width.
`String`	`toTail()` Finishes off the table by closing it.

- Method Detail
  - toHeaderBegin
```
String toHeaderBegin()
```
    Begins a header, for convenience reasons, this is being encapsulated by the toHeader(String...) method. Use this method in case you need more control on the header construction than toHeader(String...) can provide you.
    
    Returns:
    
    The header's begin String including the line breaks.
  - toHeaderContinue
```
String toHeaderContinue(String... aColumns)
```
    Continues a begun header, for convenience reasons, this is being encapsulated by the toHeader(String...) method. Use this method in case you need more control on the header construction than toHeader(String...) can provide you.
    
    Returns:
    
    The begun header continued String including the line breaks.
  - toHeaderEnd
```
String toHeaderEnd(TableBuilder aTablePrinter)
```
    Ends the headers of the provided TableBuilder for this table printer to continue; different header widths and column widths are taken care of, so it is a pleasure to mix different TableBuilders, especially when empty columns may result in better using another column layout making better use of the available width.
    
    Parameters:
    
    aTablePrinter - The TableBuilder to which to append this TableBuilder's headers.
    
    Returns:
    
    The divider header joining the provided (top) TableBuilder's layout with this (bottom) TableBuilder's layout.
  - toHeaderEnd
```
String toHeaderEnd()
```
    Ends a header, for convenience reasons, this is being encapsulated by the toHeader(String...) method. Use this method in case you need more control on the header construction than toHeader(String...) can provide you.
    
    Returns:
    
    The header's end String including the line breaks.
  - toRowBegin
```
String toRowBegin()
```
    Begins a row, for convenience reasons, this is being encapsulated by the toRow(String...) method. Use this method in case you need more control on the row construction than toRow(String...) can provide you.
    
    Returns:
    
    The row's begin String including the line breaks.
  - toRowContinue
```
String toRowContinue(String... aColumns)
```
    Continues a begun row, for convenience reasons, this is being encapsulated by the toRow(String...) method. Use this method in case you need more control on the header construction than toRow(String...) can provide you.
    
    Returns:
    
    The begun row continued String including the line breaks.
  - toRowEnd
```
String toRowEnd(TableBuilder aTablePrinter)
```
    Ends the rows of the provided TableBuilder for this table printer to continue; different row widths and column widths are taken care of, so it is a pleasure to mix different TableBuilders, especially when empty columns may result in better using another column layout making better use of the available width.
    
    Parameters:
    
    aTablePrinter - The TableBuilder to which to append this TableBuilder's rows.
    
    Returns:
    
    The divider row joining the provided (top) TableBuilder's layout with this (bottom) TableBuilder's layout.
  - toHeader
```
String toHeader(String... aColumns)
```
    Prints the table's header with the content of the provided columns.
    
    Parameters:
    
    aColumns - The columns to be used in the table's header.
    
    Returns:
    
    The header String including line breaks as it most probably will consist of more than one line.
  - toRow
```
String toRow(String... aColumns)
```
    Prints the table's (next) row with the content of the provided columns. Call this method for each row to print out.
    
    Parameters:
    
    aColumns - The columns to be used in the (next) table's row.
    
    Returns:
    
    The row String including line breaks as it most probably will consist of more than one line.
  - toTail
```
String toTail()
```
    Finishes off the table by closing it.
    
    Returns:
    
    The tail of the table for finishing the table off.
  - printHeaderBegin
```
void printHeaderBegin()
```
    Prints out a header begin to the PrintStream configured for this PrintWriter, for convenience reasons, this is being encapsulated by the printHeader(String...) method. Use this method in case you need more control on the header construction than printHeader(String...) can provide you.
  - printHeaderContinue
```
void printHeaderContinue(String... aColumns)
```
    Continues to print out a begun header to the PrintStream configured for this PrintWriter, for convenience reasons, this is being encapsulated by the printHeader(String...) method. Use this method in case you need more control on the header construction than printHeader(String...) can provide you.
  - printHeaderEnd
```
void printHeaderEnd(TableBuilder aTablePrinter)
```
    Ends the headers of the provided TableBuilder for this table printer to continue to the PrintStream configured for this PrintWriter; different header widths and column widths are taken care of, so it is a pleasure to mix different TableBuilders, especially when empty columns may result in better using another column layout making better use of the available width.
    
    Parameters:
    
    aTablePrinter - The TableBuilder to which to append this TableBuilder's headers.
  - printHeaderEnd
```
void printHeaderEnd()
```
    Prints out a header end to the PrintStream configured for this PrintWriter, for convenience reasons, this is being encapsulated by the printHeader(String...) method. Use this method in case you need more control on the header construction than printHeader(String...) can provide you.
  - printRowBegin
```
void printRowBegin()
```
    Prints out a row begin to the PrintStream configured for this PrintWriter, for convenience reasons, this is being encapsulated by the printRow(String...) method. Use this method in case you need more control on the row construction than printRow(String...) can provide you.
  - printRowContinue
```
void printRowContinue(String... aColumns)
```
    Continues a print out begun row to the PrintStream configured for this PrintWriter, for convenience reasons, this is being encapsulated by the printRow(String...) method. Use this method in case you need more control on the header construction than printRow(String...) can provide you.
  - printRowEnd
```
void printRowEnd(TableBuilder aTablePrinter)
```
    Ends the rows of the provided TableBuilder for this table printer to continue to the PrintStream configured for this PrintWriter; different row widths and column widths are taken care of, so it is a pleasure to mix different TableBuilders, especially when empty columns may result in better using another column layout making better use of the available width.
    
    Parameters:
    
    aTablePrinter - The TableBuilder to which to append this TableBuilder's rows.
  - printHeader
```
void printHeader(String... aColumns)
```
    Prints the table's header to the PrintStream configured for this PrintWriter with the content of the provided columns.
    
    Parameters:
    
    aColumns - The columns to be used in the table's header.
  - printRow
```
void printRow(String... aColumns)
```
    Prints the table's (next) row to the PrintStream configured for this PrintWriter with the content of the provided columns. Call this method for each row to print out.
    
    Parameters:
    
    aColumns - The columns to be used in the (next) table's row.
  - printTail
```
void printTail()
```
    Finishes off the table by printing its closing to the PrintStream configured for this PrintWriter.
  - getTableStatus
```
TableStatus getTableStatus()
```
    Retrieves the TablePrinter (TableBuilder) status. The TableStatus is required by a TablePrinter ( TableBuilder) to determine whether to do additional table decoration for a print operation or to fail that operation as of an illegal state exception. As far as possible an illegal state exception is to be tried to be prevented by decorating the table automatically by an operation as of the current TableStatus.
    
    Returns:
    
    The table's current TableStatus.
  - setTableStatus
```
TablePrinter setTableStatus(TableStatus aTableStatus)
```
    Set the TablePrinter (TableBuilder) status. The TableStatus is required by a TablePrinter ( TableBuilder) to determine whether to do additional table decoration for a print operation or to fail that operation as of an illegal state exception. As far as possible an illegal state exception is to be tried to be prevented by decorating the table automatically by an operation as of the current TableStatus. Setting the status manually, you can use differently configured TablePrinter interfaces to print their lines according to the status of a previous TablePrinter.
    
    Parameters:
    
    aTableStatus - The table's current TableStatus to be set.

Interface TablePrinter

Method Summary

Method Detail

toHeaderBegin

toHeaderContinue

toHeaderEnd

toHeaderEnd

toRowBegin

toRowContinue

toRowEnd

toHeader

toRow

toTail

printHeaderBegin

printHeaderContinue

printHeaderEnd

printHeaderEnd

printRowBegin

printRowContinue

printRowEnd

printHeader

printRow

printTail

getTableStatus

setTableStatus