io.github.ddimitrov.nuggets

Enum TextTable.Box

java.lang.Object

java.lang.Enum<TextTable.Box>

io.github.ddimitrov.nuggets.TextTable.Box

All Implemented Interfaces:

TextTable.Style, Serializable, Comparable<TextTable.Box>

Enclosing class:

TextTable

public static enum TextTable.Box
extends Enum<TextTable.Box>
implements TextTable.Style

Preset styles, specifying the characters used to draw the lines and corners of a table. As of now, the whole table is drawn with the same set of characters (we don't allow to customize per row or per cell).

You don't need to use this class if you prefer to provide your own styles.

See Also:

TextTable.presetBox(Style)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCII Plain ASCII - suitable for every log file
ASCII_HORIZONTAL
ASCII_HORIZONTAL_DOUBLE
NO_BOX No decorations - good start if you want to customize
UNICODE_DOUBLE Because sometimes two is better than one
UNICODE_THICK Sturdy and solid, nothing stands out quite like UNICODE_THICK
UNICODE_THIN Stylish and slim, spruce your stdio with UNICODE_THIN
UNICODE_THIN_ROUNDED ...but how about drawing rectangles with rounded corners? Can we do that now, too?

Method Summary

Modifier and Type	Method and Description
@Nullable String	horizontal() Determines the characters used to draw the horizontal lines of a table.
@NotNull String[]	joints(int row) Determines the characters used to draw the joints and corners of a table.
static TextTable.Box	valueOf(String name) Returns the enum constant of this type with the specified name.
static TextTable.Box[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
@Nullable String	vertical() Determines the characters used to draw the vertical lines of a table.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_BOX

public static final TextTable.Box NO_BOX

No decorations - good start if you want to customize

ASCII_HORIZONTAL

public static final TextTable.Box ASCII_HORIZONTAL

ASCII_HORIZONTAL_DOUBLE

public static final TextTable.Box ASCII_HORIZONTAL_DOUBLE

ASCII

public static final TextTable.Box ASCII

Plain ASCII - suitable for every log file

UNICODE_THIN

public static final TextTable.Box UNICODE_THIN

Stylish and slim, spruce your stdio with UNICODE_THIN

UNICODE_THIN_ROUNDED

public static final TextTable.Box UNICODE_THIN_ROUNDED

...but how about drawing rectangles with rounded corners? Can we do that now, too?

UNICODE_THICK

public static final TextTable.Box UNICODE_THICK

Sturdy and solid, nothing stands out quite like UNICODE_THICK

UNICODE_DOUBLE

public static final TextTable.Box UNICODE_DOUBLE

Because sometimes two is better than one

Method Detail

values

public static TextTable.Box[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TextTable.Box c : TextTable.Box.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TextTable.Box valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

horizontal

@Contract(pure=true)
 @Nullable
public @Nullable String horizontal()

Description copied from interface: TextTable.Style

Determines the characters used to draw the horizontal lines of a table.

Specified by:

horizontal in interface TextTable.Style

Returns:

horizontal line string. If multiple characters, will be repeated and trimmed as required to reach the desired size. If null, horizontal separators will be skipped entirely.

See Also:

TextTable.style, TextTable.presetBox(Style)

vertical

@Contract(pure=true)
 @Nullable
public @Nullable String vertical()

Description copied from interface: TextTable.Style

Determines the characters used to draw the vertical lines of a table.

Specified by:

vertical in interface TextTable.Style

Returns:

vertical line string. If multiple characters, the column separators will be using the whole string (make sure to have matching T-joints and cross-joints). If null, vertical separators will be skipped entirely.

See Also:

TextTable.style, TextTable.presetBox(Style)

joints

@Contract(pure=true)
 @NotNull
public @NotNull String[] joints(int row)

Description copied from interface: TextTable.Style

Determines the characters used to draw the joints and corners of a table. The joints are defined as a virtual 3x3 array, with values as follows:

 String[][] joints = {
     { TOP_LEFT_CORNER    , TOP_T_JOINT    , TOP_RIGHT_CORNER    },
     { LEFT_T_JOINT       , CROSS_JOINT    , RIGHT_T_JOINT       },
     { BOTTOM_LEFT_CORNER , BOTTOM_T_JOINT , BOTTOM_RIGHT_CORNER },
 }
 

Specified by:

joints in interface TextTable.Style

Parameters:

row - which row of the 9-box to return.

Returns:

array of 3 strings to be used as left corner, center and right-corner for the specified row. See examples in TextTable.Box.

See Also:

TextTable.style, TextTable.presetBox(Style)