Kotools Types/kotools.types.string

Package-level declarations

Contains types such as NotBlankString for manipulating text.

Types

NotBlankString

@Serializable(with = NotBlankStringSerializer::class)

interface ~~NotBlankString~~ : Comparable<NotBlankString>

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

Functions

compareTo

infix operator fun String.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.

getOrNull

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.

NotBlankString

fun ~~NotBlankString~~(value: String): NotBlankString

Returns the value as a NotBlankString, or throws an NotBlankString.ConstructionError if the value is blank.

NotBlankStringOrNull

fun notBlankStringOrNull(value: String): NotBlankString?

Returns the value as a NotBlankString, or returns null if the value is blank.

notBlankStringOrThrow

fun notBlankStringOrThrow(value: String): NotBlankString

Returns the value as a NotBlankString, or throws an IllegalArgumentException if the value is blank.

toNotBlankString

fun String.~~toNotBlankString~~(): NotBlankString

Returns this value as a NotBlankString, or throws an NotBlankString.ConstructionError if this value is blank.

toNotBlankStringOrNull

fun String.toNotBlankStringOrNull(): NotBlankString?

Returns this value as a NotBlankString, or returns null if this value is blank.

toNotBlankStringOrThrow

fun String.toNotBlankStringOrThrow(): NotBlankString

Returns this value as a NotBlankString, or throws an IllegalArgumentException if this value is blank.