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

TextContentBuilderBase

abstract class TextContentBuilderBase<TContent>(source)

A base utility class for building and manipulating content based on the text. This class can be extended to support more types of text-based content, e.g. text with attachments or some metadata.

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.

Inheritors

MessageContentBuilder

TextContentBuilder

Constructors

TextContentBuilderBase

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: TextContentBuilderBase.Caret

Represents the current caret position in the text being built.

Functions

fun br()

Adds two consecutive newline characters to the text content.

build

abstract fun build(): TContent

Constructs and returns the content

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 TextContentBuilderBase<*>.numbered(startLineNumber: Int = 1, body: TextContentBuilderBase<*>.() -> Unit): TextContentBuilderBase<*>

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.