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

TextContentBuilder

open class TextContentBuilder : TextContentBuilderBase<String> (source)

A content builder class for building and manipulating purely textual content.

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val caret: TextContentBuilderBase.Caret

Represents the current caret position in the text being built.

Functions

Link copied to clipboard
fun br()

Adds two consecutive newline characters to the text content.

Link copied to clipboard
open override fun build(): String

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

Link copied to clipboard
fun newline()

Appends a newline character to the underlying text builder.

Link copied to clipboard
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.

Link copied to clipboard
fun TextContentBuilderBase<*>.numbered(startLineNumber: Int = 1, body: TextContentBuilderBase<*>.() -> Unit): TextContentBuilderBase<*>

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

Link copied to clipboard
fun padding(padding: String, body: TextContentBuilder.() -> Unit)

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

Link copied to clipboard
fun text(text: String)

Appends the given text to the current content.

Link copied to clipboard
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.

Link copied to clipboard
open operator fun String.unaryPlus()

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