BunyipsLib/org.murraybridgebunyips.bunyipslib/Text

Text

class Text

Text and string manipulation utilities.

Author

Lucas Bubner, 2023

Since

1.0.0-pre

Types

Builder

open class Builder : CharSequence

A modified wrapper of StringBuilder that internally calls formatString on all append calls.

HtmlBuilder

open class HtmlBuilder

Allows for the building of HTML strings, similar to the DualTelemetry HtmlItem for Driver Station telemetry.

Functions

builder

open fun builder(): Text.Builder

open fun builder(capacity: Int): Text.Builder

open fun builder(initial: String): Text.Builder

Return a wrapper of StringBuilder that internally calls formatString on all append calls.

format

open fun format(@NonNull fstring: String, @Nullable objs: Array<Any>): String

open fun format(@NonNull fstring: String, @Nullable objs: List<Any>): String

Format a string using only '%' placeholders.

formatString

open fun formatString(@NonNull fstring: String, @Nullable objs: Array<Any>): String

open fun formatString(@NonNull fstring: String, @Nullable objs: List<Any>): String

Format a string using only '%' placeholders.

getCallingUserCodeFunction

open fun getCallingUserCodeFunction(): StackTraceElement

Get the calling user code function of the current context by looking at the stacktrace until it leaves BunyipsLib.

html

open fun html(): Text.HtmlBuilder

Begin building an HTML string.

lower

open fun lower(str: String): String

Lowercase a string.

removeHtml

open fun removeHtml(htmlString: String): String

Removes HTML from a string.

round

open fun round(@Nullable num: Double, thDigits: Int): Double

open fun round(@Nullable num: Float, thDigits: Int): Float

open fun round(@Nullable num: Double, thDigits: Int, sigFigs: Int): Double

open fun round(@Nullable num: Float, thDigits: Int, sigFigs: Int): Float

Round a number to a certain number of decimal points.

upper

open fun upper(str: String): String

Uppercase a string.