de.vandermeer.asciithemes

Interface TA_Border_Strings

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt, TA_Border

public interface TA_Border_Strings
extends TA_Border

Left and right border pair using strings with ASCII and/or UTF characters.

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 inherited from interface TA_Border

MODE_LEFT, MODE_RIGHT

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
static TA_Border_Strings	create(String left, String right, String description) Creates a new border pair.
default StrBuilder	getBorder(int mode, StrBuilder builder) Returns the border.
String	getLeftString() Returns the string for the left border.
String	getRightString() Returns the string for the right border.
default StrBuilder	toDoc()

Methods inherited from interface TA_Border

getBorder, getBorderAsString, getBorderAsString

Methods inherited from interface HasDescription

getDescription

Method Detail

getLeftString

String getLeftString()

Returns the string for the left border.

Returns:

left border string

getRightString

String getRightString()

Returns the string for the right border.

Returns:

right border string

getBorder

default StrBuilder getBorder(int mode,
                             StrBuilder builder)

Description copied from interface: TA_Border

Returns the border.

Specified by:

getBorder in interface TA_Border

Parameters:

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

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

Returns:

border

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc

create

static TA_Border_Strings create(String left,
                                String right,
                                String description)

Creates a new border pair.

Parameters:

left - border left string

right - border right string

description - a description for the line, cannot be blank

Returns:

new border pair