"""A string of characters. Each character in the string is a 32-bit Unicode character. The internal UTF-16 encoding is hidden from clients. A string is a `Category` of its `Character`s, and of its substrings: 'w' in greeting "hello" in greeting Strings are summable: String greeting = "hello" + " " + "world"; They are efficiently iterable: for (char in "hello world") { ... } They are `List`s of `Character`s: value char = "hello world"[5]; They are ranged: String who = "hello world"[6...]; Note that since `string[index]` evaluates to the optional type `Character?`, it is often more convenient to write `string[index..index]`, which evaluates to a `String` containing a single character, or to the empty string `""` if `index` refers to a position outside the string. It is easy to use comprehensions to transform strings: String { for (s in "hello world") if (s.letter) s.uppercased } Since a `String` has an underlying UTF-16 encoding, certain operations are expensive, requiring iteration of the characters of the string. In particular, `size` requires iteration of the whole string, and `get()`, `span()`, and `segment()` require iteration from the beginning of the string to the given index.""" by ("Gavin") shared native final class String(characters) extends Object() satisfies List<Character> & Comparable<String> & Summable<String> & Ranged<Integer,String> & Cloneable<String> { "The characters that form this string." shared {Character*} characters; "This string, with all characters in lowercase." shared native String lowercased; "This string, with all characters in uppercase." shared native String uppercased; "Split the string into tokens, using the given predicate to determine which characters are separator characters." shared native {String*} split( "A predicate that determines if a character is a separator characters at which to split. Default to split at any [[whitespace|Character.whitespace]] character." Boolean splitting(Character ch) => ch.whitespace, "Specifies that the separator characters occurring in the string should be discarded. If `false`, they will be included in the resulting iterator." Boolean discardSeparators=true, "Specifies that the separator tokens should be grouped eagerly and not be treated as single-character tokens. If `false` each separator token will be of size `1`." Boolean groupSeparators=true); "The rest of the string, without the first element." shared actual native String rest; "Join the given strings, using this string as a separator." shared native String join({String*} strings); "Split the string into lines of text." shared native {String*} lines => split('\n'.equals); "This string, after discarding [[whitespace|Character.whitespace]] from the beginning and end of the string." shared native String trimmed => trim(Character.whitespace); "This string, after discarding the given characters from the beginning and end of the string" shared actual native String trim(Boolean trimming(Character elem)); "This string, after discarding the given characters from the beginning of the string" shared actual native String trimLeading(Boolean trimming(Character elem)); "This string, after discarding the given characters from the end of the string" shared actual native String trimTrailing(Boolean trimming(Character elem)); "This string, after collapsing strings of [[whitespace|Character.whitespace]] into single space characters and discarding whitespace from the beginning and end of the string." shared native String normalized; "This string, with the characters in reverse order." shared native actual String reversed; "Select the characters between the given indexes. If the start index is the same as the end index, return a string with a single character. If the start index is larger than the end index, return the characters in the reverse order from the order in which they appear in this string. If both the start index and the end index are larger than the last index in the string, return the empty string. Otherwise, if the last index is larger than the last index in the sequence, return all characters from the start index to last character of the string." shared actual native String span(Integer from, Integer to); shared actual String spanFrom(Integer from) => span(from, size); shared actual String spanTo(Integer to) => to>0 then span(0, to) else ""; "Select the characters of this string beginning at the given index, returning a string no longer than the given length. If the portion of this string starting at the given index is shorter than the given length, return the portion of this string from the given index until the end of this string. Otherwise return a string of the given length. If the start index is larger than the last index of the string, return the empty string." shared native actual String segment(Integer from, Integer length); "Select the first characters of this string, returning a string no longer than the given length. If this string is shorter than the given length, return this string. Otherwise return a string of the given length." shared native actual String initial(Integer length); "Select the last characters of the string, returning a string no longer than the given length. If this string is shorter than the given length, return this string. Otherwise return a string of the given length." shared native actual String terminal(Integer length); "The length of the string (the number of characters it contains). In the case of the empty string, the string has length zero. Note that this operation is potentially costly for long strings, since the underlying representation of the characters uses a UTF-16 encoding." see (`function longerThan`, `function shorterThan`) shared actual native Integer size; "The index of the last character in the string, or `null` if the string has no characters. Note that this operation is potentially costly for long strings, since the underlying representation of the characters uses a UTF-16 encoding." shared actual Integer? lastIndex { if (size==0) { return null; } else { return size-1; } } "An iterator for the characters of the string." shared actual native Iterator<Character> iterator(); "Returns the character at the given index in the string, or `null` if the index is past the end of string. The first character in the string occurs at index zero. The last character in the string occurs at index `string.size-1`." shared actual native Character? get(Integer index); "Determines if the given object is a `String` and, if so, if it occurs as a substring of this string, or if the object is a `Character` that occurs in this string. That is to say, a string is considered a `Category` of its substrings and of its characters." shared actual native Boolean contains(Object element); "Returns the concatenation of this string with the given string." shared actual native String plus(String other); "Returns a string formed by repeating this string the given number of times, or the empty string if `times<=0`." shared actual native String repeat(Integer times); "Returns a string formed by replacing every occurrence in this string of the given substring with the given replacement string, working from the start of this string to the end." shared native String replace(String substring, String replacement); "Compare this string with the given string lexicographically, according to the Unicode values of the characters." shared actual native Comparison compare(String other); "Determines if this string is longer than the given length. This is a more efficient operation than `string.size>length`." see (`value size`) shared actual native Boolean longerThan(Integer length); "Determines if this string is shorter than the given length. This is a more efficient operation than `string.size>length`." see (`value size`) shared actual native Boolean shorterThan(Integer length); "Determines if the given object is a string, and if so, if this string has the same length, and the same characters, in the same order, as the given string." shared actual native Boolean equals(Object that); shared actual native Integer hash; "Returns the string itself." shared actual String string => this; "Determines if this string has no characters, that is, if it has zero `size`. This is a more efficient operation than `string.size==0`." see (`value size`) shared actual native Boolean empty; "Returns this string." shared actual String coalesced => this; }