prompt-model/ai.koog.prompt.text/TextContentBuilder

TextContentBuilder

A utility class for building and manipulating textual content.

Provides methods for constructing formatted strings with features such as inserting text, adding new lines, and applying padding. The builder pattern supports a fluent and convenient approach to managing text content.

Constructors

TextContentBuilder

constructor()

Types

Caret

data class Caret(val line: Int, val offset: Int)

Represents the position of a caret within a text document.

Properties

caret

val caret: TextContentBuilder.Caret

Represents the current caret position in the text being built.

Functions

fun br()

Adds two consecutive newline characters to the text content.

build

fun build(): String

Constructs and returns the accumulated textual content stored in the builder.

newline

fun newline()

Appends a newline character to the underlying text builder.

not

operator fun String.not()

Defines a custom operator function for the String class. This unary not operator (!) is invoked on a String instance and performs a custom action defined by the text function.

numbered

fun TextContentBuilder.numbered(startLineNumber: Int = 1, body: TextContentBuilder.() -> Unit): TextContentBuilder

Extension function for TextContentBuilder that adds line numbering to the content.

padding

fun padding(padding: String, body: TextContentBuilder.() -> Unit)

Adds padding to each line of the content produced by the provided builder block.

text

fun text(text: String)

Appends the given text to the current content.

textWithNewLine

fun textWithNewLine(text: String)

Adds the given text to the content. If the caret is not at the beginning of the line, a newline is added before appending the text.

unaryPlus

open operator fun String.unaryPlus()

Adds the given string as a new line of text to the content being built by the TextContentBuilder.