Package net.neoforged.neoforge.common.util

Class TextTable

java.lang.Object

net.neoforged.neoforge.common.util.TextTable

public class TextTable
extends Object

Utility to format data into a textual (markdown-compliant) table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextTable.Alignment
static class	TextTable.Column
static class	TextTable.Row

Field Summary

Fields

Modifier and Type	Field	Description
private final List<TextTable.Column>	columns
private final List<TextTable.Row>	rows

Constructor Summary

Constructors

Constructor	Description
TextTable(List<TextTable.Column> columns)

Method Summary

Modifier and Type	Method	Description
void	add(Object... values)
void	append(StringBuilder destination, String lineEnding)	Appends the data formatted as a table to the given string builder.
String	build(String lineEnding)
void	clear()
static TextTable.Column	column(String header)
static TextTable.Column	column(String header, TextTable.Alignment alignment)
List<TextTable.Column>	getColumns()
private void	printRow(StringBuilder destination, List<String> values)
private void	printSeparators(StringBuilder destination)

Methods inherited from class java.lang.Object

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

Field Details

columns

private final List<TextTable.Column> columns

rows

private final List<TextTable.Row> rows

Constructor Details

TextTable

public TextTable(List<TextTable.Column> columns)

Method Details

column

public static TextTable.Column column(String header)

column

public static TextTable.Column column(String header,
 TextTable.Alignment alignment)

build

public String build(String lineEnding)

append

public void append(StringBuilder destination,
 String lineEnding)

Appends the data formatted as a table to the given string builder. The padding character used for the column alignments is a single space (' '), the separate between column headers and values is a dash ('-'). Note that you *have* to specify a line ending, '\n' isn't used by default.

The generated table is compliant with the markdown file format.

Parameters:

destination - a string builder to append the table to

lineEnding - the line ending to use for each row of the table

printSeparators

private void printSeparators(StringBuilder destination)

printRow

private void printRow(StringBuilder destination,
 List<String> values)

add

public void add(Object... values)

clear

public void clear()

getColumns

public List<TextTable.Column> getColumns()