de.vandermeer.asciitable

Interface AT_Renderer

All Superinterfaces:

CategoryIs, IsRenderer, IsTableRenderer

public interface AT_Renderer
extends IsTableRenderer

Standard renderer for AsciiTable.

Since:

v0.3.0

Version:

v0.3.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
static AT_Renderer	create() Creates a new renderer.
default AT_ColumnWidthCalculator	getCWC() Returns the column width calculator for the rendered.
String	getLineSeparator() Returns the current set line separator.
default String	render(LinkedList<AT_Row> rows, int colNumbers, AT_Context ctx) Renders an AsciiTable.
default String	render(LinkedList<AT_Row> rows, int colNumbers, AT_Context ctx, int width) Renders an AsciiTable.
default Collection<StrBuilder>	renderAsCollection(LinkedList<AT_Row> rows, int colNumbers, AT_Context ctx) Renders an AsciiTable.
default Collection<StrBuilder>	renderAsCollection(LinkedList<AT_Row> rows, int colNumbers, AT_Context ctx, int width) Renders an AsciiTable.
AT_Renderer	setCWC(AT_ColumnWidthCalculator cwc) Sets the column width calculator for the rendered.
AT_Renderer	setLineSeparator(String separator) Sets a new line separator for the renderer, overwriting any separator a table defines.

Method Detail

create

static AT_Renderer create()

Creates a new renderer.

Returns:

new renderer

getCWC

default AT_ColumnWidthCalculator getCWC()

Returns the column width calculator for the rendered.

Returns:

column width calculator, null if not set

getLineSeparator

String getLineSeparator()

Returns the current set line separator.

Returns:

the line separator, null if none set

render

default String render(LinkedList<AT_Row> rows,
                      int colNumbers,
                      AT_Context ctx)

Renders an AsciiTable.

Parameters:

rows - table rows to render, cannot be null

colNumbers - number of columns in the table

ctx - context of the original table with relevant settings, cannot be null

Returns:

a single string with the rendered table

Throws:

{@link - NullPointerException} if rows or context where null

render

default String render(LinkedList<AT_Row> rows,
                      int colNumbers,
                      AT_Context ctx,
                      int width)

Renders an AsciiTable.

Parameters:

rows - table rows to render, cannot be null

colNumbers - number of columns in the table

ctx - context of the original table with relevant settings, cannot be null

width - maximum line width, excluding any extra padding

Returns:

a single string with the rendered table

Throws:

{@link - NullPointerException} if rows or context where null

renderAsCollection

default Collection<StrBuilder> renderAsCollection(LinkedList<AT_Row> rows,
                                                  int colNumbers,
                                                  AT_Context ctx)

Renders an AsciiTable.

Parameters:

rows - table rows to render, cannot be null

colNumbers - number of columns in the table

ctx - context of the original table with relevant settings, cannot be null

Returns:

collection of lines, each as a StrBuilder

Throws:

{@link - NullPointerException} if rows or context where null

renderAsCollection

default Collection<StrBuilder> renderAsCollection(LinkedList<AT_Row> rows,
                                                  int colNumbers,
                                                  AT_Context ctx,
                                                  int width)

Renders an AsciiTable.

Parameters:

rows - table rows to render, cannot be null

colNumbers - number of columns in the table

ctx - context of the original table with relevant settings, cannot be null

width - maximum line width, excluding any extra padding

Returns:

collection of lines, each as a StrBuilder

Throws:

{@link - NullPointerException} if rows or context where null

setCWC

AT_Renderer setCWC(AT_ColumnWidthCalculator cwc)

Sets the column width calculator for the rendered.

Parameters:

cwc - new calculator, ignored if null

Returns:

self to allow for chaining

setLineSeparator

AT_Renderer setLineSeparator(String separator)

Sets a new line separator for the renderer, overwriting any separator a table defines.

Parameters:

separator - the new separator, ignored if blank

Returns:

self to allow chaining