class StringBuilder : Appendable, CharSequence
typealias StringBuilder = StringBuilder
class StringBuilder : CharSequence, Appendable
A mutable sequence of characters.
String builder can be used to efficiently perform multiple string manipulation operations.
Constructs an empty string builder.
<init>()
Constructs an empty string builder with the specified initial capacity.
<init>(capacity: Int)
Constructs a string builder that contains the same characters as the specified content char sequence.
<init>(content: CharSequence)
Constructs a string builder that contains the same characters as the specified content string.
<init>(content: String)
Returns the length of this character sequence.
val length: Int
fun append(value: Byte): StringBuilder
fun append(value: Short): StringBuilder
fun append(value: Int): StringBuilder
fun append(value: Long): StringBuilder
fun append(value: Float): StringBuilder
fun append(value: Double): StringBuilder
fun append(value: String): StringBuilder
Appends the specified character value to this Appendable and returns this instance.
fun append(value: Char): StringBuilder
Appends the specified character sequence value to this Appendable and returns this instance.
fun append(value: CharSequence?): StringBuilder
Appends a subsequence of the specified character sequence value to this Appendable and returns this instance.
fun append( value: CharSequence?, startIndex: Int, endIndex: Int ): StringBuilder
Appends the string representation of the specified object value to this string builder and returns this instance.
fun append(value: Any?): StringBuilder
Appends the string representation of the specified boolean value to this string builder and returns this instance.
fun append(value: Boolean): StringBuilder
Appends characters in the specified character array value to this string builder and returns this instance.
fun append(value: CharArray): StringBuilder
Appends the specified string value to this string builder and returns this instance.
fun append(value: String?): StringBuilder
Appends characters in a subarray of the specified character array value to this string builder and returns this instance.
fun appendRange( value: CharArray, startIndex: Int, endIndex: Int ): StringBuilder
Appends a subsequence of the specified character sequence value to this string builder and returns this instance.
fun appendRange( value: CharSequence, startIndex: Int, endIndex: Int ): StringBuilder
Returns the current capacity of this string builder.
fun capacity(): Int
fun capacity(): Int
Clears the content of this string builder making it empty and returns this instance.
fun clear(): StringBuilder
Removes the character at the specified index from this string builder and returns this instance.
fun deleteAt(index: Int): StringBuilder
Removes characters in the specified range from this string builder and returns this instance.
fun deleteRange( startIndex: Int, endIndex: Int ): StringBuilder
Ensures that the capacity of this string builder is at least equal to the specified minimumCapacity.
fun ensureCapacity(minimumCapacity: Int)
Returns the character at the specified index in this character sequence.
operator fun get(index: Int): Char
fun get(index: Int): Char
Returns the index within this string builder of the first occurrence of the specified string.
fun indexOf(string: String): Int
Returns the index within this string builder of the first occurrence of the specified string, starting at the specified startIndex.
fun indexOf(string: String, startIndex: Int): Int
fun insert(index: Int, value: Byte): StringBuilder
fun insert(index: Int, value: Short): StringBuilder
fun insert(index: Int, value: Int): StringBuilder
fun insert(index: Int, value: Long): StringBuilder
fun insert(index: Int, value: Float): StringBuilder
fun insert(index: Int, value: Double): StringBuilder
fun insert(index: Int, value: String): StringBuilder
Inserts the string representation of the specified boolean value into this string builder at the specified index and returns this instance.
fun insert(index: Int, value: Boolean): StringBuilder
Inserts the specified character value into this string builder at the specified index and returns this instance.
fun insert(index: Int, value: Char): StringBuilder
Inserts characters in the specified character array value into this string builder at the specified index and returns this instance.
fun insert(index: Int, value: CharArray): StringBuilder
Inserts characters in the specified character sequence value into this string builder at the specified index and returns this instance.
fun insert(index: Int, value: CharSequence?): StringBuilder
Returns the index within this string builder of the last occurrence of the specified string. The last occurrence of empty string ""
is considered to be at the index equal to this.length
.
fun lastIndexOf(string: String): Int
Returns the index within this string builder of the last occurrence of the specified string, starting from the specified startIndex toward the beginning.
fun lastIndexOf(string: String, startIndex: Int): Int
Reverses the contents of this string builder and returns this instance.
fun reverse(): StringBuilder
Sets the length of this string builder to the specified newLength.
fun setLength(newLength: Int)
Replaces characters in the specified range of this string builder with characters in the specified string value and returns this instance.
fun setRange( startIndex: Int, endIndex: Int, value: String ): StringBuilder
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): CharSequence
Returns a new String that contains characters in this string builder at startIndex (inclusive) and up to the length (exclusive).
fun substring(startIndex: Int): String
Returns a new String that contains characters in this string builder at startIndex (inclusive) and up to the endIndex (exclusive).
fun substring(startIndex: Int, endIndex: Int): String
Copies characters from this string builder into the destination character array.
fun toCharArray( destination: CharArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = this.length)
Returns a string representation of the object.
fun toString(): String
Attempts to reduce storage used for this string builder.
fun trimToSize()
Returns the range of valid character indices for this char sequence.
val CharSequence.indices: IntRange
Returns the index of the last character in the char sequence or -1 if it is empty.
val CharSequence.lastIndex: Int
Returns true
if all characters match the given predicate.
fun CharSequence.all(predicate: (Char) -> Boolean): Boolean
Returns true
if char sequence has at least one character.
fun CharSequence.any(): Boolean
Returns true
if at least one character matches the given predicate.
fun CharSequence.any(predicate: (Char) -> Boolean): Boolean
fun StringBuilder.append(obj: Any?): StringBuilder
fun StringBuilder.append(it: Boolean): StringBuilder
fun StringBuilder.append(it: Byte): StringBuilder
fun StringBuilder.append(it: Short): StringBuilder
fun StringBuilder.append(it: Int): StringBuilder
fun StringBuilder.append(it: Long): StringBuilder
fun StringBuilder.append(it: Float): StringBuilder
fun StringBuilder.append(it: Double): StringBuilder
fun StringBuilder.append(it: String): StringBuilder
fun StringBuilder.append(it: CharArray): StringBuilder
Appends all arguments to the given StringBuilder.
fun StringBuilder.append( vararg value: String? ): StringBuilder
fun StringBuilder.append(vararg value: Any?): StringBuilder
Appends all arguments to the given Appendable.
fun <T : Appendable> T.append(vararg value: CharSequence?): T
Appends a line feed character (\n
) to this StringBuilder.
fun StringBuilder.appendLine(): StringBuilder
Appends value to this StringBuilder, followed by a line feed character (\n
).
fun StringBuilder.appendLine( value: CharSequence? ): StringBuilder
fun StringBuilder.appendLine(value: String?): StringBuilder
fun StringBuilder.appendLine(value: Any?): StringBuilder
fun StringBuilder.appendLine(value: CharArray): StringBuilder
fun StringBuilder.appendLine(value: Char): StringBuilder
fun StringBuilder.appendLine(value: Boolean): StringBuilder
fun StringBuilder.appendLine(value: Byte): StringBuilder
fun StringBuilder.appendLine(value: Short): StringBuilder
fun StringBuilder.appendLine(value: Int): StringBuilder
fun StringBuilder.appendLine(value: Long): StringBuilder
fun StringBuilder.appendLine(value: Float): StringBuilder
fun StringBuilder.appendLine(value: Double): StringBuilder
fun StringBuilder.appendln(it: String): StringBuilder
fun StringBuilder.appendln(it: Boolean): StringBuilder
fun StringBuilder.appendln(it: Byte): StringBuilder
fun StringBuilder.appendln(it: Short): StringBuilder
fun StringBuilder.appendln(it: Int): StringBuilder
fun StringBuilder.appendln(it: Long): StringBuilder
fun StringBuilder.appendln(it: Float): StringBuilder
fun StringBuilder.appendln(it: Double): StringBuilder
fun StringBuilder.appendln(it: Any?): StringBuilder
fun StringBuilder.appendln(): StringBuilder
Creates an Iterable instance that wraps the original char sequence returning its characters when being iterated.
fun CharSequence.asIterable(): Iterable<Char>
Creates a Sequence instance that wraps the original char sequence returning its characters when being iterated.
fun CharSequence.asSequence(): Sequence<Char>
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>
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 ): M
Populates 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 ): M
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> ): M
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>
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 ): M
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 a sequence of strings each not exceeding the given size.
fun CharSequence.chunkedSequence(size: Int): Sequence<String>
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 ): String
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 ): String
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 ): Boolean
Returns true
if this char sequence contains the specified character char.
operator fun CharSequence.contains( char: Char, ignoreCase: Boolean = false ): Boolean
Returns true
if this char sequence contains at least one match of the specified regular expression regex.
operator fun CharSequence.contains(regex: Regex): Boolean
Returns the length of this char sequence.
fun CharSequence.count(): Int
Returns the number of characters matching the given predicate.
fun CharSequence.count(predicate: (Char) -> Boolean): Int
Removes the character at the specified index from this string builder and returns this instance.
fun StringBuilder.deleteCharAt(index: Int): StringBuilder
Returns a subsequence of this char sequence with the first n characters removed.
fun CharSequence.drop(n: Int): CharSequence
Returns a subsequence of this char sequence with the last n characters removed.
fun CharSequence.dropLast(n: Int): CharSequence
Returns a subsequence of this char sequence containing all characters except last characters that satisfy the given predicate.
fun CharSequence.dropLastWhile( predicate: (Char) -> Boolean ): CharSequence
Returns a subsequence of this char sequence containing all characters except first characters that satisfy the given predicate.
fun CharSequence.dropWhile( predicate: (Char) -> Boolean ): CharSequence
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 ): Char
Returns true
if this char sequence ends with the specified character.
fun CharSequence.endsWith( char: Char, ignoreCase: Boolean = false ): Boolean
Returns true
if this char sequence ends with the specified suffix.
fun CharSequence.endsWith( suffix: CharSequence, ignoreCase: Boolean = false ): Boolean
fun StringBuilder.ensureCapacity(capacity: Int)
Returns a char sequence containing only those characters from the original char sequence that match the given predicate.
fun CharSequence.filter( predicate: (Char) -> Boolean ): CharSequence
Returns a char sequence containing only those characters from the original char sequence that match the given predicate.
fun CharSequence.filterIndexed( predicate: (index: Int, Char) -> Boolean ): CharSequence
Appends all characters matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterIndexedTo( destination: C, predicate: (index: Int, Char) -> Boolean ): C
Returns a char sequence containing only those characters from the original char sequence that do not match the given predicate.
fun CharSequence.filterNot( predicate: (Char) -> Boolean ): CharSequence
Appends all characters not matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterNotTo( destination: C, predicate: (Char) -> Boolean ): C
Appends all characters matching the given predicate to the given destination.
fun <C : Appendable> CharSequence.filterTo( destination: C, predicate: (Char) -> Boolean ): C
Returns the first character matching the given predicate, or null
if no such character was found.
fun CharSequence.find(predicate: (Char) -> Boolean): Char?
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>?
Returns the last character matching the given predicate, or null
if no such character was found.
fun CharSequence.findLast( predicate: (Char) -> Boolean ): Char?
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>?
Returns first character.
fun CharSequence.first(): Char
Returns the first character matching the given predicate.
fun CharSequence.first(predicate: (Char) -> Boolean): Char
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?
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>
Returns a single list of all elements yielded from results of transform function being invoked on each character and its index in the original char sequence.
fun <R> CharSequence.flatMapIndexed( transform: (index: Int, Char) -> Iterable<R> ): List<R>
Appends all elements yielded from results of transform function being invoked on each character and its index in the original char sequence, to the given destination.
fun <R, C : MutableCollection<in R>> CharSequence.flatMapIndexedTo( destination: C, transform: (index: Int, Char) -> Iterable<R> ): C
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> ): C
Performs the given action on each character.
fun CharSequence.forEach(action: (Char) -> Unit)
Performs the given action on each character, providing sequential index with the character.
fun CharSequence.forEachIndexed( action: (index: Int, Char) -> Unit)
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 ): Char
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>>
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 ): M
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 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 ): M
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>
Returns true
if this CharSequence has Unicode surrogate pair at the specified index.
fun CharSequence.hasSurrogatePairAt(index: Int): Boolean
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 : R
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 : R
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 ): Int
Returns 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 ): Int
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 ): Int
Finds 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 ): Int
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 ): Int
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 ): Int
fun StringBuilder.insert(index: Int, c: Char): StringBuilder
fun StringBuilder.insert( index: Int, chars: CharArray ): StringBuilder
fun StringBuilder.insert( index: Int, csq: CharSequence? ): StringBuilder
fun StringBuilder.insert( index: Int, string: String ): StringBuilder
Returns true
if this char sequence is empty (contains no characters).
fun CharSequence.isEmpty(): Boolean
Returns true
if this char sequence is not empty and contains some characters except of whitespace characters.
fun CharSequence.isNotBlank(): Boolean
Returns true
if this char sequence is not empty.
fun CharSequence.isNotEmpty(): Boolean
Returns true
if this nullable char sequence is either null
or empty or consists solely of whitespace characters.
fun CharSequence?.isNullOrBlank(): Boolean
Returns true
if this nullable char sequence is either null
or empty.
fun CharSequence?.isNullOrEmpty(): Boolean
Iterator for characters of the given char sequence.
operator fun CharSequence.iterator(): CharIterator
Returns the last character.
fun CharSequence.last(): Char
Returns the last character matching the given predicate.
fun CharSequence.last(predicate: (Char) -> Boolean): Char
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 ): Int
Returns 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 ): Int
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 ): Int
Finds 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 ): Int
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?
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>
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>
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>
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>
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>
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? ): C
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 ): C
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>
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? ): C
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 ): C
Returns true
if this char sequence matches the given regular expression.
infix fun CharSequence.matches(regex: Regex): Boolean
fun CharSequence.max(): Char?
fun <R : Comparable<R>> CharSequence.maxBy( selector: (Char) -> R ): Char?
Returns the first character yielding the largest value of the given function or null
if there are no characters.
fun <R : Comparable<R>> CharSequence.maxByOrNull( selector: (Char) -> R ): Char?
Returns the largest value among all values produced by selector function applied to each character in the char sequence.
fun <R : Comparable<R>> any_iterable<R>.maxOf( selector: (Char) -> R ): R
Returns the largest value among all values produced by selector function applied to each character in the char sequence or null
if there are no characters.
fun <R : Comparable<R>> any_iterable<R>.maxOfOrNull( selector: (Char) -> R ): R?
Returns the largest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence.
fun <R> CharSequence.maxOfWith( comparator: Comparator<in R>, selector: (Char) -> R ): R
Returns the largest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence or null
if there are no characters.
fun <R> CharSequence.maxOfWithOrNull( comparator: Comparator<in R>, selector: (Char) -> R ): R?
Returns the largest character or null
if there are no characters.
fun CharSequence.maxOrNull(): Char?
fun CharSequence.maxWith( comparator: Comparator<in Char> ): Char?
Returns the first character having the largest value according to the provided comparator or null
if there are no characters.
fun CharSequence.maxWithOrNull( comparator: Comparator<in Char> ): Char?
fun CharSequence.min(): Char?
fun <R : Comparable<R>> CharSequence.minBy( selector: (Char) -> R ): Char?
Returns the first character yielding the smallest value of the given function or null
if there are no characters.
fun <R : Comparable<R>> CharSequence.minByOrNull( selector: (Char) -> R ): Char?
Returns the smallest value among all values produced by selector function applied to each character in the char sequence.
fun <R : Comparable<R>> any_iterable<R>.minOf( selector: (Char) -> R ): R
Returns the smallest value among all values produced by selector function applied to each character in the char sequence or null
if there are no characters.
fun <R : Comparable<R>> any_iterable<R>.minOfOrNull( selector: (Char) -> R ): R?
Returns the smallest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence.
fun <R> CharSequence.minOfWith( comparator: Comparator<in R>, selector: (Char) -> R ): R
Returns the smallest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence or null
if there are no characters.
fun <R> CharSequence.minOfWithOrNull( comparator: Comparator<in R>, selector: (Char) -> R ): R?
Returns the smallest character or null
if there are no characters.
fun CharSequence.minOrNull(): Char?
fun CharSequence.minWith( comparator: Comparator<in Char> ): Char?
Returns the first character having the smallest value according to the provided comparator or null
if there are no characters.
fun CharSequence.minWithOrNull( comparator: Comparator<in Char> ): Char?
Returns true
if the char sequence has no characters.
fun CharSequence.none(): Boolean
Returns true
if no characters match the given predicate.
fun CharSequence.none(predicate: (Char) -> Boolean): Boolean
Performs the given action on each character and returns the char sequence itself afterwards.
fun <S : CharSequence> S.onEach(action: (Char) -> Unit): S
Performs the given action on each character, providing sequential index with the character, and returns the char sequence itself afterwards.
fun <S : CharSequence> S.onEachIndexed( action: (index: Int, Char) -> Unit ): S
Returns a char sequence with content of this char sequence padded at the end to the specified length with the specified character or space.
fun CharSequence.padEnd( length: Int, padChar: Char = ' ' ): CharSequence
Returns a char sequence with content of this char sequence padded at the beginning to the specified length with the specified character or space.
fun CharSequence.padStart( length: Int, padChar: Char = ' ' ): CharSequence
Splits the original char sequence into pair of char sequences, where first char sequence contains characters for which predicate yielded true
, while second char sequence contains characters for which predicate yielded false
.
fun CharSequence.partition( predicate: (Char) -> Boolean ): Pair<CharSequence, CharSequence>
Returns a random character from this char sequence.
fun CharSequence.random(): Char
Returns a random character from this char sequence using the specified source of randomness.
fun CharSequence.random(random: Random): Char
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?
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 ): Char
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 ): Char
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.reduceIndexedOrNull( operation: (index: Int, acc: Char, Char) -> Char ): Char?
Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character.
fun CharSequence.reduceOrNull( operation: (acc: Char, Char) -> Char ): Char?
Accumulates value starting with the last character and applying operation from right to left to each character and current accumulator value.
fun CharSequence.reduceRight( operation: (Char, acc: Char) -> Char ): Char
Accumulates value starting with the 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 ): Char
Accumulates value starting with the 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.reduceRightIndexedOrNull( operation: (index: Int, Char, acc: Char) -> Char ): Char?
Accumulates value starting with the last character and applying operation from right to left to each character and current accumulator value.
fun CharSequence.reduceRightOrNull( operation: (Char, acc: Char) -> Char ): Char?
If this char sequence starts with the given prefix, returns a new char sequence with the prefix removed. Otherwise, returns a new char sequence with the same characters.
fun CharSequence.removePrefix( prefix: CharSequence ): CharSequence
Returns a char sequence with content of this char sequence where its part at the given range is removed.
fun CharSequence.removeRange( startIndex: Int, endIndex: Int ): CharSequence
Returns a char sequence with content of this char sequence where its part at the given range is removed.
fun CharSequence.removeRange(range: IntRange): CharSequence
If this char sequence ends with the given suffix, returns a new char sequence with the suffix removed. Otherwise, returns a new char sequence with the same characters.
fun CharSequence.removeSuffix( suffix: CharSequence ): CharSequence
When this char sequence starts with the given prefix and ends with the given suffix, returns a new char sequence having both the given prefix and suffix removed. Otherwise returns a new char sequence with the same characters.
fun CharSequence.removeSurrounding( prefix: CharSequence, suffix: CharSequence ): CharSequence
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 ): String
Returns 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 ): String
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 ): String
Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.
fun CharSequence.replaceRange( startIndex: Int, endIndex: Int, replacement: CharSequence ): CharSequence
Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.
fun CharSequence.replaceRange( range: IntRange, replacement: CharSequence ): CharSequence
Returns a char sequence with characters in reversed order.
fun CharSequence.reversed(): CharSequence
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.runningFoldIndexed( initial: R, operation: (index: Int, acc: R, Char) -> R ): List<R>
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.runningReduce( operation: (acc: Char, Char) -> Char ): List<Char>
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.runningReduceIndexed( operation: (index: Int, acc: Char, Char) -> Char ): List<Char>
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>
fun CharSequence.scanReduce( operation: (acc: Char, Char) -> Char ): List<Char>
fun CharSequence.scanReduceIndexed( operation: (index: Int, acc: Char, Char) -> Char ): List<Char>
fun StringBuilder.setCharAt(index: Int, value: Char)
fun StringBuilder.setLength(l: Int)
Returns the single character, or throws an exception if the char sequence is empty or has more than one character.
fun CharSequence.single(): Char
Returns 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): Char
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?
Returns a char sequence containing characters of the original char sequence at the specified range of indices.
fun CharSequence.slice(indices: IntRange): CharSequence
Returns a char sequence containing characters of the original char sequence at specified indices.
fun CharSequence.slice(indices: Iterable<Int>): CharSequence
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>
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>
Returns true
if this char sequence starts with the specified character.
fun CharSequence.startsWith( char: Char, ignoreCase: Boolean = false ): Boolean
Returns true
if this char sequence starts with the specified prefix.
fun CharSequence.startsWith( prefix: CharSequence, ignoreCase: Boolean = false ): Boolean
Returns 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 ): Boolean
Returns a subsequence of this char sequence specified by the given range of indices.
fun CharSequence.subSequence(range: IntRange): CharSequence
Returns a substring of chars from a range of this char sequence starting at the startIndex and ending right before the endIndex.
fun CharSequence.substring( startIndex: Int, endIndex: Int = length ): String
Returns a substring of chars at indices from the specified range of this char sequence.
fun CharSequence.substring(range: IntRange): String
Returns the sum of all values produced by selector function applied to each character in the char sequence.
fun CharSequence.sumBy(selector: (Char) -> Int): Int
Returns the sum of all values produced by selector function applied to each character in the char sequence.
fun CharSequence.sumByDouble( selector: (Char) -> Double ): Double
Returns the sum of all values produced by selector function applied to each character in the char sequence.
fun CharSequence.sumOf(selector: (Char) -> Double): Double
fun CharSequence.sumOf(selector: (Char) -> Int): Int
fun CharSequence.sumOf(selector: (Char) -> Long): Long
fun CharSequence.sumOf(selector: (Char) -> UInt): UInt
fun CharSequence.sumOf(selector: (Char) -> ULong): ULong
Returns a subsequence of this char sequence containing the first n characters from this char sequence, or the entire char sequence if this char sequence is shorter.
fun CharSequence.take(n: Int): CharSequence
Returns a subsequence of this char sequence containing the last n characters from this char sequence, or the entire char sequence if this char sequence is shorter.
fun CharSequence.takeLast(n: Int): CharSequence
Returns a subsequence of this char sequence containing last characters that satisfy the given predicate.
fun CharSequence.takeLastWhile( predicate: (Char) -> Boolean ): CharSequence
Returns a subsequence of this char sequence containing the first characters that satisfy the given predicate.
fun CharSequence.takeWhile( predicate: (Char) -> Boolean ): CharSequence
Appends all characters to the given destination collection.
fun <C : MutableCollection<in Char>> CharSequence.toCollection( destination: C ): C
Returns a new HashSet of all characters.
fun CharSequence.toHashSet(): HashSet<Char>
Returns a List containing all characters.
fun CharSequence.toList(): List<Char>
Returns a new MutableList filled with all characters of this char sequence.
fun CharSequence.toMutableList(): MutableList<Char>
Returns a Set of all characters.
fun CharSequence.toSet(): Set<Char>
Returns a sub sequence of this char sequence having leading and trailing characters matching the predicate removed.
fun CharSequence.trim( predicate: (Char) -> Boolean ): CharSequence
Returns a sub sequence of this char sequence having leading and trailing characters from the chars array removed.
fun CharSequence.trim(vararg chars: Char): CharSequence
Returns a sub sequence of this char sequence having leading and trailing whitespace removed.
fun CharSequence.trim(): CharSequence
Returns a sub sequence of this char sequence having trailing characters matching the predicate removed.
fun CharSequence.trimEnd( predicate: (Char) -> Boolean ): CharSequence
Returns a sub sequence of this char sequence having trailing characters from the chars array removed.
fun CharSequence.trimEnd(vararg chars: Char): CharSequence
Returns a sub sequence of this char sequence having trailing whitespace removed.
fun CharSequence.trimEnd(): CharSequence
Returns a sub sequence of this char sequence having leading characters matching the predicate removed.
fun CharSequence.trimStart( predicate: (Char) -> Boolean ): CharSequence
Returns a sub sequence of this char sequence having leading characters from the chars array removed.
fun CharSequence.trimStart(vararg chars: Char): CharSequence
Returns a sub sequence of this char sequence having leading whitespace removed.
fun CharSequence.trimStart(): CharSequence
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>
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>
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>>
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>
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>
© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-string-builder/index.html