net.steppschuh.markdowngenerator.table

Class Table

java.lang.Object

net.steppschuh.markdowngenerator.MarkdownElement

net.steppschuh.markdowngenerator.table.Table

All Implemented Interfaces:

MarkdownSerializable

public class Table
extends MarkdownElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Table.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_CENTER
static int	ALIGN_LEFT
static int	ALIGN_RIGHT
static int	DEFAULT_MINIMUM_COLUMN_WIDTH
static java.lang.String	DEFAULT_TRIMMING_INDICATOR
static java.lang.String	SEPARATOR
static java.lang.String	WHITESPACE

Constructor Summary

Constructors

Constructor and Description
Table()
Table(java.util.List<TableRow> rows)
Table(java.util.List<TableRow> rows, java.util.List<java.lang.Integer> alignments)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	generateHeaderSeparator(java.util.Map<java.lang.Integer,java.lang.Integer> columnWidths, java.util.List<java.lang.Integer> alignments)
static int	getAlignment(java.util.List<java.lang.Integer> alignments, int columnIndex)
java.util.List<java.lang.Integer>	getAlignments()
static java.util.Map<java.lang.Integer,java.lang.Integer>	getColumnWidths(java.util.List<TableRow> rows, int minimumColumnWidth)
static int	getMaximumItemLength(java.util.List<TableRow> rows, int columnIndex, int minimumColumnWidth)
int	getMinimumColumnWidth()
java.util.List<TableRow>	getRows()
java.lang.String	getTrimmingIndicator()
boolean	isFirstRowHeader()
java.lang.String	serialize() Attempts to generate a String representing this markdown element.
void	setAlignments(java.util.List<java.lang.Integer> alignments)
void	setMinimumColumnWidth(int minimumColumnWidth)
void	setRows(java.util.List<TableRow> rows)
void	setTrimmingIndicator(java.lang.String trimmingIndicator)
Table	trim(int rowsToKeep) Removes TableRows from the center of this table until only the requested amount of rows is left.
static Table	trim(Table table, int rowsToKeep, java.lang.String trimmingIndicator) Removes TableRows from the center of the specified table until only the requested amount of rows is left.
void	useFirstRowAsHeader(boolean firstRowIsHeader)

Methods inherited from class net.steppschuh.markdowngenerator.MarkdownElement

getSerialized, getSerialized, invalidateSerialized, setSerialized, toMarkdownElement, toString

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

WHITESPACE

public static final java.lang.String WHITESPACE

See Also:

Constant Field Values

DEFAULT_TRIMMING_INDICATOR

public static final java.lang.String DEFAULT_TRIMMING_INDICATOR

See Also:

Constant Field Values

DEFAULT_MINIMUM_COLUMN_WIDTH

public static final int DEFAULT_MINIMUM_COLUMN_WIDTH

See Also:

Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_LEFT

public static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

See Also:

Constant Field Values

Constructor Detail

Table

public Table()

Table

public Table(java.util.List<TableRow> rows)

Table

public Table(java.util.List<TableRow> rows,
             java.util.List<java.lang.Integer> alignments)

Method Detail

serialize

public java.lang.String serialize()

Description copied from class: MarkdownElement

Attempts to generate a String representing this markdown element.

Specified by:

serialize in class MarkdownElement

Returns:

Markdown as String

trim

public Table trim(int rowsToKeep)

Removes TableRows from the center of this table until only the requested amount of rows is left.

Parameters:

rowsToKeep - Amount of TableRows that should not be removed

Returns:

the trimmed table

trim

public static Table trim(Table table,
                         int rowsToKeep,
                         java.lang.String trimmingIndicator)

Removes TableRows from the center of the specified table until only the requested amount of rows is left.

Parameters:

table - Table to remove TableRows from

rowsToKeep - Amount of TableRows that should not be removed

trimmingIndicator - The content that trimmed cells should be filled with

Returns:

The trimmed table

generateHeaderSeparator

public static java.lang.String generateHeaderSeparator(java.util.Map<java.lang.Integer,java.lang.Integer> columnWidths,
                                                       java.util.List<java.lang.Integer> alignments)

getColumnWidths

public static java.util.Map<java.lang.Integer,java.lang.Integer> getColumnWidths(java.util.List<TableRow> rows,
                                                                                 int minimumColumnWidth)

getMaximumItemLength

public static int getMaximumItemLength(java.util.List<TableRow> rows,
                                       int columnIndex,
                                       int minimumColumnWidth)

getAlignment

public static int getAlignment(java.util.List<java.lang.Integer> alignments,
                               int columnIndex)

getRows

public java.util.List<TableRow> getRows()

setRows

public void setRows(java.util.List<TableRow> rows)

getAlignments

public java.util.List<java.lang.Integer> getAlignments()

setAlignments

public void setAlignments(java.util.List<java.lang.Integer> alignments)

isFirstRowHeader

public boolean isFirstRowHeader()

useFirstRowAsHeader

public void useFirstRowAsHeader(boolean firstRowIsHeader)

getMinimumColumnWidth

public int getMinimumColumnWidth()

setMinimumColumnWidth

public void setMinimumColumnWidth(int minimumColumnWidth)

getTrimmingIndicator

public java.lang.String getTrimmingIndicator()

setTrimmingIndicator

public void setTrimmingIndicator(java.lang.String trimmingIndicator)