String

String

String()

Initializes a newly created String object so that it represents an empty character sequence. Note that use of this constructor is unnecessary since Strings are immutable.

String

String(bytes: ByteArray!)

Constructs a new String by decoding the specified array of bytes using the platform's default charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

The behavior of this constructor when the given bytes are not valid in the default charset is unspecified. The class should be used when more control over the decoding process is required.

String

String(
    ascii: ByteArray!, 
    hibyte: Int)

Deprecated: This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a , charset name, or that use the platform's default charset.

Allocates a new String containing characters constructed from an array of 8-bit integer values. Each character c in the resulting string is constructed from the corresponding component b in the byte array such that:

<b><i>c</i></b>== (char)(((hibyte & 0xff) << 8)
                          | (<b><i>b</i></b>& 0xff))
  

String

String(
    bytes: ByteArray!, 
    offset: Int, 
    length: Int)

Constructs a new String by decoding the specified subarray of bytes using the platform's default charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the subarray.

The behavior of this constructor when the given bytes are not valid in the default charset is unspecified. The class should be used when more control over the decoding process is required.

String

String(
    ascii: ByteArray!, 
    hibyte: Int, 
    offset: Int, 
    count: Int)

Deprecated: This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the String constructors that take a , charset name, or that use the platform's default charset.

Allocates a new String constructed from a subarray of an array of 8-bit integer values.

The offset argument is the index of the first byte of the subarray, and the count argument specifies the length of the subarray.

Each byte in the subarray is converted to a char as specified in the String(byte[],int) constructor.

String

String(
    bytes: ByteArray!, 
    offset: Int, 
    length: Int, 
    charsetName: String)

String

String(
    bytes: ByteArray!, 
    offset: Int, 
    length: Int, 
    charset: Charset)

Constructs a new String by decoding the specified subarray of bytes using the specified charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the subarray.

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The class should be used when more control over the decoding process is required.

String

String(
    bytes: ByteArray!, 
    charsetName: String)

Constructs a new String by decoding the specified array of bytes using the specified charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

The behavior of this constructor when the given bytes are not valid in the given charset is unspecified. The class should be used when more control over the decoding process is required.

String

String(
    bytes: ByteArray!, 
    charset: Charset)

Constructs a new String by decoding the specified array of bytes using the specified charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The class should be used when more control over the decoding process is required.

String

String(value: CharArray!)

Allocates a new String so that it represents the sequence of characters currently contained in the character array argument. The contents of the character array are copied; subsequent modification of the character array does not affect the newly created string.

String

String(
    value: CharArray!, 
    offset: Int, 
    count: Int)

Allocates a new String that contains characters from a subarray of the character array argument. The offset argument is the index of the first character of the subarray and the count argument specifies the length of the subarray. The contents of the subarray are copied; subsequent modification of the character array does not affect the newly created string.

String

String(
    codePoints: IntArray!, 
    offset: Int, 
    count: Int)

Allocates a new String that contains characters from a subarray of the Unicode code point array argument. The offset argument is the index of the first code point of the subarray and the count argument specifies the length of the subarray. The contents of the subarray are converted to chars; subsequent modification of the int array does not affect the newly created string.

String

String(original: String)

Initializes a newly created String object so that it represents the same sequence of characters as the argument; in other words, the newly created string is a copy of the argument string. Unless an explicit copy of original is needed, use of this constructor is unnecessary since Strings are immutable.

String

String(buffer: StringBuffer)

Allocates a new string that contains the sequence of characters currently contained in the string buffer argument. The contents of the string buffer are copied; subsequent modification of the string buffer does not affect the newly created string.

String

String(builder: StringBuilder)

Allocates a new string that contains the sequence of characters currently contained in the string builder argument. The contents of the string builder are copied; subsequent modification of the string builder does not affect the newly created string.

This constructor is provided to ease migration to StringBuilder. Obtaining a string from a string builder via the toString method is likely to run faster and is generally preferred.

chars

fun chars(): IntStream

Returns a stream of int zero-extending the char values from this sequence. Any char which maps to a surrogate code point is passed through uninterpreted.

codePointAt

fun codePointAt(index: Int): Int

Returns the character (Unicode code point) at the specified index. The index refers to char values (Unicode code units) and ranges from 0 to length()- 1.

If the char value specified at the given index is in the high-surrogate range, the following index is less than the length of this String, and the char value at the following index is in the low-surrogate range, then the supplementary code point corresponding to this surrogate pair is returned. Otherwise, the char value at the given index is returned.

codePointBefore

fun codePointBefore(index: Int): Int

Returns the character (Unicode code point) before the specified index. The index refers to char values (Unicode code units) and ranges from 1 to length.

If the char value at (index - 1) is in the low-surrogate range, (index - 2) is not negative, and the char value at (index - 2) is in the high-surrogate range, then the supplementary code point value of the surrogate pair is returned. If the char value at index - 1 is an unpaired low-surrogate or a high-surrogate, the surrogate value is returned.

codePointCount

fun codePointCount(
    beginIndex: Int, 
    endIndex: Int
): Int

Returns the number of Unicode code points in the specified text range of this String. The text range begins at the specified beginIndex and extends to the char at index endIndex - 1. Thus the length (in chars) of the text range is endIndex-beginIndex. Unpaired surrogates within the text range count as one code point each.

codePoints

fun codePoints(): IntStream

Returns a stream of code point values from this sequence. Any surrogate pairs encountered in the sequence are combined as if by Character.toCodePoint and the result is passed to the stream. Any other code units, including ordinary BMP characters, unpaired surrogates, and undefined code units, are zero-extended to int values which are then passed to the stream.

compareTo

fun compareTo(other: String): Int

Compares two strings lexicographically. The comparison is based on the Unicode value of each character in the strings. The character sequence represented by this String object is compared lexicographically to the character sequence represented by the argument string. The result is a negative integer if this String object lexicographically precedes the argument string. The result is a positive integer if this String object lexicographically follows the argument string. The result is zero if the strings are equal; returns 0 exactly when the equals(java.lang.Object) method would return true.

This is the definition of lexicographic ordering. If two strings are different, then either they have different characters at some index that is a valid index for both strings, or their lengths are different, or both. If they have different characters at one or more index positions, let k be the smallest such index; then the string whose character at position k has the smaller value, as determined by using the < operator, lexicographically precedes the other string. In this case, compareTo returns the difference of the two character values at position k in the two string -- that is, the value:

this.charAt(k)-anotherString.charAt(k)
  

this.length()-anotherString.length()
  

For finer-grained String comparison, refer to java.text.Collator.

compareToIgnoreCase

fun compareToIgnoreCase(str: String): Int

Compares two strings lexicographically, ignoring case differences. This method returns an integer whose sign is that of calling compareTo with normalized versions of the strings where case differences have been eliminated by calling Character.toLowerCase(Character.toUpperCase(character)) on each character.

Note that this method does not take locale into account, and will result in an unsatisfactory ordering for certain locales. The java.text.Collator class provides locale-sensitive comparison.

concat

fun concat(str: String): String

Concatenates the specified string to the end of this string.

If the length of the argument string is 0, then this String object is returned. Otherwise, a String object is returned that represents a character sequence that is the concatenation of the character sequence represented by this String object and the character sequence represented by the argument string.

Examples:

"cares".concat("s") returns "caress"
  "to".concat("get").concat("her") returns "together"
  

contains

fun contains(s: CharSequence): Boolean

Returns true if and only if this string contains the specified sequence of char values.

contentEquals

fun contentEquals(cs: CharSequence): Boolean

Compares this string to the specified CharSequence. The result is true if and only if this String represents the same sequence of char values as the specified sequence. Note that if the CharSequence is a StringBuffer then the method synchronizes on it.

For finer-grained String comparison, refer to java.text.Collator.

contentEquals

fun contentEquals(sb: StringBuffer): Boolean

Compares this string to the specified StringBuffer. The result is true if and only if this String represents the same sequence of characters as the specified StringBuffer. This method synchronizes on the StringBuffer.

For finer-grained String comparison, refer to java.text.Collator.

copyValueOf

static fun copyValueOf(data: CharArray!): String

Equivalent to valueOf(char[]).

copyValueOf

static fun copyValueOf(
    data: CharArray!, 
    offset: Int, 
    count: Int
): String

Equivalent to valueOf(char[],int,int).

endsWith

fun endsWith(suffix: String): Boolean

Tests if this string ends with the specified suffix.

equals

fun equals(other: Any?): Boolean

Compares this string to the specified object. The result is true if and only if the argument is not null and is a String object that represents the same sequence of characters as this object.

For finer-grained String comparison, refer to java.text.Collator.

equalsIgnoreCase

fun equalsIgnoreCase(anotherString: String?): Boolean

Compares this String to another String, ignoring case considerations. Two strings are considered equal ignoring case if they are of the same length and corresponding characters in the two strings are equal ignoring case.

Two characters c1 and c2 are considered the same ignoring case if at least one of the following is true:

• The two characters are the same (as compared by the == operator)
• Calling Character.toLowerCase(Character.toUpperCase(char)) on each character produces the same result

Note that this method does not take locale into account, and will result in unsatisfactory results for certain locales. The java.text.Collator class provides locale-sensitive comparison.

format

static fun format(
    format: String, 
    vararg args: Any!
): String

Returns a formatted string using the specified format string and arguments.

The locale always used is the one returned by Locale.getDefault(Locale.Category) with FORMAT category specified.

format

static fun format(
    l: Locale, 
    format: String, 
    vararg args: Any!
): String

Returns a formatted string using the specified locale, format string, and arguments.

formatted

fun formatted(vararg args: Any!): String

Formats using this string as the format string, and the supplied arguments.

get

fun get(index: Int): Char

Returns the char value at the specified index. An index ranges from 0 to length() - 1. The first char value of the sequence is at index 0, the next at index 1, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

getBytes

fun getBytes(): ByteArray!

Encodes this String into a sequence of bytes using the platform's default charset, storing the result into a new byte array.

The behavior of this method when this string cannot be encoded in the default charset is unspecified. The class should be used when more control over the encoding process is required.

getBytes

fun getBytes(
    srcBegin: Int, 
    srcEnd: Int, 
    dst: ByteArray!, 
    dstBegin: Int
): Unit

Deprecated: This method does not properly convert characters into bytes. As of JDK 1.1, the preferred way to do this is via the getBytes() method, which uses the platform's default charset.

Copies characters from this string into the destination byte array. Each byte receives the 8 low-order bits of the corresponding character. The eight high-order bits of each character are not copied and do not participate in the transfer in any way.

The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1. The total number of characters to be copied is srcEnd-srcBegin. The characters, converted to bytes, are copied into the subarray of dst starting at index dstBegin and ending at index:

dstBegin + (srcEnd-srcBegin) - 1
  

getBytes

fun getBytes(charsetName: String): ByteArray!

Encodes this String into a sequence of bytes using the named charset, storing the result into a new byte array.

The behavior of this method when this string cannot be encoded in the given charset is unspecified. The class should be used when more control over the encoding process is required.

getBytes

fun getBytes(charset: Charset): ByteArray!

Encodes this String into a sequence of bytes using the given charset, storing the result into a new byte array.

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement byte array. The java.nio.charset.CharsetEncoder class should be used when more control over the encoding process is required.

getChars

fun getChars(
    srcBegin: Int, 
    srcEnd: Int, 
    dst: CharArray!, 
    dstBegin: Int
): Unit

Copies characters from this string into the destination character array.

The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1 (thus the total number of characters to be copied is srcEnd-srcBegin). The characters are copied into the subarray of dst starting at index dstBegin and ending at index:

dstBegin + (srcEnd-srcBegin) - 1
  

hashCode

fun hashCode(): Int

Returns a hash code for this string. The hash code for a String object is computed as

s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
  

indent

fun indent(n: Int): String

Adjusts the indentation of each line of this string based on the value of n, and normalizes line termination characters.

This string is conceptually separated into lines using String.lines(). Each line is then adjusted as described below and then suffixed with a line feed "\n" (U+000A). The resulting lines are then concatenated and returned.

If n > 0 then n spaces (U+0020) are inserted at the beginning of each line.

If n < 0 then up to n white space characters are removed from the beginning of each line. If a given line does not contain sufficient white space then all leading white space characters are removed. Each white space character is treated as a single character. In particular, the tab character "\t" (U+0009) is considered a single character; it is not expanded.

If n == 0 then the line remains unchanged. However, line terminators are still normalized.

indexOf

fun indexOf(ch: Int): Int

Returns the index within this string of the first occurrence of the specified character. If a character with value ch occurs in the character sequence represented by this String object, then the index (in Unicode code units) of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that:

this.charAt(<i>k</i>) == ch
  

this.codePointAt(<i>k</i>) == ch
  

indexOf

fun indexOf(
    ch: Int, 
    fromIndex: Int
): Int

Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.

If a character with value ch occurs in the character sequence represented by this String object at an index no smaller than fromIndex, then the index of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that:

(this.charAt(<i>k</i>) == ch) <code>&amp;&amp;</code>(<i>k</i>>= fromIndex)
  

(this.codePointAt(<i>k</i>) == ch) <code>&amp;&amp;</code>(<i>k</i>>= fromIndex)
  

There is no restriction on the value of fromIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned.

All indices are specified in char values (Unicode code units).

indexOf

fun indexOf(str: String): Int

Returns the index within this string of the first occurrence of the specified substring.

The returned index is the smallest value k for which:

<code>this.startsWith(str, k)
  </code>

indexOf

fun indexOf(
    str: String, 
    fromIndex: Int
): Int

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

The returned index is the smallest value k for which:

<code>k &gt;= Math.min(fromIndex, this.length()) &amp;&amp;
                    this.startsWith(str, k)
  </code>

intern

fun intern(): String

Returns a canonical representation for the string object.

A pool of strings, initially empty, is maintained privately by the class String.

When the intern method is invoked, if the pool already contains a string equal to this String object as determined by the equals(java.lang.Object) method, then the string from the pool is returned. Otherwise, this String object is added to the pool and a reference to this String object is returned.

It follows that for any two strings s and t, s.intern() == t.intern() is true if and only if s.equals(t) is true.

All literal strings and string-valued constant expressions are interned. String literals are defined in section 3.10.5 of the The Java™ Language Specification.

isBlank

fun isBlank(): Boolean

Returns true if the string is empty or contains only white space codepoints, otherwise false.

isEmpty

fun isEmpty(): Boolean

Returns true if, and only if, length() is 0.

join

static fun join(
    delimiter: CharSequence, 
    vararg elements: CharSequence!
): String

Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter. For example,

<code>String message = String.join("-", "Java", "is", "cool");
      // message returned is: "Java-is-cool"
  </code>

join

static fun join(
    delimiter: CharSequence, 
    elements: MutableIterable<CharSequence!>
): String

Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter. For example,

<code>List&lt;String&gt; strings = List.of("Java", "is", "cool");
      String message = String.join(" ", strings);
      //message returned is: "Java is cool"
 
      Set&lt;String&gt; strings =
          new LinkedHashSet&lt;&gt;(List.of("Java", "is", "very", "cool"));
      String message = String.join("-", strings);
      //message returned is: "Java-is-very-cool"
  </code>

lastIndexOf

fun lastIndexOf(ch: Int): Int

Returns the index within this string of the last occurrence of the specified character. For values of ch in the range from 0 to 0xFFFF (inclusive), the index (in Unicode code units) returned is the largest value k such that:

this.charAt(<i>k</i>) == ch
  

this.codePointAt(<i>k</i>) == ch
  

lastIndexOf

fun lastIndexOf(
    ch: Int, 
    fromIndex: Int
): Int

Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. For values of ch in the range from 0 to 0xFFFF (inclusive), the index returned is the largest value k such that:

(this.charAt(<i>k</i>) == ch) <code>&amp;&amp;</code>(<i>k</i><= fromIndex)
  

(this.codePointAt(<i>k</i>) == ch) <code>&amp;&amp;</code>(<i>k</i><= fromIndex)
  

All indices are specified in char values (Unicode code units).

lastIndexOf

fun lastIndexOf(str: String): Int

Returns the index within this string of the last occurrence of the specified substring. The last occurrence of the empty string "" is considered to occur at the index value this.length().

The returned index is the largest value k for which:

<code>this.startsWith(str, k)
  </code>

lastIndexOf

fun lastIndexOf(
    str: String, 
    fromIndex: Int
): Int

Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.

The returned index is the largest value k for which:

<code>k &lt;= Math.min(fromIndex, this.length()) &amp;&amp;
                    this.startsWith(str, k)
  </code>

lines

fun lines(): Stream<String!>

Returns a stream of lines extracted from this string, separated by line terminators.

A line terminator is one of the following: a line feed character "\n" (U+000A), a carriage return character "\r" (U+000D), or a carriage return followed immediately by a line feed "\r\n" (U+000D U+000A).

A line is either a sequence of zero or more characters followed by a line terminator, or it is a sequence of one or more characters followed by the end of the string. A line does not include the line terminator.

The stream returned by this method contains the lines from this string in the order in which they occur.

matches

fun matches(regex: String): Boolean

Tells whether or not this string matches the given regular expression.

An invocation of this method of the form str.matches(regex) yields exactly the same result as the expression

offsetByCodePoints

fun offsetByCodePoints(
    index: Int, 
    codePointOffset: Int
): Int

Returns the index within this String that is offset from the given index by codePointOffset code points. Unpaired surrogates within the text range given by index and codePointOffset count as one code point each.

regionMatches

fun regionMatches(
    ignoreCase: Boolean, 
    toffset: Int, 
    other: String, 
    ooffset: Int, 
    len: Int
): Boolean

Tests if two string regions are equal.

A substring of this String object is compared to a substring of the argument other. The result is true if these substrings represent character sequences that are the same, ignoring case if and only if ignoreCase is true. The substring of this String object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

• toffset is negative.
• ooffset is negative.
• toffset+len is greater than the length of this String object.
• ooffset+len is greater than the length of the other argument.
• ignoreCase is false and there is some nonnegative integer k less than len such that:

  this.charAt(toffset+k) != other.charAt(ooffset+k)
    

• ignoreCase is true and there is some nonnegative integer k less than len such that:

  Character.toLowerCase(Character.toUpperCase(this.charAt(toffset+k))) !=
   Character.toLowerCase(Character.toUpperCase(other.charAt(ooffset+k)))
    

Note that this method does not take locale into account, and will result in unsatisfactory results for certain locales when ignoreCase is true. The java.text.Collator class provides locale-sensitive comparison.

regionMatches

fun regionMatches(
    toffset: Int, 
    other: String, 
    ooffset: Int, 
    len: Int
): Boolean

Tests if two string regions are equal.

A substring of this String object is compared to a substring of the argument other. The result is true if these substrings represent identical character sequences. The substring of this String object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

• toffset is negative.
• ooffset is negative.
• toffset+len is greater than the length of this String object.
• ooffset+len is greater than the length of the other argument.
• There is some nonnegative integer k less than len such that: this.charAt(toffset + k) != other.charAt(ooffset + k)

Note that this method does not take locale into account. The java.text.Collator class provides locale-sensitive comparison.

repeat

fun repeat(count: Int): String

Returns a string whose value is the concatenation of this string repeated count times.

If this string is empty or count is zero then the empty string is returned.

replace

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

Returns a string resulting from replacing all occurrences of oldChar in this string with newChar.

If the character oldChar does not occur in the character sequence represented by this String object, then a reference to this String object is returned. Otherwise, a String object is returned that represents a character sequence identical to the character sequence represented by this String object, except that every occurrence of oldChar is replaced by an occurrence of newChar.

Examples:

"mesquite in your cellar".replace('e', 'o')
          returns "mosquito in your collar"
  "the war of baronets".replace('r', 'y')
          returns "the way of bayonets"
  "sparring with a purple porpoise".replace('p', 't')
          returns "starring with a turtle tortoise"
  "JonL".replace('q', 'x') returns "JonL" (no change)
  

replace

fun replace(
    target: CharSequence, 
    replacement: CharSequence
): String

Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the string "aaa" will result in "ba" rather than "ab".

replaceAll

fun replaceAll(
    regex: String, 
    replacement: String
): String

Replaces each substring of this string that matches the given regular expression with the given replacement.

An invocation of this method of the form str.replaceAll(regex, repl) yields exactly the same result as the expression

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see java.util.regex.Matcher#replaceAll. Use java.util.regex.Matcher#quoteReplacement to suppress the special meaning of these characters, if desired.

replaceFirst

fun replaceFirst(
    regex: String, 
    replacement: String
): String

Replaces the first substring of this string that matches the given regular expression with the given replacement.

An invocation of this method of the form str.replaceFirst(regex, repl) yields exactly the same result as the expression

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see java.util.regex.Matcher#replaceFirst. Use java.util.regex.Matcher#quoteReplacement to suppress the special meaning of these characters, if desired.

split

fun split(regex: String): Array<String!>

Splits this string around matches of the given regular expression.

This method works as if by invoking the two-argument split method with the given expression and a limit argument of zero. Trailing empty strings are therefore not included in the resulting array.

The string "boo:and:foo", for example, yields the following results with these expressions:

split

fun split(
    regex: String, 
    limit: Int
): Array<String!>

Splits this string around matches of the given regular expression.

The array returned by this method contains each substring of this string that is terminated by another substring that matches the given expression or is terminated by the end of the string. The substrings in the array are in the order in which they occur in this string. If the expression does not match any part of the input then the resulting array has just one element, namely this string.

When there is a positive-width match at the beginning of this string then an empty leading substring is included at the beginning of the resulting array. A zero-width match at the beginning however never produces such empty leading substring.

The limit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array.

• If the limit is positive then the pattern will be applied at most limit - 1 times, the array's length will be no greater than limit, and the array's last entry will contain all input beyond the last matched delimiter.
• If the limit is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded.
• If the limit is negative then the pattern will be applied as many times as possible and the array can have any length.

The string "boo:and:foo", for example, yields the following results with these parameters:

An invocation of this method of the form str.split(regex, n) yields the same result as the expression

startsWith

fun startsWith(prefix: String): Boolean

Tests if this string starts with the specified prefix.

startsWith

fun startsWith(
    prefix: String, 
    toffset: Int
): Boolean

Tests if the substring of this string beginning at the specified index starts with the specified prefix.

this.substring(toffset).startsWith(prefix)
           

strip

fun strip(): String

Returns a string whose value is this string, with all leading and trailing white space removed.

If this String object represents an empty string, or if all code points in this string are white space, then an empty string is returned.

Otherwise, returns a substring of this string beginning with the first code point that is not a white space up to and including the last code point that is not a white space.

This method may be used to strip white space from the beginning and end of a string.

stripIndent

fun stripIndent(): String

Returns a string whose value is this string, with incidental removed from the beginning and end of every line.

Incidental white space is often present in a text block to align the content with the opening delimiter. For example, in the following code, dots represent incidental white space:

String html = """
  ..............<html>
  ..............    <body>
  ..............        <p>Hello, world</p>
  ..............    </body>
  ..............</html>
  ..............""";
  

|<html>
  |    <body>
  |        <p>Hello, world</p>
  |    </body>
  |</html>
  

Then, the minimum indentation (min) is determined as follows:

• For each non-blank line (as defined by String.isBlank()), the leading white space characters are counted.

• The leading white space characters on the last line are also counted even if blank.

The min value is the smallest of these counts.

For each non-blank line, min leading white space characters are removed, and any trailing space characters are removed. Blank lines are replaced with the empty string.

Finally, the lines are joined into a new string, using the LF character "\n" (U+000A) to separate lines.

stripLeading

fun stripLeading(): String

Returns a string whose value is this string, with all leading white space removed.

If this String object represents an empty string, or if all code points in this string are white space, then an empty string is returned.

Otherwise, returns a substring of this string beginning with the first code point that is not a white space up to to and including the last code point of this string.

This method may be used to trim white space from the beginning of a string.

stripTrailing

fun stripTrailing(): String

Returns a string whose value is this string, with all trailing white space removed.

If this String object represents an empty string, or if all characters in this string are white space, then an empty string is returned.

Otherwise, returns a substring of this string beginning with the first code point of this string up to and including the last code point that is not a white space.

This method may be used to trim white space from the end of a string.

subSequence

fun subSequence(
    startIndex: Int, 
    endIndex: Int
): CharSequence

Returns a character sequence that is a subsequence of this sequence.

An invocation of this method of the form

str.subSequence(begin, end)

str.substring(begin, end)

substring

fun substring(beginIndex: Int): String

Returns a string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

Examples:

"unhappy".substring(2) returns "happy"
  "Harbison".substring(3) returns "bison"
  "emptiness".substring(9) returns "" (an empty string)
  

substring

fun substring(
    beginIndex: Int, 
    endIndex: Int
): String

Returns a string that is a substring of this string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex.

Examples:

"hamburger".substring(4, 8) returns "urge"
  "smiles".substring(1, 5) returns "mile"
  

toCharArray

fun toCharArray(): CharArray!

Converts this string to a new character array.

toLowerCase

fun toLowerCase(): String

Converts all of the characters in this String to lower case using the rules of the default locale. This is equivalent to calling toLowerCase(Locale.getDefault()).

Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "TITLE".toLowerCase() in a Turkish locale returns "t\u005Cu0131tle", where '\u005Cu0131' is the LATIN SMALL LETTER DOTLESS I character. To obtain correct results for locale insensitive strings, use toLowerCase(Locale.ROOT).

toLowerCase

fun toLowerCase(locale: Locale): String

Converts all of the characters in this String to lower case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting String may be a different length than the original String.

Examples of lowercase mappings are in the following table:

toString

fun toString(): String

This object (which is already a string!) is itself returned.

toUpperCase

fun toUpperCase(): String

Converts all of the characters in this String to upper case using the rules of the default locale. This method is equivalent to toUpperCase(Locale.getDefault()).

Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "title".toUpperCase() in a Turkish locale returns "T\u005Cu0130TLE", where '\u005Cu0130' is the LATIN CAPITAL LETTER I WITH DOT ABOVE character. To obtain correct results for locale insensitive strings, use toUpperCase(Locale.ROOT).

toUpperCase

fun toUpperCase(locale: Locale): String

Converts all of the characters in this String to upper case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting String may be a different length than the original String.

Examples of locale-sensitive and 1:M case mappings are in the following table.

transform

fun <R : Any!> transform(f: Function<in String!, out R>): R

This method allows the application of a function to this string. The function should expect a single String argument and produce an R result.

Any exception thrown by f.apply() will be propagated to the caller.

translateEscapes

fun translateEscapes(): String

Returns a string whose value is this string, with escape sequences translated as if in a string literal.

Escape sequences are translated as follows;

trim

fun trim(): String

Returns a string whose value is this string, with all leading and trailing space removed, where space is defined as any character whose codepoint is less than or equal to 'U+0020' (the space character).

If this String object represents an empty character sequence, or the first and last characters of character sequence represented by this String object both have codes that are not space (as defined above), then a reference to this String object is returned.

Otherwise, if all characters in this string are space (as defined above), then a String object representing an empty string is returned.

Otherwise, let k be the index of the first character in the string whose code is not a space (as defined above) and let m be the index of the last character in the string whose code is not a space (as defined above). A String object is returned, representing the substring of this string that begins with the character at index k and ends with the character at index m-that is, the result of this.substring(k, m + 1).

This method may be used to trim space (as defined above) from the beginning and end of a string.

valueOf

static fun valueOf(b: Boolean): String

Returns the string representation of the boolean argument.

valueOf

static fun valueOf(c: Char): String

Returns the string representation of the char argument.

valueOf

static fun valueOf(data: CharArray!): String

Returns the string representation of the char array argument. The contents of the character array are copied; subsequent modification of the character array does not affect the returned string.