Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Fields](https://developer.android.com/reference/java/lang/String#lfields) \| [Ctors](https://developer.android.com/reference/java/lang/String#pubctors) \| [Methods](https://developer.android.com/reference/java/lang/String#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/lang/String#inhmethods)

# String


`
public

final

class
String
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/lang/CharSequence,

https://developer.android.com/reference/java/lang/Comparable<https://developer.android.com/reference/java/lang/String>,

https://developer.android.com/reference/java/io/Serializable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.lang.String |

<br />

*** ** * ** ***

The `String` class represents character strings. All
string literals in Java programs, such as `"abc"`, are
implemented as instances of this class.


Strings are constant; their values cannot be changed after they
are created. String buffers support mutable strings.
Because String objects are immutable they can be shared. For example:
>
> ```
>      String str = "abc";
>  
> ```


is equivalent to:
>
> ```
>      char data[] = {'a', 'b', 'c'};
>      String str = new String(data);
>  
> ```


Here are some more examples of how strings can be used:
>
> ```
>      System.out.println("abc");
>      String cde = "cde";
>      System.out.println("abc" + cde);
>      String c = "abc".substring(2,3);
>      String d = cde.substring(1, 2);
>  
> ```


The class `String` includes methods for examining
individual characters of the sequence, for comparing strings, for
searching strings, for extracting substrings, and for creating a
copy of a string with all characters translated to uppercase or to
lowercase. Case mapping is based on the Unicode Standard version
specified by the `https://developer.android.com/reference/java/lang/Character` class.


The Java language provides special support for the string
concatenation operator ( + ), and for conversion of
other objects to strings. For additional information on string
concatenation and conversion, see *The Java™ Language Specification*.

Unless otherwise noted, passing a `null` argument to a constructor
or method in this class will cause a `https://developer.android.com/reference/java/lang/NullPointerException` to be
thrown.

A `String` represents a string in the UTF-16 format
in which *supplementary characters* are represented by *surrogate
pairs* (see the section [Unicode
Character Representations](https://developer.android.com/reference/java/lang/Character#unicode) in the `Character` class for
more information).
Index values refer to `char` code units, so a supplementary
character uses two positions in a `String`.

The `String` class provides methods for dealing with
Unicode code points (i.e., characters), in addition to those for
dealing with Unicode code units (i.e., `char` values).

Unless otherwise noted, methods for comparing Strings do not take locale
into account. The `https://developer.android.com/reference/java/text/Collator` class provides methods for
finer-grain, locale-sensitive String comparison.
**See also:**

- `https://developer.android.com/reference/java/lang/Object#toString()`
- `https://developer.android.com/reference/java/lang/StringBuffer`
- `https://developer.android.com/reference/java/lang/StringBuilder`
- `https://developer.android.com/reference/java/nio/charset/Charset`

## Summary

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/java/util/Comparator<https://developer.android.com/reference/java/lang/String>` | `https://developer.android.com/reference/java/lang/String#CASE_INSENSITIVE_ORDER` A Comparator that orders `String` objects as by `compareToIgnoreCase`. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/lang/String#String()() ` Initializes a newly created `String` object so that it represents an empty character sequence. |
| ` https://developer.android.com/reference/java/lang/String#String(byte[])(byte[] bytes) ` Constructs a new `String` by decoding the specified array of bytes using the platform's default charset. |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20int)(byte[] ascii, int hibyte) ` *This constructor is 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 `https://developer.android.com/reference/java/nio/charset/Charset`, charset name, or that use the platform's default charset.* |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int)(byte[] bytes, int offset, int length) ` Constructs a new `String` by decoding the specified subarray of bytes using the platform's default charset. |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20int)(byte[] ascii, int hibyte, int offset, int count) ` *This constructor is 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 `https://developer.android.com/reference/java/nio/charset/Charset`, charset name, or that use the platform's default charset.* |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.lang.String)(byte[] bytes, int offset, int length, https://developer.android.com/reference/java/lang/String charsetName) ` |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.nio.charset.Charset)(byte[] bytes, int offset, int length, https://developer.android.com/reference/java/nio/charset/Charset charset) ` Constructs a new `String` by decoding the specified subarray of bytes using the specified [charset](https://developer.android.com/reference/java/nio/charset/Charset). |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20java.lang.String)(byte[] bytes, https://developer.android.com/reference/java/lang/String charsetName) ` Constructs a new `String` by decoding the specified array of bytes using the specified [charset](https://developer.android.com/reference/java/nio/charset/Charset). |
| ` https://developer.android.com/reference/java/lang/String#String(byte[],%20java.nio.charset.Charset)(byte[] bytes, https://developer.android.com/reference/java/nio/charset/Charset charset) ` Constructs a new `String` by decoding the specified array of bytes using the specified [charset](https://developer.android.com/reference/java/nio/charset/Charset). |
| ` https://developer.android.com/reference/java/lang/String#String(char[])(char[] value) ` Allocates a new `String` so that it represents the sequence of characters currently contained in the character array argument. |
| ` https://developer.android.com/reference/java/lang/String#String(char[],%20int,%20int)(char[] value, int offset, int count) ` Allocates a new `String` that contains characters from a subarray of the character array argument. |
| ` https://developer.android.com/reference/java/lang/String#String(int[],%20int,%20int)(int[] codePoints, int offset, int count) ` Allocates a new `String` that contains characters from a subarray of the [Unicode code point](https://developer.android.com/reference/java/lang/Character#unicode) array argument. |
| ` https://developer.android.com/reference/java/lang/String#String(java.lang.String)(https://developer.android.com/reference/java/lang/String original) ` 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. |
| ` https://developer.android.com/reference/java/lang/String#String(java.lang.StringBuffer)(https://developer.android.com/reference/java/lang/StringBuffer buffer) ` Allocates a new string that contains the sequence of characters currently contained in the string buffer argument. |
| ` https://developer.android.com/reference/java/lang/String#String(java.lang.StringBuilder)(https://developer.android.com/reference/java/lang/StringBuilder builder) ` Allocates a new string that contains the sequence of characters currently contained in the string builder argument. |

| ### Public methods ||
|---|---|
| ` char` | ` https://developer.android.com/reference/java/lang/String#charAt(int)(int index) ` Returns the `char` value at the specified index. |
| ` https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/String#chars()() ` Returns a stream of `int` zero-extending the `char` values from this sequence. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#codePointAt(int)(int index) ` Returns the character (Unicode code point) at the specified index. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#codePointBefore(int)(int index) ` Returns the character (Unicode code point) before the specified index. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#codePointCount(int,%20int)(int beginIndex, int endIndex) ` Returns the number of Unicode code points in the specified text range of this `String`. |
| ` https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/String#codePoints()() ` Returns a stream of code point values from this sequence. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#compareTo(java.lang.String)(https://developer.android.com/reference/java/lang/String anotherString) ` Compares two strings lexicographically. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#compareToIgnoreCase(java.lang.String)(https://developer.android.com/reference/java/lang/String str) ` Compares two strings lexicographically, ignoring case differences. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#concat(java.lang.String)(https://developer.android.com/reference/java/lang/String str) ` Concatenates the specified string to the end of this string. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#contains(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence s) ` Returns true if and only if this string contains the specified sequence of char values. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#contentEquals(java.lang.StringBuffer)(https://developer.android.com/reference/java/lang/StringBuffer sb) ` Compares this string to the specified `StringBuffer`. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#contentEquals(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence cs) ` Compares this string to the specified `CharSequence`. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#copyValueOf(char[],%20int,%20int)(char[] data, int offset, int count) ` Equivalent to `https://developer.android.com/reference/java/lang/String#valueOf(char[],%20int,%20int)`. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#copyValueOf(char[])(char[] data) ` Equivalent to `https://developer.android.com/reference/java/lang/String#valueOf(char[])`. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#endsWith(java.lang.String)(https://developer.android.com/reference/java/lang/String suffix) ` Tests if this string ends with the specified suffix. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object anObject) ` Compares this string to the specified object. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#equalsIgnoreCase(java.lang.String)(https://developer.android.com/reference/java/lang/String anotherString) ` Compares this `String` to another `String`, ignoring case considerations. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#format(java.lang.String,%20java.lang.Object[])(https://developer.android.com/reference/java/lang/String format, https://developer.android.com/reference/java/lang/Object args) ` Returns a formatted string using the specified format string and arguments. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#format(java.util.Locale,%20java.lang.String,%20java.lang.Object[])(https://developer.android.com/reference/java/util/Locale l, https://developer.android.com/reference/java/lang/String format, https://developer.android.com/reference/java/lang/Object args) ` Returns a formatted string using the specified locale, format string, and arguments. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#formatted(java.lang.Object[])(https://developer.android.com/reference/java/lang/Object args) ` Formats using this string as the format string, and the supplied arguments. |
| ` byte[]` | ` https://developer.android.com/reference/java/lang/String#getBytes(java.lang.String)(https://developer.android.com/reference/java/lang/String charsetName) ` Encodes this `String` into a sequence of bytes using the named charset, storing the result into a new byte array. |
| ` byte[]` | ` https://developer.android.com/reference/java/lang/String#getBytes()() ` Encodes this `String` into a sequence of bytes using the platform's default charset, storing the result into a new byte array. |
| ` byte[]` | ` https://developer.android.com/reference/java/lang/String#getBytes(java.nio.charset.Charset)(https://developer.android.com/reference/java/nio/charset/Charset charset) ` Encodes this `String` into a sequence of bytes using the given [charset](https://developer.android.com/reference/java/nio/charset/Charset), storing the result into a new byte array. |
| ` void` | ` https://developer.android.com/reference/java/lang/String#getBytes(int,%20int,%20byte[],%20int)(int srcBegin, int srcEnd, byte[] dst, int dstBegin) ` *This method was deprecated in API level 15. This method does not properly convert characters into bytes. As of JDK 1.1, the preferred way to do this is via the `https://developer.android.com/reference/java/lang/String#getBytes()` method, which uses the platform's default charset.* |
| ` void` | ` https://developer.android.com/reference/java/lang/String#getChars(int,%20int,%20char[],%20int)(int srcBegin, int srcEnd, char[] dst, int dstBegin) ` Copies characters from this sequence into the given destination array. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#hashCode()() ` Returns a hash code for this string. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#indent(int)(int n) ` Adjusts the indentation of each line of this string based on the value of `n`, and normalizes line termination characters. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(java.lang.String,%20int,%20int)(https://developer.android.com/reference/java/lang/String str, int beginIndex, int endIndex) ` Returns the index of the first occurrence of the specified substring within the specified index range of `this` string. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(int,%20int)(int ch, int fromIndex) ` Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(int,%20int,%20int)(int ch, int beginIndex, int endIndex) ` Returns the index within this string of the first occurrence of the specified character, starting the search at `beginIndex` and stopping before `endIndex`. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(java.lang.String)(https://developer.android.com/reference/java/lang/String str) ` Returns the index within this string of the first occurrence of the specified substring. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(int)(int ch) ` Returns the index within this string of the first occurrence of the specified character. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#indexOf(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String str, int fromIndex) ` Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#intern()() ` Returns a canonical representation for the string object. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#isBlank()() ` Returns `true` if the string is empty or contains only `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` codepoints, otherwise `false`. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#isEmpty()() ` Returns `true` if, and only if, `https://developer.android.com/reference/java/lang/String#length()` is `0`. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#join(java.lang.CharSequence,%20java.lang.CharSequence[])(https://developer.android.com/reference/java/lang/CharSequence delimiter, https://developer.android.com/reference/java/lang/CharSequence elements) ` Returns a new String composed of copies of the `CharSequence elements` joined together with a copy of the specified `delimiter`. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#join(java.lang.CharSequence,%20java.lang.Iterable<?%20extends%20java.lang.CharSequence>)(https://developer.android.com/reference/java/lang/CharSequence delimiter, https://developer.android.com/reference/java/lang/Iterable<? extends https://developer.android.com/reference/java/lang/CharSequence> elements) ` Returns a new `String` composed of copies of the `CharSequence elements` joined together with a copy of the specified `delimiter`. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#lastIndexOf(int)(int ch) ` Returns the index within this string of the last occurrence of the specified character. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#lastIndexOf(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String str, int fromIndex) ` Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#lastIndexOf(java.lang.String)(https://developer.android.com/reference/java/lang/String str) ` Returns the index within this string of the last occurrence of the specified substring. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#lastIndexOf(int,%20int)(int ch, int fromIndex) ` Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. |
| ` int` | ` https://developer.android.com/reference/java/lang/String#length()() ` Returns the length of this string. |
| ` https://developer.android.com/reference/java/util/stream/Stream<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/java/lang/String#lines()() ` Returns a stream of lines extracted from this string, separated by line terminators. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#matches(java.lang.String)(https://developer.android.com/reference/java/lang/String regex) ` Tells whether or not this string matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum). |
| ` int` | ` https://developer.android.com/reference/java/lang/String#offsetByCodePoints(int,%20int)(int index, int codePointOffset) ` Returns the index within this `String` that is offset from the given `index` by `codePointOffset` code points. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#regionMatches(boolean,%20int,%20java.lang.String,%20int,%20int)(boolean ignoreCase, int toffset, https://developer.android.com/reference/java/lang/String other, int ooffset, int len) ` Tests if two string regions are equal. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#regionMatches(int,%20java.lang.String,%20int,%20int)(int toffset, https://developer.android.com/reference/java/lang/String other, int ooffset, int len) ` Tests if two string regions are equal. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#repeat(int)(int count) ` Returns a string whose value is the concatenation of this string repeated `count` times. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#replace(java.lang.CharSequence,%20java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence target, https://developer.android.com/reference/java/lang/CharSequence replacement) ` Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#replace(char,%20char)(char oldChar, char newChar) ` Returns a string resulting from replacing all occurrences of `oldChar` in this string with `newChar`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#replaceAll(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String regex, https://developer.android.com/reference/java/lang/String replacement) ` Replaces each substring of this string that matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum) with the given replacement. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#replaceFirst(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String regex, https://developer.android.com/reference/java/lang/String replacement) ` Replaces the first substring of this string that matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum) with the given replacement. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#split(java.lang.String)(https://developer.android.com/reference/java/lang/String regex) ` Splits this string around matches of the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum). |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#split(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String regex, int limit) ` Splits this string around matches of the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum). |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#splitWithDelimiters(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String regex, int limit) ` Splits this string around matches of the given regular expression and returns both the strings and the matching delimiters. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#startsWith(java.lang.String)(https://developer.android.com/reference/java/lang/String prefix) ` Tests if this string starts with the specified prefix. |
| ` boolean` | ` https://developer.android.com/reference/java/lang/String#startsWith(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String prefix, int toffset) ` Tests if the substring of this string beginning at the specified index starts with the specified prefix. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#strip()() ` Returns a string whose value is this string, with all leading and trailing `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` removed. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#stripIndent()() ` Returns a string whose value is this string, with incidental [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) removed from the beginning and end of every line. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#stripLeading()() ` Returns a string whose value is this string, with all leading `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` removed. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#stripTrailing()() ` Returns a string whose value is this string, with all trailing `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` removed. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/java/lang/String#subSequence(int,%20int)(int beginIndex, int endIndex) ` Returns a character sequence that is a subsequence of this sequence. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#substring(int,%20int)(int beginIndex, int endIndex) ` Returns a string that is a substring of this string. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#substring(int)(int beginIndex) ` Returns a string that is a substring of this string. |
| ` char[]` | ` https://developer.android.com/reference/java/lang/String#toCharArray()() ` Converts this string to a new character array. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#toLowerCase()() ` Converts all of the characters in this `String` to lower case using the rules of the default locale. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#toLowerCase(java.util.Locale)(https://developer.android.com/reference/java/util/Locale locale) ` Converts all of the characters in this `String` to lower case using the rules of the given `Locale`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#toString()() ` This object (which is already a string!) is itself returned. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#toUpperCase(java.util.Locale)(https://developer.android.com/reference/java/util/Locale locale) ` Converts all of the characters in this `String` to upper case using the rules of the given `Locale`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#toUpperCase()() ` Converts all of the characters in this `String` to upper case using the rules of the default locale. |
| ` <R> R` | ` https://developer.android.com/reference/java/lang/String#transform(java.util.function.Function<?%20super%20java.lang.String,?%20extends%20R>)(https://developer.android.com/reference/java/util/function/Function<? super https://developer.android.com/reference/java/lang/String, ? extends R> f) ` This method allows the application of a function to `this` string. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#translateEscapes()() ` Returns a string whose value is this string, with escape sequences translated as if in a string literal. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#trim()() ` 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). |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(boolean)(boolean b) ` Returns the string representation of the `boolean` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(double)(double d) ` Returns the string representation of the `double` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(char[],%20int,%20int)(char[] data, int offset, int count) ` Returns the string representation of a specific subarray of the `char` array argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(float)(float f) ` Returns the string representation of the `float` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(int)(int i) ` Returns the string representation of the `int` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(char)(char c) ` Returns the string representation of the `char` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(long)(long l) ` Returns the string representation of the `long` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Returns the string representation of the `Object` argument. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/String#valueOf(char[])(char[] data) ` Returns the string representation of the `char` array argument. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/java/lang/CharSequence ` |---|---| | ` abstract char` | ` https://developer.android.com/reference/java/lang/CharSequence#charAt(int)(int index) ` Returns the `char` value at the specified index. | | ` default https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/CharSequence#chars()() ` Returns a stream of `int` zero-extending the `char` values from this sequence. | | ` default https://developer.android.com/reference/java/util/stream/IntStream` | ` https://developer.android.com/reference/java/lang/CharSequence#codePoints()() ` Returns a stream of code point values from this sequence. | | ` static int` | ` https://developer.android.com/reference/java/lang/CharSequence#compare(java.lang.CharSequence,%20java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence cs1, https://developer.android.com/reference/java/lang/CharSequence cs2) ` Compares two `CharSequence` instances lexicographically. | | ` default void` | ` https://developer.android.com/reference/java/lang/CharSequence#getChars(int,%20int,%20char[],%20int)(int srcBegin, int srcEnd, char[] dst, int dstBegin) ` Copies characters from this sequence into the given destination array. | | ` default boolean` | ` https://developer.android.com/reference/java/lang/CharSequence#isEmpty()() ` Returns `true` if this character sequence is empty. | | ` abstract int` | ` https://developer.android.com/reference/java/lang/CharSequence#length()() ` Returns the length of this character sequence. | | ` abstract https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/java/lang/CharSequence#subSequence(int,%20int)(int start, int end) ` Returns a `CharSequence` that is a subsequence of this sequence. | | ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/CharSequence#toString()() ` Returns a string containing the characters in this sequence in the same order as this sequence. | ||
| From interface ` https://developer.android.com/reference/java/lang/Comparable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/java/lang/Comparable#compareTo(T)(https://developer.android.com/reference/java/lang/String o) ` Compares this object with the specified object for order. | ||

## Fields

### CASE_INSENSITIVE_ORDER

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Comparator<String> CASE_INSENSITIVE_ORDER
```

A Comparator that orders `String` objects as by
`compareToIgnoreCase`. This comparator is serializable.


Note that this Comparator does *not* take locale into account,
and will result in an unsatisfactory ordering for certain locales.
The `https://developer.android.com/reference/java/text/Collator` class provides locale-sensitive comparison.

<br />

**See also:**

- `https://developer.android.com/reference/java/text/Collator`

## Public constructors

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes)
```

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 `https://developer.android.com/reference/java/nio/charset/CharsetDecoder` class should be used when more control
over the decoding process is required.

<br />

| Parameters ||
|---|---|
| `bytes` | `byte`: The bytes to be decoded into characters <br /> |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] ascii, 
                int hibyte)
```


**This constructor is 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 `https://developer.android.com/reference/java/nio/charset/Charset`, 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:

> ```
>      *c* == (char)(((hibyte & 0xff) << 8)
>                          | (*b* & 0xff))
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `ascii` | `byte`: The bytes to be converted to characters <br /> |
| `hibyte` | `int`: The top 8 bits of each 16-bit Unicode code unit <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.lang.String)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.nio.charset.Charset)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20java.lang.String)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20java.nio.charset.Charset)`
- `https://developer.android.com/reference/java/lang/String#String(byte[])`

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes, 
                int offset, 
                int length)
```

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 `https://developer.android.com/reference/java/nio/charset/CharsetDecoder` class should be used when more control
over the decoding process is required.

<br />

| Parameters ||
|---|---|
| `bytes` | `byte`: The bytes to be decoded into characters <br /> |
| `offset` | `int`: The index of the first byte to decode <br /> |
| `length` | `int`: The number of bytes to decode <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `offset` is negative, `length` is negative, or `offset` is greater than `bytes.length - length` |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] ascii, 
                int hibyte, 
                int offset, 
                int count)
```


**This constructor is 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 `https://developer.android.com/reference/java/nio/charset/Charset`, 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 `https://developer.android.com/reference/java/lang/String#String(byte[],%20int)` constructor.

<br />

| Parameters ||
|---|---|
| `ascii` | `byte`: The bytes to be converted to characters <br /> |
| `hibyte` | `int`: The top 8 bits of each 16-bit Unicode code unit <br /> |
| `offset` | `int`: The initial offset <br /> |
| `count` | `int`: The length <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `offset` is negative, `count` is negative, or `offset` is greater than `ascii.length - count` |

**See also:**

- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.lang.String)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int,%20java.nio.charset.Charset)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20int,%20int)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20java.lang.String)`
- `https://developer.android.com/reference/java/lang/String#String(byte[],%20java.nio.charset.Charset)`
- `https://developer.android.com/reference/java/lang/String#String(byte[])`

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes, 
                int offset, 
                int length, 
                String charsetName)
```

<br />

<br />

| Parameters ||
|---|---|
| `bytes` | `byte` <br /> |
| `offset` | `int` <br /> |
| `length` | `int` <br /> |
| `charsetName` | `String` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/UnsupportedEncodingException` |   |

### String

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes, 
                int offset, 
                int length, 
                Charset charset)
```

Constructs a new `String` by decoding the specified subarray of
bytes using the specified [charset](https://developer.android.com/reference/java/nio/charset/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 `https://developer.android.com/reference/java/nio/charset/CharsetDecoder` class should be used when more control
over the decoding process is required.

<br />

| Parameters ||
|---|---|
| `bytes` | `byte`: The bytes to be decoded into characters <br /> |
| `offset` | `int`: The index of the first byte to decode <br /> |
| `length` | `int`: The number of bytes to decode <br /> |
| `charset` | `Charset`: The [charset](https://developer.android.com/reference/java/nio/charset/Charset) to be used to decode the `bytes` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `offset` is negative, `length` is negative, or `offset` is greater than `bytes.length - length` |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes, 
                String charsetName)
```

Constructs a new `String` by decoding the specified array of bytes
using the specified [charset](https://developer.android.com/reference/java/nio/charset/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 `https://developer.android.com/reference/java/nio/charset/CharsetDecoder` class should be used when more control
over the decoding process is required.

<br />

| Parameters ||
|---|---|
| `bytes` | `byte`: The bytes to be decoded into characters <br /> |
| `charsetName` | `String`: The name of a supported [charset](https://developer.android.com/reference/java/nio/charset/Charset) <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/UnsupportedEncodingException` | If the named charset is not supported |

### String

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (byte[] bytes, 
                Charset charset)
```

Constructs a new `String` by decoding the specified array of
bytes using the specified [charset](https://developer.android.com/reference/java/nio/charset/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 `https://developer.android.com/reference/java/nio/charset/CharsetDecoder` class should be used when more control
over the decoding process is required.

<br />

| Parameters ||
|---|---|
| `bytes` | `byte`: The bytes to be decoded into characters <br /> |
| `charset` | `Charset`: The [charset](https://developer.android.com/reference/java/nio/charset/Charset) to be used to decode the `bytes` <br /> |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (char[] value)
```

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.

<br />

| Parameters ||
|---|---|
| `value` | `char`: The initial value of the string <br /> |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (char[] value, 
                int offset, 
                int count)
```

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.

<br />

| Parameters ||
|---|---|
| `value` | `char`: Array that is the source of characters <br /> |
| `offset` | `int`: The initial offset <br /> |
| `count` | `int`: The length <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `offset` is negative, `count` is negative, or `offset` is greater than `value.length - count` |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (int[] codePoints, 
                int offset, 
                int count)
```

Allocates a new `String` that contains characters from a subarray
of the [Unicode code point](https://developer.android.com/reference/java/lang/Character#unicode) 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
`char`s; subsequent modification of the `int` array does not
affect the newly created string.

<br />

| Parameters ||
|---|---|
| `codePoints` | `int`: Array that is the source of Unicode code points <br /> |
| `offset` | `int`: The initial offset <br /> |
| `count` | `int`: The length <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | If any invalid Unicode code point is found in `codePoints` |
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If `offset` is negative, `count` is negative, or `offset` is greater than `codePoints.length - count` |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (String original)
```

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.

<br />

| Parameters ||
|---|---|
| `original` | `String`: A `String` <br /> |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (StringBuffer buffer)
```

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.

<br />

| Parameters ||
|---|---|
| `buffer` | `StringBuffer`: A `StringBuffer` <br /> |

### String

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String (StringBuilder builder)
```

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.

<br />

| Parameters ||
|---|---|
| `builder` | `StringBuilder`: A `StringBuilder` <br /> |

## Public methods

### charAt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public char charAt (int index)
```

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](https://developer.android.com/reference/java/lang/Character#unicode), the surrogate
value is returned.

<br />

| Parameters ||
|---|---|
| `index` | `int`: the index of the `char` value. <br /> |

| Returns ||
|---|---|
| `char` | the `char` value at the specified index of this string. The first `char` value is at index `0`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if the `index` argument is negative or not less than the length of this string. |

### chars

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IntStream chars ()
```

Returns a stream of `int` zero-extending the `char` values
from this sequence. Any char which maps to a [surrogate code
point](https://reference/java/lang/Character.html#unicode) is passed through uninterpreted.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/stream/IntStream` | an IntStream of char values from this sequence <br /> |

### codePointAt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int codePointAt (int index)
```

Returns the character (Unicode code point) at the specified
index. The index refers to `char` values
(Unicode code units) and ranges from `0` to
`https://developer.android.com/reference/java/lang/String#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.

<br />

| Parameters ||
|---|---|
| `index` | `int`: the index to the `char` values <br /> |

| Returns ||
|---|---|
| `int` | the code point value of the character at the `index` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if the `index` argument is negative or not less than the length of this string. |

### codePointBefore

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int codePointBefore (int index)
```

Returns the character (Unicode code point) before the specified
index. The index refers to `char` values
(Unicode code units) and ranges from `1` to `https://developer.android.com/reference/java/lang/CharSequence#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.

<br />

| Parameters ||
|---|---|
| `index` | `int`: the index following the code point that should be returned <br /> |

| Returns ||
|---|---|
| `int` | the Unicode code point value before the given index. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if the `index` argument is less than 1 or greater than the length of this string. |

### codePointCount

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int codePointCount (int beginIndex, 
                int endIndex)
```

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 `char`s) of the text range is
`endIndex-beginIndex`. Unpaired surrogates within
the text range count as one code point each.

<br />

| Parameters ||
|---|---|
| `beginIndex` | `int`: the index to the first `char` of the text range. <br /> |
| `endIndex` | `int`: the index after the last `char` of the text range. <br /> |

| Returns ||
|---|---|
| `int` | the number of Unicode code points in the specified text range <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if the `beginIndex` is negative, or `endIndex` is larger than the length of this `String`, or `beginIndex` is larger than `endIndex`. |

### codePoints

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public IntStream codePoints ()
```

Returns a stream of code point values from this sequence. Any surrogate
pairs encountered in the sequence are combined as if by [Character.toCodePoint](https://developer.android.com/reference/java/lang/Character#toCodePoint(char,%20char)) 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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/stream/IntStream` | an IntStream of Unicode code points from this sequence <br /> |

### compareTo

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int compareTo (String anotherString)
```

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; `compareTo` returns `0` exactly when
the `https://developer.android.com/reference/java/lang/String#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)
>  
> ```
If there is no index position at which they differ, then the shorter string lexicographically precedes the longer string. In this case, `compareTo` returns the difference of the lengths of the strings -- that is, the value:
>
> ```
>  this.length()-anotherString.length()
>  
> ```

For finer-grained String comparison, refer to
`https://developer.android.com/reference/java/text/Collator`.

<br />

| Parameters ||
|---|---|
| `anotherString` | `String`: the `String` to be compared. <br /> |

| Returns ||
|---|---|
| `int` | the value `0` if the argument string is equal to this string; a value less than `0` if this string is lexicographically less than the string argument; and a value greater than `0` if this string is lexicographically greater than the string argument. <br /> |

### compareToIgnoreCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int compareToIgnoreCase (String str)
```

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 `https://developer.android.com/reference/java/text/Collator` class provides locale-sensitive comparison.

<br />

| Parameters ||
|---|---|
| `str` | `String`: the `String` to be compared. <br /> |

| Returns ||
|---|---|
| `int` | a negative integer, zero, or a positive integer as the specified String is greater than, equal to, or less than this String, ignoring case considerations. <br /> |

**See also:**

- `https://developer.android.com/reference/java/text/Collator`

### concat

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String concat (String str)
```

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"
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the `String` that is concatenated to the end of this `String`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string that represents the concatenation of this object's characters followed by the string argument's characters. <br /> |

### contains

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean contains (CharSequence s)
```

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

<br />

| Parameters ||
|---|---|
| `s` | `CharSequence`: the sequence to search for <br /> |

| Returns ||
|---|---|
| `boolean` | true if this string contains `s`, false otherwise <br /> |

### contentEquals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean contentEquals (StringBuffer sb)
```

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
`https://developer.android.com/reference/java/text/Collator`.

<br />

| Parameters ||
|---|---|
| `sb` | `StringBuffer`: The `StringBuffer` to compare this `String` against <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this `String` represents the same sequence of characters as the specified `StringBuffer`, `false` otherwise <br /> |

### contentEquals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean contentEquals (CharSequence cs)
```

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
`https://developer.android.com/reference/java/text/Collator`.

<br />

| Parameters ||
|---|---|
| `cs` | `CharSequence`: The sequence to compare this `String` against <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this `String` represents the same sequence of char values as the specified sequence, `false` otherwise <br /> |

### copyValueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String copyValueOf (char[] data, 
                int offset, 
                int count)
```

Equivalent to `https://developer.android.com/reference/java/lang/String#valueOf(char[],%20int,%20int)`.

<br />

| Parameters ||
|---|---|
| `data` | `char`: the character array. <br /> |
| `offset` | `int`: initial offset of the subarray. <br /> |
| `count` | `int`: length of the subarray. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a `String` that contains the characters of the specified subarray of the character array. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `offset` is negative, or `count` is negative, or `offset+count` is larger than `data.length`. |

### copyValueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String copyValueOf (char[] data)
```

Equivalent to `https://developer.android.com/reference/java/lang/String#valueOf(char[])`.

<br />

| Parameters ||
|---|---|
| `data` | `char`: the character array. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a `String` that contains the characters of the character array. <br /> |

### endsWith

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean endsWith (String suffix)
```

Tests if this string ends with the specified suffix.

<br />

| Parameters ||
|---|---|
| `suffix` | `String`: the suffix. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the character sequence represented by the argument is a suffix of the character sequence represented by this object; `false` otherwise. Note that the result will be `true` if the argument is the empty string or is equal to this `String` object as determined by the `https://developer.android.com/reference/java/lang/String#equals(java.lang.Object)` method. <br /> |

### equals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object anObject)
```

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
`https://developer.android.com/reference/java/text/Collator`.

<br />

| Parameters ||
|---|---|
| `anObject` | `Object`: The object to compare this `String` against <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the given object represents a `String` equivalent to this string, `false` otherwise <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#compareTo(java.lang.String)`
- `https://developer.android.com/reference/java/lang/String#equalsIgnoreCase(java.lang.String)`

### equalsIgnoreCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equalsIgnoreCase (String anotherString)
```

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
`https://developer.android.com/reference/java/text/Collator` class provides locale-sensitive comparison.

<br />

| Parameters ||
|---|---|
| `anotherString` | `String`: The `String` to compare this `String` against <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the argument is not `null` and it represents an equivalent `String` ignoring case; `false` otherwise <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#equals(java.lang.Object)`

### format

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String format (String format, 
                Object... args)
```

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

The locale always used is the one returned by `https://developer.android.com/reference/java/util/Locale#getDefault(java.util.Locale.Category)` with
`https://developer.android.com/reference/java/util/Locale.Category#FORMAT` category specified.

<br />

| Parameters ||
|---|---|
| `format` | `String`: A [format string](https://developer.android.com/reference/java/util/Formatter.html#syntax) <br /> |
| `args` | `Object`: Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java™ Virtual Machine Specification. The behaviour on a `null` argument depends on the [conversion](https://developer.android.com/reference/java/util/Formatter.html#syntax). <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A formatted string <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/IllegalFormatException` | If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the [Details](https://developer.android.com/reference/java/util/Formatter.html#detail) section of the formatter class specification. |

**See also:**

- `https://developer.android.com/reference/java/util/Formatter`

### format

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String format (Locale l, 
                String format, 
                Object... args)
```

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

<br />

| Parameters ||
|---|---|
| `l` | `Locale`: The [locale](https://developer.android.com/reference/java/util/Locale) to apply during formatting. If `l` is `null` then no localization is applied. <br /> |
| `format` | `String`: A [format string](https://developer.android.com/reference/java/util/Formatter.html#syntax) <br /> |
| `args` | `Object`: Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java™ Virtual Machine Specification. The behaviour on a `null` argument depends on the [conversion](https://developer.android.com/reference/java/util/Formatter.html#syntax). <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A formatted string <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/IllegalFormatException` | If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the [Details](https://developer.android.com/reference/java/util/Formatter.html#detail) section of the formatter class specification |

**See also:**

- `https://developer.android.com/reference/java/util/Formatter`

### formatted

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String formatted (Object... args)
```

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

<br />

##### Implementation Requirements:

- This method is equivalent to `String.format(this, args)`.

| Parameters ||
|---|---|
| `args` | `Object`: Arguments referenced by the format specifiers in this string. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A formatted string <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#format(java.lang.String,%20java.lang.Object[])`
- `https://developer.android.com/reference/java/util/Formatter`

### getBytes

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getBytes (String charsetName)
```

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 `https://developer.android.com/reference/java/nio/charset/CharsetEncoder` class should be used when more control
over the encoding process is required.

<br />

| Parameters ||
|---|---|
| `charsetName` | `String`: The name of a supported [charset](https://developer.android.com/reference/java/nio/charset/Charset) <br /> |

| Returns ||
|---|---|
| `byte[]` | The resultant byte array <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/UnsupportedEncodingException` | If the named charset is not supported |

### getBytes

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getBytes ()
```

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 `https://developer.android.com/reference/java/nio/charset/CharsetEncoder` class should be used when more control
over the encoding process is required.

<br />

| Returns ||
|---|---|
| `byte[]` | The resultant byte array <br /> |

### getBytes

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getBytes (Charset charset)
```

Encodes this `String` into a sequence of bytes using the given
[charset](https://developer.android.com/reference/java/nio/charset/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
`https://developer.android.com/reference/java/nio/charset/CharsetEncoder` class should be used when more
control over the encoding process is required.

<br />

| Parameters ||
|---|---|
| `charset` | `Charset`: The [Charset](https://developer.android.com/reference/java/nio/charset/Charset) to be used to encode the `String` <br /> |

| Returns ||
|---|---|
| `byte[]` | The resultant byte array <br /> |

### getBytes

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
15](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void getBytes (int srcBegin, 
                int srcEnd, 
                byte[] dst, 
                int dstBegin)
```


**This method was deprecated
in API level 15.**   

This method does not properly convert characters into
bytes. As of JDK 1.1, the preferred way to do this is via the
`https://developer.android.com/reference/java/lang/String#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
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `srcBegin` | `int`: Index of the first character in the string to copy <br /> |
| `srcEnd` | `int`: Index after the last character in the string to copy <br /> |
| `dst` | `byte`: The destination array <br /> |
| `dstBegin` | `int`: The start offset in the destination array <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | If any of the following is true: - `srcBegin` is negative - `srcBegin` is greater than `srcEnd` - `srcEnd` is greater than the length of this String - `dstBegin` is negative - `dstBegin+(srcEnd-srcBegin)` is larger than `dst.length` |

### getChars

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void getChars (int srcBegin, 
                int srcEnd, 
                char[] dst, 
                int dstBegin)
```

Copies characters from this sequence into the given destination array.
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 are copied into the subarray of `dst` starting
at index `dstBegin` and ending at index:

    dstbegin + (srcEnd-srcBegin) - 1
     
<br />

<br />

| Parameters ||
|---|---|
| `srcBegin` | `int`: <br /> |
| `srcEnd` | `int`: <br /> |
| `dst` | `char`: <br /> |
| `dstBegin` | `int`: <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` |   |

### hashCode

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

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]
>  
> ```
using `int` arithmetic, where `s[i]` is the *i*th character of the string, `n` is the length of the string, and `^` indicates exponentiation. (The hash value of the empty string is zero.)

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### indent

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String indent (int n)
```

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
`https://developer.android.com/reference/java/lang/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](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) are removed
from the beginning of each line. If a given line does not contain
sufficient white space then all leading
[white space characters](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) 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.

<br />

| Parameters ||
|---|---|
| `n` | `int`: number of leading [white space characters](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) to add or remove <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | string with indentation adjusted and line endings normalized <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#lines()`
- `https://developer.android.com/reference/java/lang/String#isBlank()`
- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### indexOf

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (String str, 
                int beginIndex, 
                int endIndex)
```

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

This method returns the same result as the one of the invocation

    s.substring(beginIndex, endIndex).indexOf(str) + beginIndex
     
if the index returned by `https://developer.android.com/reference/java/lang/String#indexOf(java.lang.String)` is non-negative, and returns -1 otherwise. (No substring is instantiated, though.)

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the substring to search for. <br /> |
| `beginIndex` | `int`: the index to start the search from (included). <br /> |
| `endIndex` | `int`: the index to stop the search at (excluded). <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the specified substring within the specified index range, or `-1` if there is no such occurrence. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/StringIndexOutOfBoundsException` | if `beginIndex` is negative, or `endIndex` is larger than the length of this `String` object, or `beginIndex` is larger than `endIndex`. |

### indexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (int ch, 
                int fromIndex)
```

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(k) == ch) && (k >= fromIndex)
>      
is true. For other values of `ch`, it is the smallest value *k* such that:
>
>      (this.codePointAt(k) == ch) && (k >= fromIndex)
>      
is true. In either case, if no such character occurs in this string at or after position `fromIndex`, then `-1` is returned.


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).

<br />

| Parameters ||
|---|---|
| `ch` | `int`: a character (Unicode code point). <br /> |
| `fromIndex` | `int`: the index to start the search from. <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to `fromIndex`, or `-1` if the character does not occur. <br /> |

### indexOf

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (int ch, 
                int beginIndex, 
                int endIndex)
```

Returns the index within this string of the first occurrence of the
specified character, starting the search at `beginIndex` and
stopping before `endIndex`.

If a character with value `ch` occurs in the
character sequence represented by this `String`
object at an index no smaller than `beginIndex` but smaller than
`endIndex`, 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(k) == ch) && (beginIndex <= k < endIndex)
>  
> ```
is true. For other values of `ch`, it is the smallest value *k* such that:
>
> ```
>  (this.codePointAt(k) == ch) && (beginIndex <= k < endIndex)
>  
> ```
is true. In either case, if no such character occurs in this string at or after position `beginIndex` and before position `endIndex`, then `-1` is returned.

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

<br />

| Parameters ||
|---|---|
| `ch` | `int`: a character (Unicode code point). <br /> |
| `beginIndex` | `int`: the index to start the search from (included). <br /> |
| `endIndex` | `int`: the index to stop the search at (excluded). <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to `beginIndex` and less than `endIndex`, or `-1` if the character does not occur. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/StringIndexOutOfBoundsException` | if `beginIndex` is negative, or `endIndex` is larger than the length of this `String` object, or `beginIndex` is larger than `endIndex`. |

### indexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (String str)
```

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

The returned index is the smallest value `k` for which:

    this.startsWith(str, k)
     
If no such value of `k` exists, then `-1` is returned.

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the substring to search for. <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the specified substring, or `-1` if there is no such occurrence. <br /> |

### indexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (int ch)
```

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(k) == ch
>  
> ```
is true. For other values of `ch`, it is the smallest value *k* such that:
>
> ```
>  this.codePointAt(k) == ch
>  
> ```
is true. In either case, if no such character occurs in this string, then `-1` is returned.

<br />

<br />

| Parameters ||
|---|---|
| `ch` | `int`: a character (Unicode code point). <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the character in the character sequence represented by this object, or `-1` if the character does not occur. <br /> |

### indexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (String str, 
                int fromIndex)
```

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:

    k >= Math.min(fromIndex, this.length()) &&
                       this.startsWith(str, k)
     
If no such value of `k` exists, then `-1` is returned.

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the substring to search for. <br /> |
| `fromIndex` | `int`: the index from which to start the search. <br /> |

| Returns ||
|---|---|
| `int` | the index of the first occurrence of the specified substring, starting at the specified index, or `-1` if there is no such occurrence. <br /> |

### intern

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String intern ()
```

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 `https://developer.android.com/reference/java/lang/String#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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string that has the same contents as this string, but is guaranteed to be from a pool of unique strings. <br /> |

### isBlank

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isBlank ()
```

Returns `true` if the string is empty or contains only
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` codepoints,
otherwise `false`.

<br />

| Returns ||
|---|---|
| `boolean` | `true` if the string is empty or contains only `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` codepoints, otherwise `false` <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### isEmpty

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isEmpty ()
```

Returns `true` if, and only if, `https://developer.android.com/reference/java/lang/String#length()` is `0`.

<br />

| Returns ||
|---|---|
| `boolean` | `true` if `https://developer.android.com/reference/java/lang/String#length()` is `0`, otherwise `false` <br /> |

### join

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String join (CharSequence delimiter, 
                CharSequence... elements)
```

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

> For example,
>
>     String message = String.join("-", "Java", "is", "cool");
>          // message returned is: "Java-is-cool"
>      
Note that if an element is null, then `"null"` is added.

<br />

<br />

| Parameters ||
|---|---|
| `delimiter` | `CharSequence`: the delimiter that separates each element <br /> |
| `elements` | `CharSequence`: the elements to join together. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a new `String` that is composed of the `elements` separated by the `delimiter` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | If `delimiter` or `elements` is `null` |

**See also:**

- `https://developer.android.com/reference/java/util/StringJoiner`

### join

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String join (CharSequence delimiter, 
                Iterable<? extends CharSequence> elements)
```

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

> For example,
>
>     List<String> strings = List.of("Java", "is", "cool");
>          String message = String.join(" ", strings);
>          //message returned is: "Java is cool"
>
>          Set<String> strings =
>              new LinkedHashSet<>(List.of("Java", "is", "very", "cool"));
>          String message = String.join("-", strings);
>          //message returned is: "Java-is-very-cool"
>      
Note that if an individual element is `null`, then `"null"` is added.

<br />

<br />

| Parameters ||
|---|---|
| `delimiter` | `CharSequence`: a sequence of characters that is used to separate each of the `elements` in the resulting `String` <br /> |
| `elements` | `Iterable`: an `Iterable` that will have its `elements` joined together. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a new `String` that is composed from the `elements` argument <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | If `delimiter` or `elements` is `null` |

**See also:**

- `https://developer.android.com/reference/java/lang/String#join(java.lang.CharSequence,%20java.lang.CharSequence[])`
- `https://developer.android.com/reference/java/util/StringJoiner`

### lastIndexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int lastIndexOf (int ch)
```

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(k) == ch
>  
> ```
is true. For other values of `ch`, it is the largest value *k* such that:
>
> ```
>  this.codePointAt(k) == ch
>  
> ```
is true. In either case, if no such character occurs in this string, then `-1` is returned. The `String` is searched backwards starting at the last character.

<br />

<br />

| Parameters ||
|---|---|
| `ch` | `int`: a character (Unicode code point). <br /> |

| Returns ||
|---|---|
| `int` | the index of the last occurrence of the character in the character sequence represented by this object, or `-1` if the character does not occur. <br /> |

### lastIndexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int lastIndexOf (String str, 
                int fromIndex)
```

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:

    k <= Math.min(fromIndex, this.length()) &&
                       this.startsWith(str, k)
     
If no such value of `k` exists, then `-1` is returned.

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the substring to search for. <br /> |
| `fromIndex` | `int`: the index to start the search from. <br /> |

| Returns ||
|---|---|
| `int` | the index of the last occurrence of the specified substring, searching backward from the specified index, or `-1` if there is no such occurrence. <br /> |

### lastIndexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int lastIndexOf (String str)
```

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:

    this.startsWith(str, k)
     
If no such value of `k` exists, then `-1` is returned.

<br />

<br />

| Parameters ||
|---|---|
| `str` | `String`: the substring to search for. <br /> |

| Returns ||
|---|---|
| `int` | the index of the last occurrence of the specified substring, or `-1` if there is no such occurrence. <br /> |

### lastIndexOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int lastIndexOf (int ch, 
                int fromIndex)
```

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(k) == ch) && (k <= fromIndex)
>      
is true. For other values of `ch`, it is the largest value *k* such that:
>
>      (this.codePointAt(k) == ch) && (k <= fromIndex)
>      
is true. In either case, if no such character occurs in this string at or before position `fromIndex`, then `-1` is returned.

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

<br />

| Parameters ||
|---|---|
| `ch` | `int`: a character (Unicode code point). <br /> |
| `fromIndex` | `int`: the index to start the search from. There is no restriction on the value of `fromIndex`. If it is greater than or equal to the length of this string, it has the same effect as if it were equal to one less than the length of this string: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned. <br /> |

| Returns ||
|---|---|
| `int` | the index of the last occurrence of the character in the character sequence represented by this object that is less than or equal to `fromIndex`, or `-1` if the character does not occur before that point. <br /> |

### length

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int length ()
```

Returns the length of this string.
The length is equal to the number of [Unicode
code units](https://developer.android.com/reference/java/lang/Character#unicode) in the string.

<br />

| Returns ||
|---|---|
| `int` | the length of the sequence of characters represented by this object. <br /> |

### lines

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Stream<String> lines ()
```

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.

<br />

##### API Note:

- This definition of *line* implies that an empty string has zero lines and that there is no empty line following a line terminator at the end of a string.

##### Implementation Note:

- This method provides better performance than split("\\R") by supplying elements lazily and by faster search of new line terminators.

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/stream/Stream<https://developer.android.com/reference/java/lang/String>` | the stream of lines extracted from this string <br /> |

### matches

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean matches (String regex)
```

Tells whether or not this string matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum).

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

> `https://developer.android.com/reference/java/util/regex/Pattern`.`https://developer.android.com/reference/java/util/regex/Pattern#matches(java.lang.String,%20java.lang.CharSequence)`

<br />

<br />

| Parameters ||
|---|---|
| `regex` | `String`: the regular expression to which this string is to be matched <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if, and only if, this string matches the given regular expression <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/regex/PatternSyntaxException` | if the regular expression's syntax is invalid |

**See also:**

- `https://developer.android.com/reference/java/util/regex/Pattern`

### offsetByCodePoints

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int offsetByCodePoints (int index, 
                int codePointOffset)
```

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.

<br />

| Parameters ||
|---|---|
| `index` | `int`: the index to be offset <br /> |
| `codePointOffset` | `int`: the offset in code points <br /> |

| Returns ||
|---|---|
| `int` | the index within this `String` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `index` is negative or larger then the length of this `String`, or if `codePointOffset` is positive and the substring starting with `index` has fewer than `codePointOffset` code points, or if `codePointOffset` is negative and the substring before `index` has fewer than the absolute value of `codePointOffset` code points. |

### regionMatches

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean regionMatches (boolean ignoreCase, 
                int toffset, 
                String other, 
                int ooffset, 
                int len)
```

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 `https://developer.android.com/reference/java/text/Collator` class
provides locale-sensitive comparison.

<br />

| Parameters ||
|---|---|
| `ignoreCase` | `boolean`: if `true`, ignore case when comparing characters. <br /> |
| `toffset` | `int`: the starting offset of the subregion in this string. <br /> |
| `other` | `String`: the string argument. <br /> |
| `ooffset` | `int`: the starting offset of the subregion in the string argument. <br /> |
| `len` | `int`: the number of characters to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the specified subregion of this string matches the specified subregion of the string argument; `false` otherwise. Whether the matching is exact or case insensitive depends on the `ignoreCase` argument. <br /> |

### regionMatches

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean regionMatches (int toffset, 
                String other, 
                int ooffset, 
                int len)
```

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
`https://developer.android.com/reference/java/text/Collator` class provides locale-sensitive comparison.

<br />

| Parameters ||
|---|---|
| `toffset` | `int`: the starting offset of the subregion in this string. <br /> |
| `other` | `String`: the string argument. <br /> |
| `ooffset` | `int`: the starting offset of the subregion in the string argument. <br /> |
| `len` | `int`: the number of characters to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the specified subregion of this string exactly matches the specified subregion of the string argument; `false` otherwise. <br /> |

### repeat

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String repeat (int count)
```

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.

<br />

| Parameters ||
|---|---|
| `count` | `int`: number of times to repeat <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A string composed of this string repeated `count` times or the empty string if this string is empty or count is zero <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the `count` is negative. |

### replace

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String replace (CharSequence target, 
                CharSequence replacement)
```

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".

<br />

| Parameters ||
|---|---|
| `target` | `CharSequence`: The sequence of char values to be replaced <br /> |
| `replacement` | `CharSequence`: The replacement sequence of char values <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The resulting string <br /> |

### replace

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String replace (char oldChar, 
                char newChar)
```

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)
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `oldChar` | `char`: the old character. <br /> |
| `newChar` | `char`: the new character. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string derived from this string by replacing every occurrence of `oldChar` with `newChar`. <br /> |

### replaceAll

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String replaceAll (String regex, 
                String replacement)
```

Replaces each substring of this string that matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum) with the
given replacement.

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

> ``
> `https://developer.android.com/reference/java/util/regex/Pattern`.`https://developer.android.com/reference/java/util/regex/Pattern#compile(java.lang.String)`(*regex*).`https://developer.android.com/reference/java/util/regex/Pattern#matcher(java.lang.CharSequence)`(*str*).`https://developer.android.com/reference/java/util/regex/Matcher#replaceAll(java.lang.String)`(*repl*)
> ``


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
`https://developer.android.com/reference/java/util/regex/Matcher#replaceAll(java.lang.String)`.
Use `https://developer.android.com/reference/java/util/regex/Matcher#quoteReplacement(java.lang.String)` to suppress the special
meaning of these characters, if desired.

<br />

| Parameters ||
|---|---|
| `regex` | `String`: the regular expression to which this string is to be matched <br /> |
| `replacement` | `String`: the string to be substituted for each match <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The resulting `String` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/regex/PatternSyntaxException` | if the regular expression's syntax is invalid |

**See also:**

- `https://developer.android.com/reference/java/util/regex/Pattern`

### replaceFirst

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String replaceFirst (String regex, 
                String replacement)
```

Replaces the first substring of this string that matches the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum) with the
given replacement.

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

> ``
> `https://developer.android.com/reference/java/util/regex/Pattern`.`https://developer.android.com/reference/java/util/regex/Pattern#compile(java.lang.String)`(*regex*).`https://developer.android.com/reference/java/util/regex/Pattern#matcher(java.lang.CharSequence)`(*str*).`https://developer.android.com/reference/java/util/regex/Matcher#replaceFirst(java.lang.String)`(*repl*)
> ``


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
`https://developer.android.com/reference/java/util/regex/Matcher#replaceFirst(java.lang.String)`.
Use `https://developer.android.com/reference/java/util/regex/Matcher#quoteReplacement(java.lang.String)` to suppress the special
meaning of these characters, if desired.

<br />

| Parameters ||
|---|---|
| `regex` | `String`: the regular expression to which this string is to be matched <br /> |
| `replacement` | `String`: the string to be substituted for the first match <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The resulting `String` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/regex/PatternSyntaxException` | if the regular expression's syntax is invalid |

**See also:**

- `https://developer.android.com/reference/java/util/regex/Pattern`

### split

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String[] split (String regex)
```

Splits this string around matches of the given [regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum).

This method works as if by invoking the two-argument `https://developer.android.com/reference/java/lang/String#split(java.lang.String,%20int)` 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:

> | Regex | Result |
> | : | `{ "boo", "and", "foo" }` |
> | o | `{ "b", "", ":and:f" }` |
> |---|---|
> [Split examples showing regex and result]

<br />

<br />

| Parameters ||
|---|---|
| `regex` | `String`: the delimiting regular expression <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the array of strings computed by splitting this string around matches of the given regular expression <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/regex/PatternSyntaxException` | if the regular expression's syntax is invalid |

**See also:**

- `https://developer.android.com/reference/java/util/regex/Pattern`

### split

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String[] split (String regex, 
                int limit)
```

Splits this string around matches of the given
[regular expression](https://developer.android.com/reference/java/util/regex/Pattern.html#sum).

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:

> | Regex | Limit | Result |
> | : | 2 | `{ "boo", "and:foo" }` |
> | : | 5 | `{ "boo", "and", "foo" }` |
> | : | -2 | `{ "boo", "and", "foo" }` |
> | o | 5 | `{ "b", "", ":and:f", "", "" }` |
> | o | -2 | `{ "b", "", ":and:f", "", "" }` |
> | o | 0 | `{ "b", "", ":and:f" }` |
> |---|---|---|
> [Split example showing regex, limit, and result]

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

> ``
> `https://developer.android.com/reference/java/util/regex/Pattern`.`https://developer.android.com/reference/java/util/regex/Pattern#compile(java.lang.String)`(*regex*).`https://developer.android.com/reference/java/util/regex/Pattern#split(java.lang.CharSequence,%20int)`(*str*, *n*)
> ``

<br />

<br />

| Parameters ||
|---|---|
| `regex` | `String`: the delimiting regular expression <br /> |
| `limit` | `int`: the result threshold, as described above <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the array of strings computed by splitting this string around matches of the given regular expression <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/util/regex/PatternSyntaxException` | if the regular expression's syntax is invalid |

**See also:**

- `https://developer.android.com/reference/java/util/regex/Pattern`

### splitWithDelimiters

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String[] splitWithDelimiters (String regex, 
                int limit)
```

Splits this string around matches of the given regular expression and
returns both the strings and the matching delimiters.

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.
Each substring is immediately followed by the subsequence (the delimiter)
that matches the given expression, *except* for the last
substring, which is not followed by anything.
The substrings in the array and the delimiters are in the order in which
they occur in the input.
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 nor the empty delimiter.

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 2 × *limit* - 1, 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 input `"boo:::and::foo"`, for example, yields the following
results with these parameters:

| Regex | Limit | Result |
| :+ | 2 | `{ "boo", ":::", "and::foo" }` |
| :+ | 5 | `{ "boo", ":::", "and", "::", "foo" }` |
| :+ | -1 | `{ "boo", ":::", "and", "::", "foo" }` |
| o | 5 | `{ "b", "o", "", "o", ":::and::f", "o", "", "o", "" }` |
| o | -1 | `{ "b", "o", "", "o", ":::and::f", "o", "", "o", "" }` |
| o | 0 | `{ "b", "o", "", "o", ":::and::f", "o", "", "o" }` |
|---|---|---|
[Split example showing regex, limit, and result]

<br />

<br />

##### API Note:

- An invocation of this method of the form *str.*`splitWithDelimiters(`*regex*`,` *n*`)` yields the same result as the expression ``
  > `https://developer.android.com/reference/java/util/regex/Pattern`.`https://developer.android.com/reference/java/util/regex/Pattern#compile(java.lang.String)`(*regex*).`https://developer.android.com/`(*str*, *n*)
  > ``

| Parameters ||
|---|---|
| `regex` | `String`: the delimiting regular expression <br /> |
| `limit` | `int`: the result threshold, as described above <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the array of strings computed by splitting this string around matches of the given regular expression, alternating substrings and matching delimiters <br /> |

### startsWith

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean startsWith (String prefix)
```

Tests if this string starts with the specified prefix.

<br />

| Parameters ||
|---|---|
| `prefix` | `String`: the prefix. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the character sequence represented by the argument is a prefix of the character sequence represented by this string; `false` otherwise. Note also that `true` will be returned if the argument is an empty string or is equal to this `String` object as determined by the `https://developer.android.com/reference/java/lang/String#equals(java.lang.Object)` method. <br /> |

### startsWith

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean startsWith (String prefix, 
                int toffset)
```

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

<br />

| Parameters ||
|---|---|
| `prefix` | `String`: the prefix. <br /> |
| `toffset` | `int`: where to begin looking in this string. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if the character sequence represented by the argument is a prefix of the substring of this object starting at index `toffset`; `false` otherwise. The result is `false` if `toffset` is negative or greater than the length of this `String` object; otherwise the result is the same as the result of the expression ``` this.substring(toffset).startsWith(prefix) ``` <br /> |

### strip

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String strip ()
```

Returns a string whose value is this string, with all leading
and trailing `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`
removed.


If this `String` object represents an empty string,
or if all code points in this string are
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`, then an empty string
is returned.


Otherwise, returns a substring of this string beginning with the first
code point that is not a `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`
up to and including the last code point that is not a
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`.


This method may be used to strip
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` from
the beginning and end of a string.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string whose value is this string, with all leading and trailing white space removed <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### stripIndent

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String stripIndent ()
```

Returns a string whose value is this string, with incidental
[white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) removed from
the beginning and end of every line.


Incidental [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int))
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](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)):
>
> ```
>  String html = """
>  ..............<html>
>  ..............    <body>
>  ..............        <p>Hello, world</p>
>  ..............    </body>
>  ..............</html>
>  ..............""";
>  
> ```
This method treats the incidental [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) as indentation to be stripped, producing a string that preserves the relative indentation of the content. Using \| to visualize the start of each line of the string:
>
> ```
>  |<html>
>  |    <body>
>  |        <p>Hello, world</p>
>  |    </body>
>  |</html>
>  
> ```
First, the individual lines of this string are extracted. A *line* is a sequence of zero or more characters followed by either a line terminator or the end of the string. If the string has at least one line terminator, the last line consists of the characters between the last terminator and the end of the string. Otherwise, if the string has no terminators, the last line is the start of the string to the end of the string, in other words, the entire string. A line does not include the line terminator.


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

- For each non-blank line (as defined by `https://developer.android.com/reference/java/lang/String#isBlank()`),
  the leading [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int))
  characters are counted.

- The leading [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int))
  characters on the last line are also counted even if
  [blank](https://developer.android.com/reference/java/lang/String#isBlank()).

The *min* value is the smallest of these counts.


For each [non-blank](https://developer.android.com/reference/java/lang/String#isBlank()) line, *min* leading
[white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) characters are
removed, and any trailing [white
space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) characters are removed. [Blank](https://developer.android.com/reference/java/lang/String#isBlank()) 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.

<br />

##### API Note:

- This method's primary purpose is to shift a block of lines as far as possible to the left, while preserving relative indentation. Lines that were indented the least will thus have no leading [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)). The result will have the same number of line terminators as this string. If this string ends with a line terminator then the result will end with a line terminator.

##### Implementation Requirements:

- This method treats all [white space](https://developer.android.com/reference/java/lang/Character#isWhitespace(int)) characters as having equal width. As long as the indentation on every line is consistently composed of the same character sequences, then the result will be as described above.

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | string with incidental indentation removed and line terminators normalized <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#lines()`
- `https://developer.android.com/reference/java/lang/String#isBlank()`
- `https://developer.android.com/reference/java/lang/String#indent(int)`
- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### stripLeading

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String stripLeading ()
```

Returns a string whose value is this string, with all leading
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` removed.


If this `String` object represents an empty string,
or if all code points in this string are
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`, then an empty string
is returned.


Otherwise, returns a substring of this string beginning with the first
code point that is not a `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`
up to to and including the last code point of this string.


This method may be used to trim
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` from
the beginning of a string.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string whose value is this string, with all leading white space removed <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### stripTrailing

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String stripTrailing ()
```

Returns a string whose value is this string, with all trailing
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` removed.


If this `String` object represents an empty string,
or if all characters in this string are
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`, 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 `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`.


This method may be used to trim
`https://developer.android.com/reference/java/lang/Character#isWhitespace(int)` from
the end of a string.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string whose value is this string, with all trailing white space removed <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Character#isWhitespace(int)`

### subSequence

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence subSequence (int beginIndex, 
                int endIndex)
```

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

An invocation of this method of the form

> ```
>  str.subSequence(begin, end)
> ```
behaves in exactly the same way as the invocation
>
> ```
>  str.substring(begin, end)
> ```

<br />

<br />

##### API Note:

- This method is defined so that the `String` class can implement the `https://developer.android.com/reference/java/lang/CharSequence` interface.

| Parameters ||
|---|---|
| `beginIndex` | `int`: the begin index, inclusive. <br /> |
| `endIndex` | `int`: the end index, exclusive. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | the specified subsequence. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `beginIndex` or `endIndex` is negative, if `endIndex` is greater than `length()`, or if `beginIndex` is greater than `endIndex` |

### substring

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String substring (int beginIndex, 
                int endIndex)
```

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"
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `beginIndex` | `int`: the beginning index, inclusive. <br /> |
| `endIndex` | `int`: the ending index, exclusive. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the specified substring. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if the `beginIndex` is negative, or `endIndex` is larger than the length of this `String` object, or `beginIndex` is larger than `endIndex`. |

### substring

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String substring (int beginIndex)
```

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)
>  
> ```

<br />

<br />

| Parameters ||
|---|---|
| `beginIndex` | `int`: the beginning index, inclusive. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the specified substring. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `beginIndex` is negative or larger than the length of this `String` object. |

### toCharArray

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public char[] toCharArray ()
```

Converts this string to a new character array.

<br />

| Returns ||
|---|---|
| `char[]` | a newly allocated character array whose length is the length of this string and whose contents are initialized to contain the character sequence represented by this string. <br /> |

### toLowerCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toLowerCase ()
```

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\u0131tle"`, where '\\u0131' is the
LATIN SMALL LETTER DOTLESS I character.
To obtain correct results for locale insensitive strings, use
`toLowerCase(Locale.ROOT)`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the `String`, converted to lowercase. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#toLowerCase(java.util.Locale)`

### toLowerCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toLowerCase (Locale locale)
```

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 `https://developer.android.com/reference/java/lang/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:

| Language Code of Locale | Upper Case | Lower Case | Description |
|---|---|---|---|
| tr (Turkish) | \\u0130 | \\u0069 | capital letter I with dot above -\> small letter i |
| tr (Turkish) | \\u0049 | \\u0131 | capital letter I -\> small letter dotless i |
| (all) | French Fries | french fries | lowercased all chars in String |
| (all) | ΙΧΘΥΣ | ιχθυσ | lowercased all chars in String |
[Lowercase mapping examples showing language code of locale, upper case, lower case, and description]

<br />

<br />

| Parameters ||
|---|---|
| `locale` | `Locale`: use the case transformation rules for this locale <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the `String`, converted to lowercase. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#toLowerCase()`
- `https://developer.android.com/reference/java/lang/String#toUpperCase()`
- `https://developer.android.com/reference/java/lang/String#toUpperCase(java.util.Locale)`

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the string itself. <br /> |

### toUpperCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toUpperCase (Locale locale)
```

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 `https://developer.android.com/reference/java/lang/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.

| Language Code of Locale | Lower Case | Upper Case | Description |
|---|---|---|---|
| tr (Turkish) | \\u0069 | \\u0130 | small letter i -\> capital letter I with dot above |
| tr (Turkish) | \\u0131 | \\u0049 | small letter dotless i -\> capital letter I |
| (all) | \\u00df | \\u0053 \\u0053 | small letter sharp s -\> two letters: SS |
| (all) | Fahrvergnügen | FAHRVERGNÜGEN |   |
[Examples of locale-sensitive and 1:M case mappings. Shows Language code of locale, lower case, upper case, and description.]

<br />

<br />

| Parameters ||
|---|---|
| `locale` | `Locale`: use the case transformation rules for this locale <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the `String`, converted to uppercase. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#toUpperCase()`
- `https://developer.android.com/reference/java/lang/String#toLowerCase()`
- `https://developer.android.com/reference/java/lang/String#toLowerCase(java.util.Locale)`

### toUpperCase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toUpperCase ()
```

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\u0130TLE"`, where '\\u0130' is the
LATIN CAPITAL LETTER I WITH DOT ABOVE character.
To obtain correct results for locale insensitive strings, use
`toUpperCase(Locale.ROOT)`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the `String`, converted to uppercase. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/String#toUpperCase(java.util.Locale)`

### transform

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public R transform (Function<? super String, ? extends R> f)
```

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.

<br />

| Parameters ||
|---|---|
| `f` | `Function`: a function to apply <br /> |

| Returns ||
|---|---|
| `R` | the result of applying the function to this string <br /> |

**See also:**

- `https://developer.android.com/reference/java/util/function/Function`

### translateEscapes

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String translateEscapes ()
```

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


Escape sequences are translated as follows;

| Escape | Name | Translation |
| `\b` | backspace | `U+0008` |
| `\t` | horizontal tab | `U+0009` |
| `\n` | line feed | `U+000A` |
| `\f` | form feed | `U+000C` |
| `\r` | carriage return | `U+000D` |
| `\s` | space | `U+0020` |
| `\"` | double quote | `U+0022` |
| `\'` | single quote | `U+0027` |
| `\\` | backslash | `U+005C` |
| `\0 - \377` | octal escape | code point equivalents |
| `\<line-terminator>` | continuation | discard |
|---|---|---|
[Translation]

<br />

<br />

##### Implementation Note:

- This method does *not* translate Unicode escapes such as "`\u2022`". Unicode escapes are translated by the Java compiler when reading input characters and are not part of the string literal specification.

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | String with escape sequences translated. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | when an escape sequence is malformed. |

### trim

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String trim ()
```

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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string whose value is this string, with all leading and trailing space removed, or this string if it has no leading or trailing space. <br /> |

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (boolean b)
```

Returns the string representation of the `boolean` argument.

<br />

| Parameters ||
|---|---|
| `b` | `boolean`: a `boolean`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | if the argument is `true`, a string equal to `"true"` is returned; otherwise, a string equal to `"false"` is returned. <br /> |

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (double d)
```

Returns the string representation of the `double` argument.


The representation is exactly the one returned by the
`Double.toString` method of one argument.

<br />

| Parameters ||
|---|---|
| `d` | `double`: a `double`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the `double` argument. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Double#toString(double)`

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (char[] data, 
                int offset, 
                int count)
```

Returns the string representation of a specific subarray of the
`char` array argument.


The `offset` argument is the index of the first
character of the subarray. 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 returned string.

<br />

| Parameters ||
|---|---|
| `data` | `char`: the character array. <br /> |
| `offset` | `int`: initial offset of the subarray. <br /> |
| `count` | `int`: length of the subarray. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a `String` that contains the characters of the specified subarray of the character array. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IndexOutOfBoundsException` | if `offset` is negative, or `count` is negative, or `offset+count` is larger than `data.length`. |

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (float f)
```

Returns the string representation of the `float` argument.


The representation is exactly the one returned by the
`Float.toString` method of one argument.

<br />

| Parameters ||
|---|---|
| `f` | `float`: a `float`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the `float` argument. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Float#toString(float)`

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (int i)
```

Returns the string representation of the `int` argument.


The representation is exactly the one returned by the
`Integer.toString` method of one argument.

<br />

| Parameters ||
|---|---|
| `i` | `int`: an `int`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the `int` argument. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Integer#toString(int,%20int)`

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (char c)
```

Returns the string representation of the `char`
argument.

<br />

| Parameters ||
|---|---|
| `c` | `char`: a `char`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string of length `1` containing as its single character the argument `c`. <br /> |

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (long l)
```

Returns the string representation of the `long` argument.


The representation is exactly the one returned by the
`Long.toString` method of one argument.

<br />

| Parameters ||
|---|---|
| `l` | `long`: a `long`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the `long` argument. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Long#toString(long)`

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (Object obj)
```

Returns the string representation of the `Object` argument.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: an `Object`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | if the argument is `null`, then a string equal to `"null"`; otherwise, the value of `obj.toString()` is returned. <br /> |

**See also:**

- `https://developer.android.com/reference/java/lang/Object#toString()`

### valueOf

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String valueOf (char[] data)
```

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.

<br />

| Parameters ||
|---|---|
| `data` | `char`: the character array. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a `String` that contains the characters of the character array. <br /> |