String
The String class represents character strings. All string literals in Kotlin programs, such as "abc", are implemented as instances of this class.
Since Kotlin
1.1The String class represents character strings. All string literals in Kotlin programs, such as "abc", are implemented as instances of this class.
Since Kotlin
1.0Types
Properties
Returns the range of valid character indices for this char sequence.
Returns the range of valid character indices for this char sequence.
Returns the index of the last character in the char sequence or -1 if it is empty.
Returns the index of the last character in the char sequence or -1 if it is empty.
Functions
Returns true if char sequence has at least one character.
Returns true if at least one character matches the given predicate.
Creates an Iterable instance that wraps the original char sequence returning its characters when being iterated.
Creates a Sequence instance that wraps the original char sequence returning its characters when being iterated.
Returns a Map containing the characters from the given char sequence indexed by the key returned from keySelector function applied to each character.
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to characters of the given char sequence.
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.
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.
Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each character of the given char sequence.
Creates a new byte input stream for the string.
Returns a copy of this string having its first letter titlecased using the rules of the default locale, or the original string if it's empty or already starts with a title case letter.
Returns a copy of this string having its first letter titlecased using the rules of the default locale, or the original string if it's empty or already starts with a title case letter.
Returns the character (Unicode code point) at the specified index.
Returns the character (Unicode code point) before the specified index.
Returns the number of Unicode code points in the specified text range of this 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.
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.
Returns true if this char sequence contains at least one match of the specified regular expression regex.
Returns true if this char sequence contains the specified character char.
Returns true if this char sequence contains the specified other sequence of characters as a substring.
Returns true if this char sequence contains at least one match of the specified regular expression regex.
Returns true if this char sequence contains the specified character char.
Returns true if this char sequence contains the specified other sequence of characters as a substring.
Returns true if this string is equal to the contents of the specified StringBuffer, false otherwise.
Returns true if this string is equal to the contents of the specified CharSequence, false otherwise.
Returns the length of this char sequence.
Returns the number of characters matching the given predicate.
Returns a copy of this string having its first letter lowercased using the rules of the default locale, or the original string if it's empty or already starts with a lower case letter.
Returns a copy of this string having its first letter lowercased using the rules of the default locale, or the original string if it's empty or already starts with a lower case letter.
Returns a character at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this char sequence.
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.
Returns true if this char sequence ends with the specified character.
Returns true if this char sequence ends with the specified suffix.
Returns true if this char sequence ends with the specified character.
Returns true if this char sequence ends with the specified suffix.
Returns true if this string ends with the specified suffix.
Appends all characters matching the given predicate to the given destination.
Appends all characters not matching the given predicate to the given destination.
Appends all characters matching the given predicate to the given destination.
Finds the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
Finds the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
Finds the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
Finds the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.
Returns first character.
Returns the first character matching the given predicate.
Returns the first character, or null if the char sequence is empty.
Returns the first character matching the given predicate, or null if character was not found.
Appends all elements yielded from results of transform function being invoked on each character of original char sequence, to the given destination.
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.
Performs the given action on each character, providing sequential index with the character.
Uses this string as a format string and returns a string obtained by substituting the specified arguments, using the default locale.
Uses this string as a format string and returns a string obtained by substituting the specified arguments, using the specified locale.
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.
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.
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.
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.
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.
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.
Returns the index within this string of the first occurrence of the specified character, starting from the specified startIndex.
Returns the index within this char sequence of the first occurrence of the specified string, starting from the specified startIndex.
Returns the index within this string of the first occurrence of the specified character, starting from the specified startIndex.
Returns the index within this char sequence of the first occurrence of the specified string, starting from the specified startIndex.
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.
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.
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.
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.
Returns index of the first character matching the given predicate, or -1 if the char sequence does not contain such character.
Returns index of the last character matching the given predicate, or -1 if the char sequence does not contain such character.
Returns true if this string is empty or consists solely of whitespace characters.
Returns true if this char sequence is empty (contains no characters).
Returns true if this char sequence is empty (contains no characters).
Returns true if this char sequence is not empty and contains some characters except of whitespace characters.
Returns true if this char sequence is not empty and contains some characters except of whitespace characters.
Returns true if this char sequence is not empty.
Returns true if this char sequence is not empty.
Returns true if this nullable char sequence is either null or empty or consists solely of whitespace characters.
Returns true if this nullable char sequence is either null or empty or consists solely of whitespace characters.
Returns true if this nullable char sequence is either null or empty.
Returns true if this nullable char sequence is either null or empty.
Iterator for characters of the given char sequence.
Iterator for characters of the given char sequence.
Returns the last character.
Returns the last character matching the given predicate.
Returns the index within this char sequence of the last occurrence of the specified character, starting from the specified startIndex.
Returns the index within this char sequence of the last occurrence of the specified string, starting from the specified startIndex.
Returns the index within this char sequence of the last occurrence of the specified character, starting from the specified startIndex.
Returns the index within this char sequence of the last occurrence of the specified string, starting from the specified startIndex.
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.
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.
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.
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.
Returns the last character, or null if the char sequence is empty.
Returns the last character matching the given predicate, or null if no such character was found.
Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.
Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.
Splits this char sequence to a sequence of lines delimited by any of the following character sequences: CRLF, LF or CR.
Splits this char sequence to a sequence of lines delimited by any of the following character sequences: CRLF, LF or CR.
Returns a list containing the results of applying the given transform function to each character and its index in the original char sequence.
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.
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.
Applies the given transform function to each character and its index in the original char sequence and appends the results to the given destination.
Returns a list containing only the non-null results of applying the given transform function to each character in the original char sequence.
Applies the given transform function to each character in the original char sequence and appends only the non-null results to the given destination.
Applies the given transform function to each character of the original char sequence and appends the results to the given destination.
Returns true if this char sequence matches the given regular expression.
Returns true if this char sequence matches the given regular expression.
Returns true if the char sequence has no characters.
Returns true if no characters match the given predicate.
Returns the index within this string that is offset from the given index by codePointOffset code points.
Returns a char sequence with content of this char sequence padded at the end to the specified length with the specified character or space.
Pads the string to the specified length at the end with the specified character or space.
Returns a char sequence with content of this char sequence padded at the beginning to the specified length with the specified character or space.
Pads the string to the specified length at the beginning with the specified character or space.
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.
Splits the original string into pair of strings, where first string contains characters for which predicate yielded true, while second string contains characters for which predicate yielded false.
Returns a string obtained by concatenating this string with the string representation of the given other object.
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.
Accumulates value starting with the last character and applying operation from right to left to each character and current accumulator value.
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.
Returns true if the specified range in this char sequence is equal to the specified range in another char sequence.
Returns true if the specified range in this string is equal to the specified range in another string.
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.
If this string starts with the given prefix, returns a copy of this string with the prefix removed. Otherwise, returns this string.
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.
If this string starts with the given prefix, returns a copy of this string with the prefix removed. Otherwise, returns this string.
Returns a char sequence with content of this char sequence where its part at the given range is removed.
Removes the part of a string at the given range.
Returns a char sequence with content of this char sequence where its part at the given range is removed.
Removes the part of a string at a given range.
Returns a char sequence with content of this char sequence where its part at the given range is removed.
Removes the part of a string at the given range.
Returns a char sequence with content of this char sequence where its part at the given range is removed.
Removes the part of a string at a given range.
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.
If this string ends with the given suffix, returns a copy of this string with the suffix removed. Otherwise, returns this string.
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.
If this string ends with the given suffix, returns a copy of this string with the suffix removed. Otherwise, returns this string.
When this char sequence starts with and ends with the given delimiter, returns a new char sequence having this delimiter removed both from the start and end. Otherwise returns a new char sequence with the same characters.
Removes 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.
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.
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.
When this char sequence starts with and ends with the given delimiter, returns a new char sequence having this delimiter removed both from the start and end. Otherwise returns a new char sequence with the same characters.
Removes 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.
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.
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.
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.
Returns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the given replacement.
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.
Returns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the given replacement.
Returns a new string obtained by replacing all occurrences of the oldValue substring in this string with the specified newValue string.
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.
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.
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.
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.
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.
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.
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.
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.
Replaces the first occurrence of the given regular expression regex in this char sequence with specified replacement expression.
Replaces the first occurrence of the given regular expression regex in this char sequence with specified replacement expression.
Returns a new string obtained by replacing the first occurrence of the oldValue substring in this string with the specified newValue string.
Detects a common minimal indent like it does trimIndent and replaces it with the specified newIndent.
Detects a common minimal indent like it does trimIndent and replaces it with the specified newIndent.
Detects indent by marginPrefix as it does trimMargin and replace it with newIndent.
Detects indent by marginPrefix as it does trimMargin and replace it with newIndent.
Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.
Replace the part of string at the given range with the replacement 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.
Replaces the part of the string at the given range with the replacement char sequence.
Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.
Replace the part of string at the given range with the replacement 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.
Replaces the part of the string at the given range with the replacement char sequence.
Returns a char sequence with characters in reversed order.
Returns a string with characters in reversed order.
Returns the single character, or throws an exception if the char sequence is empty or has more than one character.
Returns the single character matching the given predicate, or throws exception if there is no or more than one matching character.
Returns single character, or null if the char sequence is empty or has more than one character.
Returns the single character matching the given predicate, or null if character was not found or more than one character was found.
Returns a char sequence containing characters of the original char sequence at specified indices.
Returns a char sequence containing characters of the original char sequence at the specified range of indices.
Returns a string containing characters of the original string at specified indices.
Returns a string containing characters of the original string at the specified range of indices.
Splits this char sequence to a list of strings around matches of the given regular expression.
Splits this char sequence to a list of strings around occurrences of the specified delimiters.
Splits this char sequence around matches of the given regular expression.
Splits this char sequence to a list of strings around matches of the given regular expression.
Splits this char sequence to a list of strings around occurrences of the specified delimiters.
Splits this char sequence to a sequence of strings around occurrences of the specified delimiters.
Splits this char sequence to a sequence of strings around occurrences of the specified delimiters.
Returns true if this char sequence starts with the specified character.
Returns true if this char sequence starts with the specified prefix.
Returns true if a substring of this char sequence starting at the specified offset startIndex starts with the specified prefix.
Returns true if this char sequence starts with the specified character.
Returns true if this char sequence starts with the specified prefix.
Returns true if this string starts with the specified prefix.
Returns true if a substring of this char sequence starting at the specified offset startIndex starts with the specified prefix.
Returns true if a substring of this string starting at the specified offset startIndex starts with the specified prefix.
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.
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.
Returns a subsequence of this char sequence specified by the given range of indices.
Returns a subsequence of this char sequence.
Returns a subsequence of this char sequence specified by the given range of indices.
Returns a subsequence of this char sequence.
Returns a substring of chars at indices from the specified range of this char sequence.
Returns a substring specified by the given range of indices.
Returns a substring of chars from a range of this char sequence starting at the startIndex and ending right before the endIndex.
Returns a substring of chars at indices from the specified range of this char sequence.
Returns a substring of this string that starts at the specified startIndex and continues to the end of the string.
Returns a substring specified by the given range of indices.
Returns a substring of chars from a range of this char sequence starting at the startIndex and ending right before the endIndex.
Returns the substring of this string starting at the startIndex and ending right before the endIndex.
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.
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.
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.
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.
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.
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.
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.
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.
Returns the sum of all values produced by selector function applied to each character in the char sequence.
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.
Returns a string containing the first n characters from this string, or the entire string if this string is shorter.
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.
Returns a string containing the last n characters from this string, or the entire string if this string is shorter.
Encodes the contents of this string using the specified character set and returns the resulting byte array.
Returns a CharArray containing characters of this string.
Copies characters from this string into the destination character array and returns that array.
Appends all characters to the given destination collection.
Parses the string as a Double number and returns the result or null if the string is not a valid representation of a number.
Parses the string as a Float number and returns the result or null if the string is not a valid representation of a number.
Returns a copy of this string converted to lower case using the rules of the default locale.
Returns a copy of this string converted to lower case using the rules of the default locale.
Returns a copy of this string converted to lower case using the rules of the specified locale.
Returns a new MutableList filled with all characters of this char sequence.
Returns a new SortedSet of all characters.
Returns a copy of this string converted to upper case using the rules of the default locale.
Returns a copy of this string converted to upper case using the rules of the default locale.
Returns a copy of this string converted to upper case using the rules of the specified locale.
Returns a sub sequence of this char sequence having leading and trailing whitespace removed.
Returns a string having leading and trailing whitespace removed.
Returns a sub sequence of this char sequence having leading and trailing characters from the chars array removed.
Returns a sub sequence of this char sequence having leading and trailing characters matching the predicate removed.
Returns a string having leading and trailing characters from the chars array removed.
Returns a string having leading and trailing characters matching the predicate removed.
Returns a sub sequence of this char sequence having leading and trailing whitespace removed.
Returns a string having leading and trailing whitespace removed.
Returns a sub sequence of this char sequence having leading and trailing characters from the chars array removed.
Returns a sub sequence of this char sequence having leading and trailing characters matching the predicate removed.
Returns a string having leading and trailing characters from the chars array removed.
Returns a string having leading and trailing characters matching the predicate removed.
Returns a sub sequence of this char sequence having trailing whitespace removed.
Returns a string having trailing whitespace removed.
Returns a sub sequence of this char sequence having trailing characters from the chars array removed.
Returns a sub sequence of this char sequence having trailing characters matching the predicate removed.
Returns a string having trailing characters from the chars array removed.
Returns a string having trailing characters matching the predicate removed.
Returns a sub sequence of this char sequence having trailing whitespace removed.
Returns a string having trailing whitespace removed.
Returns a sub sequence of this char sequence having trailing characters from the chars array removed.
Returns a sub sequence of this char sequence having trailing characters matching the predicate removed.
Returns a string having trailing characters from the chars array removed.
Returns a string having trailing characters matching the predicate removed.
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).
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).
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).
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).
Returns a sub sequence of this char sequence having leading whitespace removed.
Returns a string having leading whitespace removed.
Returns a sub sequence of this char sequence having leading characters from the chars array removed.
Returns a sub sequence of this char sequence having leading characters matching the predicate removed.
Returns a string having leading characters from the chars array removed.
Returns a string having leading characters matching the predicate removed.
Returns a sub sequence of this char sequence having leading whitespace removed.
Returns a string having leading whitespace removed.
Returns a sub sequence of this char sequence having leading characters from the chars array removed.
Returns a sub sequence of this char sequence having leading characters matching the predicate removed.
Returns a string having leading characters from the chars array removed.
Returns a string having leading characters matching the predicate removed.
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.
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.
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.