Class ColumnFormatter

java.lang.Object

eu.cloudnetservice.utils.base.column.ColumnFormatter

public final class ColumnFormatter
extends Object

A formatter that is highly customizable to build tables from columns.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ColumnFormatter.Builder	A builder for a column formatter.

Field Summary

Fields

Modifier and Type	Field	Description
private final char	columnLeftBracket
private final char	columnRightBracket
private final String[]	columnTitles
private static final String	ENTRY_FORMAT
private Collection<String>	formattedColumnTitles
private final char	headerValuesSpacerChar
private final String	leftSpacer
private final String	rightSpacer

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ColumnFormatter(@NonNull String leftSpacer, @NonNull String rightSpacer, char columnLeftBracket, char columnRightBracket, char headerValuesSpacerChar, @NonNull String[] columnTitles)	Constructs a new column formatter instance.

Method Summary

Modifier and Type	Method	Description
static @NonNull ColumnFormatter.Builder	builder()	Constructs a new builder for a colum formatter.
@NonNull Collection<String>	formatLines(@NonNull ColumnEntry... entries)	Formats the given column entries into a table based on the formatter configuration.

Methods inherited from class Object

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

Field Details

ENTRY_FORMAT

private static final String ENTRY_FORMAT

See Also:

• Constant Field Values

leftSpacer

private final String leftSpacer

rightSpacer

private final String rightSpacer

columnLeftBracket

private final char columnLeftBracket

columnRightBracket

private final char columnRightBracket

headerValuesSpacerChar

private final char headerValuesSpacerChar

columnTitles

private final String[] columnTitles

formattedColumnTitles

private volatile Collection<String> formattedColumnTitles

Constructor Details

ColumnFormatter

private ColumnFormatter(@NonNull
 @NonNull String leftSpacer,
 @NonNull
 @NonNull String rightSpacer,
 char columnLeftBracket,
 char columnRightBracket,
 char headerValuesSpacerChar,
 @NonNull
 @NonNull String[] columnTitles)

Constructs a new column formatter instance.

Parameters:

leftSpacer - the spacer to put after the left bracket.

rightSpacer - the right spacer to put after the column text.

columnLeftBracket - the bracket to put as the first char of a column.

columnRightBracket - the bracket to put as the last char of a column.

headerValuesSpacerChar - the char to use in the spacer line between the header and rows.

columnTitles - the display name of all column titles, in order.

Throws:

NullPointerException - if one of the given arguments is null.

Method Details

builder

@NonNull
public static @NonNull ColumnFormatter.Builder builder()

Constructs a new builder for a colum formatter.

Returns:

a new column formatter builder.

formatLines

@NonNull
public @NonNull Collection<String> formatLines(@NonNull
 @NonNull ColumnEntry... entries)

Formats the given column entries into a table based on the formatter configuration. The returned collection is ordered and can contain duplicates (this depends on the given input and how the input is converted).

Parameters:

entries - the entries to format.

Returns:

the given entries, formatted as a table, line by line.

Throws:

NullPointerException - if the given entries are null.