Package org.tealeaf.javamarkdown.elements

Class Table

java.lang.Object

org.tealeaf.javamarkdown.MarkdownElement

org.tealeaf.javamarkdown.types.Structure

org.tealeaf.javamarkdown.elements.Table

public class Table
extends Structure

Renders a Table in Markdown, including Headers and row-by-row contents

Since:

0.0.18

Author:

Thomas Kwashnak

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Table.Alignment	Represents the alignment value used for columns in a Table

Constructor Summary

Constructors

Constructor	Description
Table()	Creates a new Table object

Method Summary

Modifier and Type	Method	Description
Table	addRows(Object[]... rows)	Adds rows of content to the table
String	asString()	Formats the element to a string
Table	setAlignments(Table.Alignment... alignments)	Sets the alignments for the table
Table	setHeaders(Object... headers)	Sets the headers and defaults the alignments to all be CENTER

Methods inherited from class org.tealeaf.javamarkdown.types.Structure

checkType, requiresNewlineAfter, requiresNewlineBefore

Methods inherited from class org.tealeaf.javamarkdown.MarkdownElement

asString, toAppendable, toString, toWriter

Methods inherited from class java.lang.Object

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

Constructor Details

Table

public Table()

Creates a new Table object

Since:

0.0.18

Method Details

setHeaders

public Table setHeaders(Object... headers)

Sets the headers and defaults the alignments to all be CENTER

Parameters:

headers - Array of header objects

Returns:

This table

Since:

0.0.18

setAlignments

public Table setAlignments(Table.Alignment... alignments)

Sets the alignments for the table

Throws IllegalAlignmentCountException if the number of alignments does not match the number of headers

Parameters:

alignments - Column alignments in order

Returns:

This table

addRows

public Table addRows(Object[]... rows)

Adds rows of content to the table

Parameters:

rows - Arrays of cell contents for each row

Returns:

This table

Since:

0.0.18

asString

public String asString()

Formats the element to a string

Specified by:

asString in class MarkdownElement

Returns:

String representation of the formatted item

Since:

0.0.18