String
class String : Comparable<String>, CharSequenceThe String class represents character strings. All string literals in Kotlin programs, such as "abc", are
implemented as instances of this class.
Constructors
<init>
The String class represents character strings. All string literals in Kotlin programs, such as "abc", are
implemented as instances of this class.
<init>()Properties
length
Returns the length of this character sequence.
val length: IntFunctions
equals
Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:
fun equals(other: Any?): BooleanhashCode
Returns a hash code value for the object. The general contract of hashCode is:
fun hashCode(): Intplus
Returns a string obtained by concatenating this string with the string representation of the given other object.
operator fun plus(other: Any?): StringsubSequence
Returns a new character sequence that is a subsequence of this character sequence, starting at the specified startIndex and ending right before the specified endIndex.
fun subSequence(startIndex: Int, endIndex: Int): CharSequencetoString
Returns a string representation of the object.
fun toString(): StringExtension Properties
indices
Returns the range of valid character indices for this char sequence.
val CharSequence.indices: IntRangelastIndex
Returns the index of the last character in the char sequence or -1 if it is empty.
val CharSequence.lastIndex: IntExtension Functions
all
Returns true if all characters match the given predicate.
fun CharSequence.all(predicate: (Char) -> Boolean): Booleanany
Returns true if char sequence has at least one character.
fun CharSequence.any(): BooleanReturns true if at least one character matches the given predicate.
fun CharSequence.any(predicate: (Char) -> Boolean): BooleanasIterable
Creates an Iterable instance that wraps the original char sequence returning its characters when being iterated.
fun CharSequence.asIterable(): Iterable<Char>asSequence
Creates a Sequence instance that wraps the original char sequence returning its characters when being iterated.
fun CharSequence.asSequence(): Sequence<Char>associate
Returns a Map containing key-value pairs provided by transform function applied to characters of the given char sequence.
fun <K, V> CharSequence.associate(
transform: (Char) -> Pair<K, V>
): Map<K, V>associateBy
Returns a Map containing the characters from the given char sequence indexed by the key returned from keySelector function applied to each character.
fun <K> CharSequence.associateBy(
keySelector: (Char) -> K
): Map<K, Char>Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to characters of the given char sequence.
fun <K, V> CharSequence.associateBy(
keySelector: (Char) -> K,
valueTransform: (Char) -> V
): Map<K, V>associateByTo
Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each character of the given char sequence and value is the character itself.
fun <K, M : MutableMap<in K, in Char>> CharSequence.associateByTo(
destination: M,
keySelector: (Char) -> K
): MPopulates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to characters of the given char sequence.
fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateByTo(
destination: M,
keySelector: (Char) -> K,
valueTransform: (Char) -> V
): MassociateTo
Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each character of the given char sequence.
fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateTo(
destination: M,
transform: (Char) -> Pair<K, V>
): MassociateWith
Returns a Map where keys are characters from the given char sequence and values are produced by the valueSelector function applied to each character.
fun <V> CharSequence.associateWith(
valueSelector: (Char) -> V
): Map<Char, V>associateWithTo
Populates and returns the destination mutable map with key-value pairs for each character of the given char sequence, where key is the character itself and value is provided by the valueSelector function applied to that key.
fun <V, M : MutableMap<in Char, in V>> CharSequence.associateWithTo(
destination: M,
valueSelector: (Char) -> V
): MbyteInputStream
Creates a new byte input stream for the string.
fun String.byteInputStream(
charset: Charset = Charsets.UTF_8
): ByteArrayInputStreamcapitalize
Returns a copy of this string having its first letter titlecased preferring Char.toTitleCase (if different from Char.toUpperCase) or by String.toUpperCase using the specified locale, or the original string, if it's empty or already starts with an upper case letter.
fun String.capitalize(locale: Locale): Stringchunked
Splits this char sequence into a list of strings each not exceeding the given size.
fun CharSequence.chunked(size: Int): List<String>Splits this char sequence into several char sequences each not exceeding the given size and applies the given transform function to an each.
fun <R> CharSequence.chunked(
size: Int,
transform: (CharSequence) -> R
): List<R>chunkedSequence
Splits this char sequence into a sequence of strings each not exceeding the given size.
fun CharSequence.chunkedSequence(size: Int): Sequence<String>Splits this char sequence into several char sequences each not exceeding the given size and applies the given transform function to an each.
fun <R> CharSequence.chunkedSequence(
size: Int,
transform: (CharSequence) -> R
): Sequence<R>codePointAt
Returns the character (Unicode code point) at the specified index.
fun String.codePointAt(index: Int): IntcodePointBefore
Returns the character (Unicode code point) before the specified index.
fun String.codePointBefore(index: Int): IntcodePointCount
Returns the number of Unicode code points in the specified text range of this String.
fun String.codePointCount(
beginIndex: Int,
endIndex: Int
): IntcoerceAtLeast
Ensures that this value is not less than the specified minimumValue.
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): TcoerceAtMost
Ensures that this value is not greater than the specified maximumValue.
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): TcoerceIn
Ensures that this value lies in the specified range minimumValue..maximumValue.
fun <T : Comparable<T>> T.coerceIn(
minimumValue: T?,
maximumValue: T?
): TEnsures that this value lies in the specified range.
fun <T : Comparable<T>> T.coerceIn(
range: ClosedFloatingPointRange<T>
): Tfun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): TcommonPrefixWith
Returns the longest string prefix such that this char sequence and other char sequence both start with this prefix,
taking care not to split surrogate pairs.
If this and other have no common prefix, returns the empty string.
fun CharSequence.commonPrefixWith(
other: CharSequence,
ignoreCase: Boolean = false
): StringcommonSuffixWith
Returns the longest string suffix such that this char sequence and other char sequence both end with this suffix,
taking care not to split surrogate pairs.
If this and other have no common suffix, returns the empty string.
fun CharSequence.commonSuffixWith(
other: CharSequence,
ignoreCase: Boolean = false
): Stringconcat
fun String.concat(str: String): Stringcontains
Returns true if this char sequence contains the specified other sequence of characters as a substring.
operator fun CharSequence.contains(
other: CharSequence,
ignoreCase: Boolean = false
): BooleanReturns true if this char sequence contains the specified character char.
operator fun CharSequence.contains(
char: Char,
ignoreCase: Boolean = false
): BooleanReturns true if this char sequence contains at least one match of the specified regular expression regex.
operator fun CharSequence.contains(regex: Regex): BooleancontentEquals
Returns true if this string is equal to the contents of the specified CharSequence, false otherwise.
fun String.contentEquals(charSequence: CharSequence): BooleanReturns true if this string is equal to the contents of the specified StringBuffer, false otherwise.
fun String.contentEquals(
stringBuilder: StringBuffer
): Booleancount
Returns the length of this char sequence.
fun CharSequence.count(): IntReturns the number of characters matching the given predicate.
fun CharSequence.count(predicate: (Char) -> Boolean): IntdropLastWhile
Returns a string containing all characters except last characters that satisfy the given predicate.
fun String.dropLastWhile(
predicate: (Char) -> Boolean
): StringdropWhile
Returns a string containing all characters except first characters that satisfy the given predicate.
fun String.dropWhile(predicate: (Char) -> Boolean): StringelementAtOrElse
Returns a character at the given index or the result of calling the defaultValue function if the index is out of bounds of this char sequence.
fun CharSequence.elementAtOrElse(
index: Int,
defaultValue: (Int) -> Char
): CharelementAtOrNull
Returns a character at the given index or null if the index is out of bounds of this char sequence.
fun CharSequence.elementAtOrNull(index: Int): Char?endsWith
Returns true if this char sequence ends with the specified character.
fun CharSequence.endsWith(
char: Char,
ignoreCase: Boolean = false
): BooleanReturns true if this char sequence ends with the specified suffix.
fun CharSequence.endsWith(
suffix: CharSequence,
ignoreCase: Boolean = false
): Booleanfilter
Returns a string containing only those characters from the original string that match the given predicate.
fun String.filter(predicate: (Char) -> Boolean): StringfilterIndexed
Returns a string containing only those characters from the original string that match the given predicate.
fun String.filterIndexed(
predicate: (index: Int, Char) -> Boolean
): StringfilterIndexedTo
Appends all characters matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterIndexedTo(
destination: C,
predicate: (index: Int, Char) -> Boolean
): CfilterNot
Returns a string containing only those characters from the original string that do not match the given predicate.
fun String.filterNot(predicate: (Char) -> Boolean): StringfilterNotTo
Appends all characters not matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterNotTo(
destination: C,
predicate: (Char) -> Boolean
): CfilterTo
Appends all characters matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterTo(
destination: C,
predicate: (Char) -> Boolean
): Cfind
Returns the first character matching the given predicate, or null if no such character was found.
fun CharSequence.find(predicate: (Char) -> Boolean): Char?findAnyOf
Finds the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.findAnyOf(
strings: Collection<String>,
startIndex: Int = 0,
ignoreCase: Boolean = false
): Pair<Int, String>?findLast
Returns the last character matching the given predicate, or null if no such character was found.
fun CharSequence.findLast(
predicate: (Char) -> Boolean
): Char?findLastAnyOf
Finds the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.findLastAnyOf(
strings: Collection<String>,
startIndex: Int = lastIndex,
ignoreCase: Boolean = false
): Pair<Int, String>?first
Returns first character.
fun CharSequence.first(): CharReturns the first character matching the given predicate.
fun CharSequence.first(predicate: (Char) -> Boolean): CharfirstOrNull
Returns the first character, or null if the char sequence is empty.
fun CharSequence.firstOrNull(): Char?Returns the first character matching the given predicate, or null if character was not found.
fun CharSequence.firstOrNull(
predicate: (Char) -> Boolean
): Char?flatMap
Returns a single list of all elements yielded from results of transform function being invoked on each character of original char sequence.
fun <R> CharSequence.flatMap(
transform: (Char) -> Iterable<R>
): List<R>flatMapTo
Appends all elements yielded from results of transform function being invoked on each character of original char sequence, to the given destination.
fun <R, C : MutableCollection<in R>> CharSequence.flatMapTo(
destination: C,
transform: (Char) -> Iterable<R>
): Cfold
Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each character.
fun <R> CharSequence.fold(
initial: R,
operation: (acc: R, Char) -> R
): RfoldIndexed
Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each character with its index in the original char sequence.
fun <R> CharSequence.foldIndexed(
initial: R,
operation: (index: Int, acc: R, Char) -> R
): RfoldRight
Accumulates value starting with initial value and applying operation from right to left to each character and current accumulator value.
fun <R> CharSequence.foldRight(
initial: R,
operation: (Char, acc: R) -> R
): RfoldRightIndexed
Accumulates value starting with initial value and applying operation from right to left to each character with its index in the original char sequence and current accumulator value.
fun <R> CharSequence.foldRightIndexed(
initial: R,
operation: (index: Int, Char, acc: R) -> R
): RforEach
Performs the given action on each character.
fun CharSequence.forEach(action: (Char) -> Unit)forEachIndexed
Performs the given action on each character, providing sequential index with the character.
fun CharSequence.forEachIndexed(
action: (index: Int, Char) -> Unit)format
Uses this string as a format string and returns a string obtained by substituting the specified arguments, using the default locale.
fun String.format(vararg args: Any?): StringUses this string as a format string and returns a string obtained by substituting the specified arguments, using the specified locale.
fun String.format(locale: Locale, vararg args: Any?): StringgetOrElse
Returns a character at the given index or the result of calling the defaultValue function if the index is out of bounds of this char sequence.
fun CharSequence.getOrElse(
index: Int,
defaultValue: (Int) -> Char
): ChargetOrNull
Returns a character at the given index or null if the index is out of bounds of this char sequence.
fun CharSequence.getOrNull(index: Int): Char?groupBy
Groups characters of the original char sequence by the key returned by the given keySelector function applied to each character and returns a map where each group key is associated with a list of corresponding characters.
fun <K> CharSequence.groupBy(
keySelector: (Char) -> K
): Map<K, List<Char>>Groups values returned by the valueTransform function applied to each character of the original char sequence by the key returned by the given keySelector function applied to the character and returns a map where each group key is associated with a list of corresponding values.
fun <K, V> CharSequence.groupBy(
keySelector: (Char) -> K,
valueTransform: (Char) -> V
): Map<K, List<V>>groupByTo
Groups characters of the original char sequence by the key returned by the given keySelector function applied to each character and puts to the destination map each group key associated with a list of corresponding characters.
fun <K, M : MutableMap<in K, MutableList<Char>>> CharSequence.groupByTo(
destination: M,
keySelector: (Char) -> K
): MGroups values returned by the valueTransform function applied to each character of the original char sequence by the key returned by the given keySelector function applied to the character and puts to the destination map each group key associated with a list of corresponding values.
fun <K, V, M : MutableMap<in K, MutableList<V>>> CharSequence.groupByTo(
destination: M,
keySelector: (Char) -> K,
valueTransform: (Char) -> V
): MgroupingBy
Creates a Grouping source from a char sequence to be used later with one of group-and-fold operations using the specified keySelector function to extract a key from each character.
fun <K> CharSequence.groupingBy(
keySelector: (Char) -> K
): Grouping<Char, K>hasSurrogatePairAt
Returns true if this CharSequence has Unicode surrogate pair at the specified index.
fun CharSequence.hasSurrogatePairAt(index: Int): BooleanifBlank
Returns this char sequence if it is not empty and doesn't consist solely of whitespace characters, or the result of calling defaultValue function otherwise.
fun <C, R> C.ifBlank(
defaultValue: () -> R
): R where C : CharSequence, C : RifEmpty
Returns this char sequence if it's not empty or the result of calling defaultValue function if the char sequence is empty.
fun <C, R> C.ifEmpty(
defaultValue: () -> R
): R where C : CharSequence, C : RindexOf
Returns the index within this string of the first occurrence of the specified character, starting from the specified startIndex.
fun CharSequence.indexOf(
char: Char,
startIndex: Int = 0,
ignoreCase: Boolean = false
): IntReturns the index within this char sequence of the first occurrence of the specified string, starting from the specified startIndex.
fun CharSequence.indexOf(
string: String,
startIndex: Int = 0,
ignoreCase: Boolean = false
): IntindexOfAny
Finds the index of the first occurrence of any of the specified chars in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.indexOfAny(
chars: CharArray,
startIndex: Int = 0,
ignoreCase: Boolean = false
): IntFinds the index of the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.indexOfAny(
strings: Collection<String>,
startIndex: Int = 0,
ignoreCase: Boolean = false
): IntindexOfFirst
Returns index of the first character matching the given predicate, or -1 if the char sequence does not contain such character.
fun CharSequence.indexOfFirst(
predicate: (Char) -> Boolean
): IntindexOfLast
Returns index of the last character matching the given predicate, or -1 if the char sequence does not contain such character.
fun CharSequence.indexOfLast(
predicate: (Char) -> Boolean
): Intintern
Returns a canonical representation for this string object.
fun String.intern(): StringisEmpty
Returns true if this char sequence is empty (contains no characters).
fun CharSequence.isEmpty(): BooleanisNotBlank
Returns true if this char sequence is not empty and contains some characters except of whitespace characters.
fun CharSequence.isNotBlank(): BooleanisNotEmpty
Returns true if this char sequence is not empty.
fun CharSequence.isNotEmpty(): BooleanisNullOrBlank
Returns true if this nullable char sequence is either null or empty or consists solely of whitespace characters.
fun CharSequence?.isNullOrBlank(): BooleanisNullOrEmpty
Returns true if this nullable char sequence is either null or empty.
fun CharSequence?.isNullOrEmpty(): Booleaniterator
Iterator for characters of the given char sequence.
operator fun CharSequence.iterator(): CharIteratorlast
Returns the last character.
fun CharSequence.last(): CharReturns the last character matching the given predicate.
fun CharSequence.last(predicate: (Char) -> Boolean): CharlastIndexOf
Returns the index within this char sequence of the last occurrence of the specified character, starting from the specified startIndex.
fun CharSequence.lastIndexOf(
char: Char,
startIndex: Int = lastIndex,
ignoreCase: Boolean = false
): IntReturns the index within this char sequence of the last occurrence of the specified string, starting from the specified startIndex.
fun CharSequence.lastIndexOf(
string: String,
startIndex: Int = lastIndex,
ignoreCase: Boolean = false
): IntlastIndexOfAny
Finds the index of the last occurrence of any of the specified chars in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.lastIndexOfAny(
chars: CharArray,
startIndex: Int = lastIndex,
ignoreCase: Boolean = false
): IntFinds the index of the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
fun CharSequence.lastIndexOfAny(
strings: Collection<String>,
startIndex: Int = lastIndex,
ignoreCase: Boolean = false
): IntlastOrNull
Returns the last character, or null if the char sequence is empty.
fun CharSequence.lastOrNull(): Char?Returns the last character matching the given predicate, or null if no such character was found.
fun CharSequence.lastOrNull(
predicate: (Char) -> Boolean
): Char?lines
Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.
fun CharSequence.lines(): List<String>lineSequence
Splits this char sequence to a sequence of lines delimited by any of the following character sequences: CRLF, LF or CR.
fun CharSequence.lineSequence(): Sequence<String>map
Returns a list containing the results of applying the given transform function to each character in the original char sequence.
fun <R> CharSequence.map(transform: (Char) -> R): List<R>mapIndexed
Returns a list containing the results of applying the given transform function to each character and its index in the original char sequence.
fun <R> CharSequence.mapIndexed(
transform: (index: Int, Char) -> R
): List<R>mapIndexedNotNull
Returns a list containing only the non-null results of applying the given transform function to each character and its index in the original char sequence.
fun <R : Any> CharSequence.mapIndexedNotNull(
transform: (index: Int, Char) -> R?
): List<R>mapIndexedNotNullTo
Applies the given transform function to each character and its index in the original char sequence and appends only the non-null results to the given destination.
fun <R : Any, C : MutableCollection<in R>> CharSequence.mapIndexedNotNullTo(
destination: C,
transform: (index: Int, Char) -> R?
): CmapIndexedTo
Applies the given transform function to each character and its index in the original char sequence and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> CharSequence.mapIndexedTo(
destination: C,
transform: (index: Int, Char) -> R
): CmapNotNull
Returns a list containing only the non-null results of applying the given transform function to each character in the original char sequence.
fun <R : Any> CharSequence.mapNotNull(
transform: (Char) -> R?
): List<R>mapNotNullTo
Applies the given transform function to each character in the original char sequence and appends only the non-null results to the given destination.
fun <R : Any, C : MutableCollection<in R>> CharSequence.mapNotNullTo(
destination: C,
transform: (Char) -> R?
): CmapTo
Applies the given transform function to each character of the original char sequence and appends the results to the given destination.
fun <R, C : MutableCollection<in R>> CharSequence.mapTo(
destination: C,
transform: (Char) -> R
): Cmatch
fun String.match(regex: String): Array<String>?matches
Returns true if this char sequence matches the given regular expression.
infix fun CharSequence.matches(regex: Regex): Booleanfun String.matches(regex: String): Booleanmax
Returns the largest character or null if there are no characters.
fun CharSequence.max(): Char?maxBy
Returns the first character yielding the largest value of the given function or null if there are no characters.
fun <R : Comparable<R>> CharSequence.maxBy(
selector: (Char) -> R
): Char?maxWith
Returns the first character having the largest value according to the provided comparator or null if there are no characters.
fun CharSequence.maxWith(
comparator: Comparator<in Char>
): Char?min
Returns the smallest character or null if there are no characters.
fun CharSequence.min(): Char?minBy
Returns the first character yielding the smallest value of the given function or null if there are no characters.
fun <R : Comparable<R>> CharSequence.minBy(
selector: (Char) -> R
): Char?minWith
Returns the first character having the smallest value according to the provided comparator or null if there are no characters.
fun CharSequence.minWith(
comparator: Comparator<in Char>
): Char?none
Returns true if the char sequence has no characters.
fun CharSequence.none(): BooleanReturns true if no characters match the given predicate.
fun CharSequence.none(predicate: (Char) -> Boolean): BooleanoffsetByCodePoints
Returns the index within this string that is offset from the given index by codePointOffset code points.
fun String.offsetByCodePoints(
index: Int,
codePointOffset: Int
): IntonEach
Performs the given action on each character and returns the char sequence itself afterwards.
fun <S : CharSequence> S.onEach(action: (Char) -> Unit): SorEmpty
Returns the string if it is not null, or the empty string otherwise.
fun String?.orEmpty(): StringpadEnd
Pads the string to the specified length at the end with the specified character or space.
fun String.padEnd(length: Int, padChar: Char = ' '): StringpadStart
Pads the string to the specified length at the beginning with the specified character or space.
fun String.padStart(length: Int, padChar: Char = ' '): StringprependIndent
Prepends indent to every line of the original string.
fun String.prependIndent(indent: String = " "): Stringrandom
Returns a random character from this char sequence.
fun CharSequence.random(): CharReturns a random character from this char sequence using the specified source of randomness.
fun CharSequence.random(random: Random): CharrandomOrNull
Returns a random character from this char sequence, or null if this char sequence is empty.
fun CharSequence.randomOrNull(): Char?Returns a random character from this char sequence using the specified source of randomness, or null if this char sequence is empty.
fun CharSequence.randomOrNull(random: Random): Char?rangeTo
Creates a range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeTo(
that: T
): ClosedRange<T>reader
Creates a new reader for the string.
fun String.reader(): StringReaderreduce
Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character.
fun CharSequence.reduce(
operation: (acc: Char, Char) -> Char
): CharreduceIndexed
Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character with its index in the original char sequence.
fun CharSequence.reduceIndexed(
operation: (index: Int, acc: Char, Char) -> Char
): CharreduceOrNull
Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character. Returns null if the char sequence is empty.
fun CharSequence.reduceOrNull(
operation: (acc: Char, Char) -> Char
): Char?reduceRight
Accumulates value starting with last character and applying operation from right to left to each character and current accumulator value.
fun CharSequence.reduceRight(
operation: (Char, acc: Char) -> Char
): CharreduceRightIndexed
Accumulates value starting with last character and applying operation from right to left to each character with its index in the original char sequence and current accumulator value.
fun CharSequence.reduceRightIndexed(
operation: (index: Int, Char, acc: Char) -> Char
): CharreduceRightOrNull
Accumulates value starting with last character and applying operation from right to left to each character and current accumulator value. Returns null if the char sequence is empty.
fun CharSequence.reduceRightOrNull(
operation: (Char, acc: Char) -> Char
): Char?removePrefix
If this string starts with the given prefix, returns a copy of this string with the prefix removed. Otherwise, returns this string.
fun String.removePrefix(prefix: CharSequence): StringremoveRange
Removes the part of a string at a given range.
fun String.removeRange(
startIndex: Int,
endIndex: Int
): StringremoveSuffix
If this string ends with the given suffix, returns a copy of this string with the suffix removed. Otherwise, returns this string.
fun String.removeSuffix(suffix: CharSequence): StringremoveSurrounding
Removes from a string both the given prefix and suffix if and only if it starts with the prefix and ends with the suffix. Otherwise returns this string unchanged.
fun String.removeSurrounding(
prefix: CharSequence,
suffix: CharSequence
): StringRemoves the given delimiter string from both the start and the end of this string if and only if it starts with and ends with the delimiter. Otherwise returns this string unchanged.
fun String.removeSurrounding(delimiter: CharSequence): Stringreplace
Returns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the given replacement.
fun CharSequence.replace(
regex: Regex,
replacement: String
): StringReturns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the result of the given function transform that takes MatchResult and returns a string to be used as a replacement for that match.
fun CharSequence.replace(
regex: Regex,
transform: (MatchResult) -> CharSequence
): StringreplaceAfter
Replace part of string after the first occurrence of given delimiter with the replacement string. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.replaceAfter(
delimiter: Char,
replacement: String,
missingDelimiterValue: String = this
): Stringfun String.replaceAfter(
delimiter: String,
replacement: String,
missingDelimiterValue: String = this
): StringreplaceAfterLast
Replace part of string after the last occurrence of given delimiter with the replacement string. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.replaceAfterLast(
delimiter: String,
replacement: String,
missingDelimiterValue: String = this
): Stringfun String.replaceAfterLast(
delimiter: Char,
replacement: String,
missingDelimiterValue: String = this
): StringreplaceBefore
Replace part of string before the first occurrence of given delimiter with the replacement string. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.replaceBefore(
delimiter: Char,
replacement: String,
missingDelimiterValue: String = this
): Stringfun String.replaceBefore(
delimiter: String,
replacement: String,
missingDelimiterValue: String = this
): StringreplaceBeforeLast
Replace part of string before the last occurrence of given delimiter with the replacement string. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.replaceBeforeLast(
delimiter: Char,
replacement: String,
missingDelimiterValue: String = this
): Stringfun String.replaceBeforeLast(
delimiter: String,
replacement: String,
missingDelimiterValue: String = this
): StringreplaceFirst
Replaces the first occurrence of the given regular expression regex in this char sequence with specified replacement expression.
fun CharSequence.replaceFirst(
regex: Regex,
replacement: String
): StringreplaceIndent
Detects a common minimal indent like it does trimIndent and replaces it with the specified newIndent.
fun String.replaceIndent(newIndent: String = ""): StringreplaceIndentByMargin
Detects indent by marginPrefix as it does trimMargin and replace it with newIndent.
fun String.replaceIndentByMargin(
newIndent: String = "",
marginPrefix: String = "|"
): StringreplaceRange
Replaces the part of the string at the given range with the replacement char sequence.
fun String.replaceRange(
startIndex: Int,
endIndex: Int,
replacement: CharSequence
): StringReplace the part of string at the given range with the replacement string.
fun String.replaceRange(
range: IntRange,
replacement: CharSequence
): Stringreversed
Returns a string with characters in reversed order.
fun String.reversed(): Stringscan
Returns a list containing successive accumulation values generated by applying operation from left to right to each character and current accumulator value that starts with initial value.
fun <R> CharSequence.scan(
initial: R,
operation: (acc: R, Char) -> R
): List<R>scanIndexed
Returns a list containing successive accumulation values generated by applying operation from left to right to each character, its index in the original char sequence and current accumulator value that starts with initial value.
fun <R> CharSequence.scanIndexed(
initial: R,
operation: (index: Int, acc: R, Char) -> R
): List<R>scanReduce
Returns a list containing successive accumulation values generated by applying operation from left to right to each character and current accumulator value that starts with the first character of this char sequence.
fun CharSequence.scanReduce(
operation: (acc: Char, Char) -> Char
): List<Char>scanReduceIndexed
Returns a list containing successive accumulation values generated by applying operation from left to right to each character, its index in the original char sequence and current accumulator value that starts with the first character of this char sequence.
fun CharSequence.scanReduceIndexed(
operation: (index: Int, acc: Char, Char) -> Char
): List<Char>single
Returns the single character, or throws an exception if the char sequence is empty or has more than one character.
fun CharSequence.single(): CharReturns the single character matching the given predicate, or throws exception if there is no or more than one matching character.
fun CharSequence.single(predicate: (Char) -> Boolean): CharsingleOrNull
Returns single character, or null if the char sequence is empty or has more than one character.
fun CharSequence.singleOrNull(): Char?Returns the single character matching the given predicate, or null if character was not found or more than one character was found.
fun CharSequence.singleOrNull(
predicate: (Char) -> Boolean
): Char?slice
split
Splits this char sequence to a list of strings around occurrences of the specified delimiters.
fun CharSequence.split(
vararg delimiters: String,
ignoreCase: Boolean = false,
limit: Int = 0
): List<String>fun CharSequence.split(
vararg delimiters: Char,
ignoreCase: Boolean = false,
limit: Int = 0
): List<String>Splits this char sequence around matches of the given regular expression.
fun CharSequence.split(
regex: Regex,
limit: Int = 0
): List<String>fun CharSequence.split(
regex: Pattern,
limit: Int = 0
): List<String>splitToSequence
Splits this char sequence to a sequence of strings around occurrences of the specified delimiters.
fun CharSequence.splitToSequence(
vararg delimiters: String,
ignoreCase: Boolean = false,
limit: Int = 0
): Sequence<String>fun CharSequence.splitToSequence(
vararg delimiters: Char,
ignoreCase: Boolean = false,
limit: Int = 0
): Sequence<String>startsWith
Returns true if this char sequence starts with the specified character.
fun CharSequence.startsWith(
char: Char,
ignoreCase: Boolean = false
): BooleanReturns true if this char sequence starts with the specified prefix.
fun CharSequence.startsWith(
prefix: CharSequence,
ignoreCase: Boolean = false
): BooleanReturns true if a substring of this char sequence starting at the specified offset startIndex starts with the specified prefix.
fun CharSequence.startsWith(
prefix: CharSequence,
startIndex: Int,
ignoreCase: Boolean = false
): BooleansubSequence
Returns a subsequence of this char sequence.
fun String.subSequence(start: Int, end: Int): CharSequenceReturns a subsequence of this char sequence specified by the given range of indices.
fun CharSequence.subSequence(range: IntRange): CharSequencesubstringAfter
Returns a substring after the first occurrence of delimiter. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.substringAfter(
delimiter: Char,
missingDelimiterValue: String = this
): Stringfun String.substringAfter(
delimiter: String,
missingDelimiterValue: String = this
): StringsubstringAfterLast
Returns a substring after the last occurrence of delimiter. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.substringAfterLast(
delimiter: Char,
missingDelimiterValue: String = this
): Stringfun String.substringAfterLast(
delimiter: String,
missingDelimiterValue: String = this
): StringsubstringBefore
Returns a substring before the first occurrence of delimiter. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.substringBefore(
delimiter: Char,
missingDelimiterValue: String = this
): Stringfun String.substringBefore(
delimiter: String,
missingDelimiterValue: String = this
): StringsubstringBeforeLast
Returns a substring before the last occurrence of delimiter. If the string does not contain the delimiter, returns missingDelimiterValue which defaults to the original string.
fun String.substringBeforeLast(
delimiter: Char,
missingDelimiterValue: String = this
): Stringfun String.substringBeforeLast(
delimiter: String,
missingDelimiterValue: String = this
): StringsumBy
Returns the sum of all values produced by selector function applied to each character in the char sequence.
fun CharSequence.sumBy(selector: (Char) -> Int): IntsumByDouble
Returns the sum of all values produced by selector function applied to each character in the char sequence.
fun CharSequence.sumByDouble(
selector: (Char) -> Double
): Doubletake
Returns a string containing the first n characters from this string, or the entire string if this string is shorter.
fun String.take(n: Int): StringtakeLast
Returns a string containing the last n characters from this string, or the entire string if this string is shorter.
fun String.takeLast(n: Int): StringtakeLastWhile
Returns a string containing last characters that satisfy the given predicate.
fun String.takeLastWhile(
predicate: (Char) -> Boolean
): StringtakeWhile
Returns a string containing the first characters that satisfy the given predicate.
fun String.takeWhile(predicate: (Char) -> Boolean): StringtoBigDecimal
Parses the string as a java.math.BigDecimal number and returns the result.
fun String.toBigDecimal(): BigDecimalfun String.toBigDecimal(mathContext: MathContext): BigDecimaltoBigDecimalOrNull
Parses the string as a java.math.BigDecimal number and returns the result
or null if the string is not a valid representation of a number.
fun String.toBigDecimalOrNull(): BigDecimal?fun String.toBigDecimalOrNull(
mathContext: MathContext
): BigDecimal?toBigInteger
Parses the string as a java.math.BigInteger number and returns the result.
fun String.toBigInteger(): BigIntegerfun String.toBigInteger(radix: Int): BigIntegertoBigIntegerOrNull
Parses the string as a java.math.BigInteger number and returns the result
or null if the string is not a valid representation of a number.
fun String.toBigIntegerOrNull(): BigInteger?fun String.toBigIntegerOrNull(radix: Int): BigInteger?toByteOrNull
Parses the string as a signed Byte number and returns the result
or null if the string is not a valid representation of a number.
fun String.toByteOrNull(): Byte?fun String.toByteOrNull(radix: Int): Byte?toCharArray
Copies characters from this string into the destination character array and returns that array.
toCollection
Appends all characters to the given destination collection.
fun <C : MutableCollection<in Char>> CharSequence.toCollection(
destination: C
): CtoHashSet
Returns a HashSet of all characters.
fun CharSequence.toHashSet(): HashSet<Char>toIntOrNull
Parses the string as an Int number and returns the result
or null if the string is not a valid representation of a number.
fun String.toIntOrNull(): Int?fun String.toIntOrNull(radix: Int): Int?toList
Returns a List containing all characters.
fun CharSequence.toList(): List<Char>toLongOrNull
Parses the string as a Long number and returns the result
or null if the string is not a valid representation of a number.
fun String.toLongOrNull(): Long?fun String.toLongOrNull(radix: Int): Long?toLowerCase
Returns a copy of this string converted to lower case using the rules of the specified locale.
fun String.toLowerCase(locale: Locale): StringtoMutableList
Returns a MutableList filled with all characters of this char sequence.
fun CharSequence.toMutableList(): MutableList<Char>toRegex
Converts the string into a regular expression Regex with the default options.
fun String.toRegex(): RegexConverts the string into a regular expression Regex with the specified single option.
fun String.toRegex(option: RegexOption): RegexConverts the string into a regular expression Regex with the specified set of options.
fun String.toRegex(options: Set<RegexOption>): RegextoSet
Returns a Set of all characters.
fun CharSequence.toSet(): Set<Char>toShortOrNull
Parses the string as a Short number and returns the result
or null if the string is not a valid representation of a number.
fun String.toShortOrNull(): Short?fun String.toShortOrNull(radix: Int): Short?toSortedSet
Returns a SortedSet of all characters.
fun CharSequence.toSortedSet(): SortedSet<Char>toUpperCase
Returns a copy of this string converted to upper case using the rules of the specified locale.
fun String.toUpperCase(locale: Locale): Stringtrim
Returns a string having leading and trailing characters matching the predicate removed.
fun String.trim(predicate: (Char) -> Boolean): StringReturns a string having leading and trailing characters from the chars array removed.
fun String.trim(vararg chars: Char): StringReturns a string having leading and trailing whitespace removed.
fun String.trim(): StringtrimEnd
Returns a string having trailing characters matching the predicate removed.
fun String.trimEnd(predicate: (Char) -> Boolean): StringReturns a string having trailing characters from the chars array removed.
fun String.trimEnd(vararg chars: Char): StringReturns a string having trailing whitespace removed.
fun String.trimEnd(): StringtrimIndent
Detects a common minimal indent of all the input lines, removes it from every line and also removes the first and the last lines if they are blank (notice difference blank vs empty).
fun String.trimIndent(): StringtrimMargin
Trims leading whitespace characters followed by marginPrefix from every line of a source string and removes the first and the last lines if they are blank (notice difference blank vs empty).
fun String.trimMargin(marginPrefix: String = "|"): StringtrimStart
Returns a string having leading characters matching the predicate removed.
fun String.trimStart(predicate: (Char) -> Boolean): StringReturns a string having leading characters from the chars array removed.
fun String.trimStart(vararg chars: Char): StringReturns a string having leading whitespace removed.
fun String.trimStart(): Stringwindowed
Returns a list of snapshots of the window of the given size sliding along this char sequence with the given step, where each snapshot is a string.
fun CharSequence.windowed(
size: Int,
step: Int = 1,
partialWindows: Boolean = false
): List<String>Returns a list of results of applying the given transform function to an each char sequence representing a view over the window of the given size sliding along this char sequence with the given step.
fun <R> CharSequence.windowed(
size: Int,
step: Int = 1,
partialWindows: Boolean = false,
transform: (CharSequence) -> R
): List<R>windowedSequence
Returns a sequence of snapshots of the window of the given size sliding along this char sequence with the given step, where each snapshot is a string.
fun CharSequence.windowedSequence(
size: Int,
step: Int = 1,
partialWindows: Boolean = false
): Sequence<String>Returns a sequence of results of applying the given transform function to an each char sequence representing a view over the window of the given size sliding along this char sequence with the given step.
fun <R> CharSequence.windowedSequence(
size: Int,
step: Int = 1,
partialWindows: Boolean = false,
transform: (CharSequence) -> R
): Sequence<R>withIndex
Returns a lazy Iterable that wraps each character of the original char sequence into an IndexedValue containing the index of that character and the character itself.
fun CharSequence.withIndex(): Iterable<IndexedValue<Char>>zip
Returns a list of pairs built from the characters of this and the other char sequences with the same index
The returned list has length of the shortest char sequence.
infix fun CharSequence.zip(
other: CharSequence
): List<Pair<Char, Char>>Returns a list of values built from the characters of this and the other char sequences with the same index
using the provided transform function applied to each pair of characters.
The returned list has length of the shortest char sequence.
fun <V> CharSequence.zip(
other: CharSequence,
transform: (a: Char, b: Char) -> V
): List<V>zipWithNext
Returns a list of pairs of each two adjacent characters in this char sequence.
fun CharSequence.zipWithNext(): List<Pair<Char, Char>>Returns a list containing the results of applying the given transform function to an each pair of two adjacent characters in this char sequence.
fun <R> CharSequence.zipWithNext(
transform: (a: Char, b: Char) -> R
): List<R>