Kotools Types/kotools.types.string/NotBlankString

NotBlankString

@JvmInline

@SinceKotoolsTypes(version = "1.2")

value class NotBlankString constructor(val value: String) : Comparable<NotBlankString>

Represents strings containing at least 1 character, excluding whitespaces.

Constructors

NotBlankString

fun NotBlankString(value: String)

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

Types

Companion

object Companion

Functions

compareTo

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

Compares this value lexicographically with the other value for order. Returns 0 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

infix operator fun get(index: PositiveInt): Char

Returns the character of this value at the specified index, or throws an IndexOutOfBoundsException if the index is out of bounds.

getOrNull

infix fun getOrNull(index: PositiveInt): Char?

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

plus

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

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

toString

open override fun toString(): String

Properties

first

val first: Char

Returns the first character of this value.

length

val length: StrictlyPositiveInt

Returns the length of this value.

value

val value: String