de.vandermeer.asciitable.v2

Class V2_AsciiTable

Object

V2_AsciiTable

public class V2_AsciiTable
extends Object

2nd generation ASCII table with flexible column number, column width, wrapping, spanning and renderer with themes.

Since:

v0.0.5

Version:

v0.2.3 build 150910 (10-Sep-15) for Java 1.7

Author:

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

Constructor Summary

Constructors

Constructor and Description
V2_AsciiTable() Creates a new table.
V2_AsciiTable(int padding) Creates a new table with default padding to be used for columns in content rows.

Method Summary

Modifier and Type	Method and Description
ContentRow	addRow(Object... columns) Adds a content row to the table.
void	addRule() Adds a rule row to the table.
void	addStrongRule() Adds a rule with strong (emphasized) style row to the table.
int	getColumnCount() Returns the number of columns set for the table.
int	getDefaultPadding() Returns the table's default padding.
List<V2_Row>	getTable() Returns the table.
String	toString() Returns a string with debug information.

Methods inherited from class Object

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

Constructor Detail

V2_AsciiTable

public V2_AsciiTable()

Creates a new table. The number of columns used in the first content row determines the number of columns for the table.

V2_AsciiTable

public V2_AsciiTable(int padding)

Creates a new table with default padding to be used for columns in content rows. The standard value (if not set) is 1, meaning 1 character left and one character right.

Parameters:

padding - default padding

Method Detail

getDefaultPadding

public int getDefaultPadding()

Returns the table's default padding.

Returns:

default padding

addRule

public final void addRule()

Adds a rule row to the table. If the table has no rows specified, the rule will be a top rule. Otherwise it will be a mid rule. The renderer will automatically convert a final mid rule (last row of a table) into a bottom rule.

addStrongRule

public final void addStrongRule()

Adds a rule with strong (emphasized) style row to the table. If the table has no rows specified, the rule will be a top rule. Otherwise it will be a mid rule. The renderer will automatically convert a final mid rule (last row of a table) into a bottom rule.

getTable

public final List<V2_Row> getTable()

Returns the table.

Returns:

table

addRow

public final ContentRow addRow(Object... columns)
                        throws TableException

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 getColumnCount().

Parameters:

columns - content of the columns for the row

Returns:

the created row for further customization

Throws:

TableException - if parameter is null or does not have the correct size (more or less entries than columns defined for the table)

getColumnCount

public final int getColumnCount()

Returns the number of columns set for the table.

Returns:

number of columns

toString

public String toString()

Returns a string with debug information.

Overrides:

toString in class Object

Returns:

string with debug information about the table