Compukters Core/kotlin/String

String

class String : Comparable<String> , CharSequence(source)

Constructors

String

constructor()

constructor(chars: CharArray)

constructor(chars: CharArray, offset: Int, length: Int)

Properties

length

open external override val length: Int

Functions

compareTo

open operator external override fun compareTo(other: String): Int

contains

fun CharSequence.contains(char: Char): Boolean

Returns whether this string contains char.

fun CharSequence.contains(other: CharSequence): Boolean

drop

fun CharSequence.drop(n: Int): CharSequence

fun String.drop(n: Int): String

dropLast

fun CharSequence.dropLast(n: Int): CharSequence

fun String.dropLast(n: Int): String

endsWith

fun CharSequence.endsWith(suffix: CharSequence): Boolean

get

open operator external override fun get(index: Int): Char

indexOf

fun CharSequence.indexOf(char: Char, startIndex: Int = 0): Int

Finds the first matching character at or after startIndex, clamped to zero.

fun CharSequence.indexOf(other: String, startIndex: Int = 0): Int

isBlank

fun CharSequence.isBlank(): Boolean

Returns whether this character sequence is empty or contains only whitespace.

isEmpty

fun CharSequence.isEmpty(): Boolean

Returns whether this character sequence contains no characters.

isNotBlank

fun CharSequence.isNotBlank(): Boolean

Returns whether this character sequence contains a non-whitespace character.

isNotEmpty

fun CharSequence.isNotEmpty(): Boolean

Returns whether this character sequence contains at least one character.

iterator

operator fun CharSequence.iterator(): CharIterator

Visits UTF-16 code units in order. Stored iterators are supported and own their position.

lastIndexOf

fun CharSequence.lastIndexOf(char: Char): Int

Finds the last matching character.

fun CharSequence.lastIndexOf(string: String): Int

Finds the last matching substring, starting at the last character.

fun CharSequence.lastIndexOf(char: Char, startIndex: Int): Int

Searches backwards from startIndex for char.

fun CharSequence.lastIndexOf(string: String, startIndex: Int): Int

Searches backwards from startIndex for string, comparing UTF-16 code units.

lines

fun CharSequence.lines(): List<String>

Splits on CRLF, LF or CR, retaining empty lines including the final line.

padEnd

fun CharSequence.padEnd(length: Int): CharSequence

fun String.padEnd(length: Int): String

fun CharSequence.padEnd(length: Int, padChar: Char): CharSequence

fun String.padEnd(length: Int, padChar: Char): String

padStart

fun CharSequence.padStart(length: Int): CharSequence

fun String.padStart(length: Int): String

fun CharSequence.padStart(length: Int, padChar: Char): CharSequence

fun String.padStart(length: Int, padChar: Char): String

plus

operator external fun plus(other: Any?): String

removePrefix

fun CharSequence.removePrefix(prefix: CharSequence): CharSequence

fun String.removePrefix(prefix: CharSequence): String

Removes prefix when present, otherwise returns this string.

removeSuffix

fun CharSequence.removeSuffix(suffix: CharSequence): CharSequence

fun String.removeSuffix(suffix: CharSequence): String

Removes suffix when present, otherwise returns this string.

repeat

fun CharSequence.repeat(n: Int): String

replace

fun String.replace(oldChar: Char, newChar: Char): String

Replaces every oldChar with newChar, comparing case-sensitively.

fun String.replace(oldValue: String, newValue: String): String

Replaces nonoverlapping oldValue matches. An empty oldValue inserts newValue at every UTF-16 boundary.

split

fun CharSequence.split(delimiter: Char, limit: Int = 0): List<String>

Splits on delimiter, retaining empty parts. Zero limit means no limit; positive limit keeps the remaining suffix.

fun CharSequence.split(delimiter: String, limit: Int = 0): List<String>

Splits on delimiter, retaining empty parts. An empty delimiter separates UTF-16 code units, including empty ends.

startsWith

fun CharSequence.startsWith(prefix: CharSequence): Boolean

subSequence

open external override fun subSequence(startIndex: Int, endIndex: Int): String

substring

fun CharSequence.substring(startIndex: Int): String

fun CharSequence.substring(startIndex: Int, endIndex: Int): String

Materializes the selected UTF-16 range as an immutable String.

substringAfter

fun String.substringAfter(delimiter: Char): String

fun String.substringAfter(delimiter: String): String

Returns the part after the first delimiter, or this string if absent.

fun String.substringAfter(delimiter: Char, missingDelimiterValue: String): String

fun String.substringAfter(delimiter: String, missingDelimiterValue: String): String

Returns the part after the first delimiter, or missingDelimiterValue if absent.

substringAfterLast

fun String.substringAfterLast(delimiter: Char): String

fun String.substringAfterLast(delimiter: String): String

Returns the part after the last delimiter, or this string if absent.

fun String.substringAfterLast(delimiter: Char, missingDelimiterValue: String): String

fun String.substringAfterLast(delimiter: String, missingDelimiterValue: String): String

Returns the part after the last delimiter, or missingDelimiterValue if absent.

substringBefore

fun String.substringBefore(delimiter: Char): String

fun String.substringBefore(delimiter: String): String

Returns the part before the first delimiter, or this string if absent.

fun String.substringBefore(delimiter: Char, missingDelimiterValue: String): String

fun String.substringBefore(delimiter: String, missingDelimiterValue: String): String

Returns the part before the first delimiter, or missingDelimiterValue if absent.

substringBeforeLast

fun String.substringBeforeLast(delimiter: Char): String

fun String.substringBeforeLast(delimiter: String): String

Returns the part before the last delimiter, or this string if absent.

fun String.substringBeforeLast(delimiter: Char, missingDelimiterValue: String): String

fun String.substringBeforeLast(delimiter: String, missingDelimiterValue: String): String

Returns the part before the last delimiter, or missingDelimiterValue if absent.

take

fun CharSequence.take(n: Int): CharSequence

fun String.take(n: Int): String

Counts and indexes refer to UTF-16 code units, including individual surrogate halves.

takeLast

fun CharSequence.takeLast(n: Int): CharSequence

fun String.takeLast(n: Int): String

toByte

fun String.toByte(): Byte

fun String.toByte(radix: Int): Byte

toByteOrNull

fun String.toByteOrNull(): Byte?

fun String.toByteOrNull(radix: Int): Byte?

toInt

fun String.toInt(): Int

fun String.toInt(radix: Int): Int

toIntOrNull

fun String.toIntOrNull(): Int?

fun String.toIntOrNull(radix: Int): Int?

toLong

fun String.toLong(): Long

fun String.toLong(radix: Int): Long

toLongOrNull

fun String.toLongOrNull(): Long?

fun String.toLongOrNull(radix: Int): Long?

toPath

fun String.toPath(): Path

Converts an absolute path string to a lexical value without accessing storage.

toShort

fun String.toShort(): Short

fun String.toShort(radix: Int): Short

toShortOrNull

fun String.toShortOrNull(): Short?

fun String.toShortOrNull(radix: Int): Short?

toUByte

fun String.toUByte(): UByte

fun String.toUByte(radix: Int): UByte

toUByteOrNull

fun String.toUByteOrNull(): UByte?

fun String.toUByteOrNull(radix: Int): UByte?

toUInt

fun String.toUInt(): UInt

fun String.toUInt(radix: Int): UInt

toUIntOrNull

fun String.toUIntOrNull(): UInt?

fun String.toUIntOrNull(radix: Int): UInt?

toULong

fun String.toULong(): ULong

fun String.toULong(radix: Int): ULong

toULongOrNull

fun String.toULongOrNull(): ULong?

fun String.toULongOrNull(radix: Int): ULong?

toUShort

fun String.toUShort(): UShort

fun String.toUShort(radix: Int): UShort

toUShortOrNull

fun String.toUShortOrNull(): UShort?

fun String.toUShortOrNull(radix: Int): UShort?

trim

fun CharSequence.trim(): CharSequence

fun String.trim(): String

Removes leading and trailing whitespace.

trimEnd

fun CharSequence.trimEnd(): CharSequence

fun String.trimEnd(): String

Removes trailing whitespace.

trimStart

fun CharSequence.trimStart(): CharSequence

fun String.trimStart(): String

Removes leading whitespace.