AsciiTable (ASCII Table 0.3.2 API)

Object
- AsciiTable

All Implemented Interfaces:

CategoryDoes, CategoryHas, CategoryIs, HasToLog, IsDocumentElement, IsTable, HasObjectContext, DoesRender, DoesRenderToWidth, HasRenderer, RendersToCluster, RendersToClusterWidth
```
public class AsciiTable
extends Object
implements IsTable
```
An ASCII table with some formatting options.

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>

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`colNumber` Number of columns for the table.
`protected AT_Context`	`ctx` The table context with optional settings for the table.
`protected AT_Renderer`	`renderer` The renderer for the paragraph, default is `AP_Renderer`.
`protected LinkedList<AT_Row>`	`rows` Rows of the table.

Constructor Summary

Constructors
Constructor and Description

AsciiTable()
Creates a new ASCII table with a default context.

AsciiTable(AT_Context ctx)
Creates a new ASCII table with given context.

Constructors
Constructor and Description
`AsciiTable()` Creates a new ASCII table with a default context.
`AsciiTable(AT_Context ctx)` Creates a new ASCII table with given context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeavyRule()` Adds a rule with heavy (super emphasized) style row to the table.
`void`	`addLightRule()` Adds a rule with light (less emphasized) style row to the table.
`AT_Row`	`addRow(Collection<?> columns)` Adds a content row to the table.
`AT_Row`	`addRow(Object... columns)` Adds a content row to the table.
`void`	`addRule()` Adds a rule row to the table using the default style `TableRowStyle.NORMAL`.
`void`	`addRule(TableRowStyle style)` Adds a rule row to the table with a given style.
`void`	`addStrongRule()` Adds a rule with strong (emphasized) style row to the table.
`int`	`getColNumber()` Returns the set number of columns in the table.
`AT_Context`	`getContext()` Returns the table context.
`LinkedList<AT_Row>`	`getRawContent()`
`AT_Renderer`	`getRenderer()`
`String`	`render()`
`String`	`render(int width)`
`Collection<String>`	`renderAsCollection()`
`Collection<String>`	`renderAsCollection(int width)`
`AsciiTable`	`setCharTranslator(CharacterTranslator charTranslator)` Sets the character translator for all cells in the table.
`AsciiTable`	`setHtmlElementTranslator(HtmlElementTranslator htmlElementTranslator)` Sets the HTML entity translator for all cells in the table.
`AsciiTable`	`setPadding(int padding)` Sets all padding for all cells in the table to the same value.
`AsciiTable`	`setPaddingBottom(int paddingBottom)` Sets the bottom padding for all cells in the table.
`AsciiTable`	`setPaddingBottomChar(Character paddingBottomChar)` Sets the bottom padding character for all cells in the table.
`AsciiTable`	`setPaddingLeft(int paddingLeft)` Sets the left padding for all cells in the table.
`AsciiTable`	`setPaddingLeftChar(Character paddingLeftChar)` Sets the left padding character for all cells in the table.
`AsciiTable`	`setPaddingLeftRight(int padding)` Sets left and right padding for all cells in the table.
`AsciiTable`	`setPaddingLeftRight(int paddingLeft, int paddingRight)` Sets left and right padding for all cells in the table (only if both values are not smaller than 0).
`AsciiTable`	`setPaddingRight(int paddingRight)` Sets the right padding for all cells in the table.
`AsciiTable`	`setPaddingRightChar(Character paddingRightChar)` Sets the right padding character for all cells in the table.
`AsciiTable`	`setPaddingTop(int paddingTop)` Sets the top padding for all cells in the table.
`AsciiTable`	`setPaddingTopBottom(int padding)` Sets top and bottom padding for all cells in the table.
`AsciiTable`	`setPaddingTopBottom(int paddingTop, int paddingBottom)` Sets top and bottom padding for all cells in the table (only if both values are not smaller than 0).
`AsciiTable`	`setPaddingTopChar(Character paddingTopChar)` Sets the top padding character for all cells in the table.
`AsciiTable`	`setRenderer(AT_Renderer renderer)` Sets the table renderer.
`AsciiTable`	`setTargetTranslator(TargetTranslator targetTranslator)` Sets the target translator for all cells in the table.
`AsciiTable`	`setTextAlignment(TextAlignment textAlignment)` Sets the text alignment for all cells in the table.
`StrBuilder`	`toLog()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface RendersToCluster
renderAsArray, renderAsIterable, renderAsIterator

Methods inherited from interface RendersToClusterWidth
renderAsArray, renderAsIterable, renderAsIterator

Methods inherited from interface HasToLog
toLog, toLog

- Field Detail
  - ctx
```
protected AT_Context ctx
```
    The table context with optional settings for the table.
  - renderer
```
protected AT_Renderer renderer
```
    The renderer for the paragraph, default is AP_Renderer.
  - rows
```
protected final LinkedList<AT_Row> rows
```
    Rows of the table.
  - colNumber
```
protected int colNumber
```
    Number of columns for the table.
- Constructor Detail
  - AsciiTable
```
public AsciiTable()
```
    Creates a new ASCII table with a default context.
  - AsciiTable
```
public AsciiTable(AT_Context ctx)
```
    Creates a new ASCII table with given context.
    
    Parameters:
    
    ctx - the table context, default context created if null
- Method Detail
  - addRow
```
public final AT_Row addRow(Collection<?> columns)
                    throws NullPointerException,
                           AsciiTableException
```
    Adds a content row to the table. For the first content row added, the number of objects given here determines the number of columns in the table. For every subsequent content row, the array must have an entry for each column, i.e. the size of the array must be the same as the result of getColNumber().
    
    Parameters:
    
    columns - content of the columns for the row, must not be null
    
    Returns:
    
    the created row for further customization
    
    Throws:
    
    {@link - NullPointerException} if columns was null
    
    {@link - AsciiTableException} if columns does not have the correct size (more or less entries than columns defined for the table)
    
    NullPointerException
    
    AsciiTableException
  - addRow
```
public final AT_Row addRow(Object... columns)
                    throws NullPointerException,
                           AsciiTableException
```
    Adds a content row to the table. For the first content row added, the number of objects given here determines the number of columns in the table. For every subsequent content row, the array must have an entry for each column, i.e. the size of the array must be the same as the result of getColNumber().
    
    Parameters:
    
    columns - content of the columns for the row, must not be null
    
    Returns:
    
    the created row for further customization
    
    Throws:
    
    {@link - NullPointerException} if columns was null
    
    {@link - AsciiTableException} if columns does not have the correct size (more or less entries than columns defined for the table)
    
    NullPointerException
    
    AsciiTableException
  - addRule
```
public final void addRule()
```
    Adds a rule row to the table using the default style TableRowStyle.NORMAL.
  - addRule
```
public final void addRule(TableRowStyle style)
```
    Adds a rule row to the table with a given style.
    
    Parameters:
    
    style - the rule style, must not be null nor TableRowStyle.UNKNOWN
    
    Throws:
    
    {@link - NullPointerException} if style was null
    
    {@link - IllegalArgumentException} if style was TableRowStyle.UNKNOWN
  - addStrongRule
```
public final void addStrongRule()
```
    Adds a rule with strong (emphasized) style row to the table.
  - addHeavyRule
```
public final void addHeavyRule()
```
    Adds a rule with heavy (super emphasized) style row to the table.
  - addLightRule
```
public final void addLightRule()
```
    Adds a rule with light (less emphasized) style row to the table.
  - getColNumber
```
public int getColNumber()
```
    Returns the set number of columns in the table.
    
    Returns:
    
    number of columns, if 0 no content row was added yet
  - getContext
```
public AT_Context getContext()
```
    Returns the table context.
    
    Specified by:
    
    getContext in interface IsTable
    
    Specified by:
    
    getContext in interface HasObjectContext
    
    Returns:
    
    context, null if not set
  - getRawContent
```
public LinkedList<AT_Row> getRawContent()
```
    Specified by:
    
    getRawContent in interface IsDocumentElement
    
    Specified by:
    
    getRawContent in interface IsTable
  - getRenderer
```
public AT_Renderer getRenderer()
```
    Specified by:
    
    getRenderer in interface IsTable
    
    Specified by:
    
    getRenderer in interface HasRenderer
  - render
```
public String render()
```
    Specified by:
    
    render in interface DoesRender
  - render
```
public String render(int width)
```
    Specified by:
    
    render in interface DoesRenderToWidth
  - renderAsCollection
```
public Collection<String> renderAsCollection()
```
    Specified by:
    
    renderAsCollection in interface RendersToCluster
  - renderAsCollection
```
public Collection<String> renderAsCollection(int width)
```
    Specified by:
    
    renderAsCollection in interface RendersToClusterWidth
  - setRenderer
```
public AsciiTable setRenderer(AT_Renderer renderer)
```
    Sets the table renderer.
    
    Parameters:
    
    renderer - new renderer, ignored if null
    
    Returns:
    
    this to allow chaining
  - toLog
```
public StrBuilder toLog()
```
    Specified by:
    
    toLog in interface HasToLog
  - setPadding
```
public AsciiTable setPadding(int padding)
```
    Sets all padding for all cells in the table to the same value.
    
    Parameters:
    
    padding - new padding for top, bottom, left, and right, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingBottom
```
public AsciiTable setPaddingBottom(int paddingBottom)
```
    Sets the bottom padding for all cells in the table.
    
    Parameters:
    
    paddingBottom - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingBottomChar
```
public AsciiTable setPaddingBottomChar(Character paddingBottomChar)
```
    Sets the bottom padding character for all cells in the table.
    
    Parameters:
    
    paddingBottomChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingLeft
```
public AsciiTable setPaddingLeft(int paddingLeft)
```
    Sets the left padding for all cells in the table.
    
    Parameters:
    
    paddingLeft - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftChar
```
public AsciiTable setPaddingLeftChar(Character paddingLeftChar)
```
    Sets the left padding character for all cells in the table.
    
    Parameters:
    
    paddingLeftChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftRight
```
public AsciiTable setPaddingLeftRight(int padding)
```
    Sets left and right padding for all cells in the table.
    
    Parameters:
    
    padding - new padding for left and right, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftRight
```
public AsciiTable setPaddingLeftRight(int paddingLeft,
                                      int paddingRight)
```
    Sets left and right padding for all cells in the table (only if both values are not smaller than 0).
    
    Parameters:
    
    paddingLeft - new left padding, ignored if smaller than 0
    
    paddingRight - new right padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingRight
```
public AsciiTable setPaddingRight(int paddingRight)
```
    Sets the right padding for all cells in the table.
    
    Parameters:
    
    paddingRight - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingRightChar
```
public AsciiTable setPaddingRightChar(Character paddingRightChar)
```
    Sets the right padding character for all cells in the table.
    
    Parameters:
    
    paddingRightChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingTop
```
public AsciiTable setPaddingTop(int paddingTop)
```
    Sets the top padding for all cells in the table.
    
    Parameters:
    
    paddingTop - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopBottom
```
public AsciiTable setPaddingTopBottom(int padding)
```
    Sets top and bottom padding for all cells in the table.
    
    Parameters:
    
    padding - new padding for top and bottom, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopBottom
```
public AsciiTable setPaddingTopBottom(int paddingTop,
                                      int paddingBottom)
```
    Sets top and bottom padding for all cells in the table (only if both values are not smaller than 0).
    
    Parameters:
    
    paddingTop - new top padding, ignored if smaller than 0
    
    paddingBottom - new bottom padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopChar
```
public AsciiTable setPaddingTopChar(Character paddingTopChar)
```
    Sets the top padding character for all cells in the table.
    
    Parameters:
    
    paddingTopChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setTextAlignment
```
public AsciiTable setTextAlignment(TextAlignment textAlignment)
```
    Sets the text alignment for all cells in the table.
    
    Parameters:
    
    textAlignment - new text alignment
    
    Returns:
    
    this to allow chaining
    
    Throws:
    
    NullPointerException - if the argument was null
    
    {@link - NullPointerException} if the argument was null
  - setTargetTranslator
```
public AsciiTable setTargetTranslator(TargetTranslator targetTranslator)
```
    Sets the target translator for all cells in the table. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    targetTranslator - translator
    
    Returns:
    
    this to allow chaining
  - setHtmlElementTranslator
```
public AsciiTable setHtmlElementTranslator(HtmlElementTranslator htmlElementTranslator)
```
    Sets the HTML entity translator for all cells in the table. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    htmlElementTranslator - translator
    
    Returns:
    
    this to allow chaining
  - setCharTranslator
```
public AsciiTable setCharTranslator(CharacterTranslator charTranslator)
```
    Sets the character translator for all cells in the table. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    charTranslator - translator
    
    Returns:
    
    this to allow chaining

Class AsciiTable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface RendersToCluster

Methods inherited from interface RendersToClusterWidth

Methods inherited from interface HasToLog

Field Detail

ctx

renderer

rows

colNumber

Constructor Detail

AsciiTable

AsciiTable

Method Detail

addRow

addRow

addRule

addRule

addStrongRule

addHeavyRule

addLightRule

getColNumber

getContext

getRawContent

getRenderer

render

render

renderAsCollection

renderAsCollection

setRenderer

toLog

setPadding

setPaddingBottom

setPaddingBottomChar

setPaddingLeft

setPaddingLeftChar

setPaddingLeftRight

setPaddingLeftRight

setPaddingRight

setPaddingRightChar

setPaddingTop

setPaddingTopBottom

setPaddingTopBottom

setPaddingTopChar

setTextAlignment

setTargetTranslator

setHtmlElementTranslator

setCharTranslator