de.vandermeer.asciithemes

Interface TA_Border

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt

All Known Subinterfaces:

TA_Border_Chars, TA_Border_Strings

public interface TA_Border
extends IsTextArt

Left and right border pair.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_LEFT Mode for processing the left border.
static int	MODE_RIGHT Mode for processing the right border.

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
default StrBuilder	getBorder(int mode) Returns the border.
StrBuilder	getBorder(int mode, StrBuilder builder) Returns the border.
default String	getBorderAsString(int mode) Returns the border.
default String	getBorderAsString(int mode, StrBuilder builder) Returns the border.

Methods inherited from interface HasDescription

getDescription

Methods inherited from interface HasToDoc

toDoc

Field Detail

MODE_LEFT

static final int MODE_LEFT

Mode for processing the left border.

See Also:

Constant Field Values

MODE_RIGHT

static final int MODE_RIGHT

Mode for processing the right border.

See Also:

Constant Field Values

Method Detail

getBorder

default StrBuilder getBorder(int mode)

Returns the border.

Parameters:

mode - the mode for processing a corner (use one of MODE_LEFT, MODE_RIGHT)

Returns:

border

getBorder

StrBuilder getBorder(int mode,
                     StrBuilder builder)

Returns the border.

Parameters:

mode - the mode for processing a corner (use one of MODE_LEFT, MODE_RIGHT)

builder - builder to append the border to, new builder will be created if null

Returns:

border

getBorderAsString

default String getBorderAsString(int mode)

Returns the border.

Parameters:

mode - the mode for processing a corner (use one of MODE_LEFT, MODE_RIGHT)

Returns:

border

getBorderAsString

default String getBorderAsString(int mode,
                                 StrBuilder builder)

Returns the border.

Parameters:

mode - the mode for processing a corner (use one of MODE_LEFT, MODE_RIGHT)

builder - builder to append the border to, new builder will be created if null

Returns:

border