NotBlankString

@SinceKotools(project = Project.Types, version = "1.2")

~~interface~~ ~~NotBlankString~~ : ~~Comparable~~<NotBlankString>

Representation of strings that have at least one character, excluding whitespaces.

Types

Companion

common

object Companion

Contains declarations for holding or building a PositiveInt.

ConstructionError

common

@SinceKotools(project = Project.Types, version = "3.0")

~~class~~ ~~ConstructionError~~ : ~~IllegalArgumentException~~

Error thrown when creating a NotBlankString fails.

Functions

compareTo

common

@SinceKotools(project = Project.Types, version = "2.0")

open operator fun compareTo(other: String): Int

open operator override fun compareTo(other: NotBlankString): Int

Compares this value lexicographically with the other value for order. Returns zero if this value equals the other value, a negative number if this value is less than the other value, or a positive number if this value is greater than the other value.

get

common

open operator fun get(index: PositiveInt): Char

Returns the character of this value at the specified index. Throws an IndexOutOfBoundsException if the index is out of bounds, except in Kotlin/JS where the behavior is unspecified.

plus

common

open operator fun plus(other: Any?): NotBlankString

Returns the concatenation of this value with the string representation of the other object.

Properties

first

common

open val first: Char

Returns the first character of this value.

length

common

open val length: StrictlyPositiveInt

Returns the length of this value.

value

common

abstract val value: String

The value to hold.

Extensions

getOrNull

jvm

infix fun NotBlankString.getOrNull(index: PositiveInt): Char?

Returns the character of this value at the specified index, or returns null if the index is out of bounds.

native

infix fun NotBlankString.getOrNull(index: PositiveInt): Char?

Returns the character of this value at the specified index, or returns null if the index is out of bounds.