Str
const class Str : Obj
Str represents a sequence of Unicode characters.
Default value is ""
Duplicate this string the given number of times
Get the character at the zero based index as a Unicode code point
Return this string with all lowercase characters replaced to uppercase
Replace all occurrences of from with to
Reverse index - return the first occurrence of the specified substring searching backward, starting at the specified offset index
Return this string with the first character converted to lowercase using the current locale
Translate a programmer name like "fooBar" to "Foo Bar"
If size is less than width, then add spaces to the left to create a right justified string
Return this string as valid XML text
If size is less than width, then add the given char to the left to achieve the specified width
If size is less than width, then add spaces to the right to create a left justified string
Compare two strings without regard to case according to the current locale
Trim whitespace only from the end of the string
Return if every character in this Str is whitespace
If size is less than width, then add the given char to the left to achieve the specified width
Return this string with all lowercase characters replaced to uppercase using the current locale
Split a string into a list of substrings using the given separator character
Trim whitespace from the beginning and end of the string
Return a substring based on the specified range
Return if every character in this Str is ASCII uppercase
Count the number of newline combinations
Convenience for compareIgnoreCase(s) == 0
Convenience for Decimal.fromStr using this string
Find the index just like fan.sys, but ignoring case for ASCII chars only
Trim whitespace only from the beginning of the string
Return true if c returns true for all of the characters in this string
Return this
Return if every char is an ASCII alpha-numeric
Create an input stream to read characters from this string
Return if every char is an ASCII letter
Return this string as its Fantom source code and serialization representation surrounded by the specified quote character (which defaults to ")
Return this string with all uppercase characters replaced to lowercase
Return the first occurrence of the specified substring searching forward, starting at the specified offset index
Split this string into individual lines where lines are terminated by \n, \r\n, or \r
Convenience for Bool.fromStr using this string
Reverse each - call the specified function for every char in the string starting with index size-1 and decrementing down to 0
Return this string with the first character converted uppercase
Call the specified function for every char in the string with index 0 and incrementing up to size-1
Concat the value of obj.toStr
Return this string with the first character converted to uppercase using the current locale
Return if this string contains the specified string
Return if every character in this Str is a US-ASCII character less than 128
Return number of characters in this string
Return if this Str ends with the specified Str
Get a Str containing the specified number of spaces
Return this string with all uppercase characters replaced to lowercase using the current locale
The hash for a Str is platform dependent
Compare two strings without regard to case and return -1, 0, or 1 if this string is less than, equal to, or greater than the specified string
Compare based on Unicode character values
Return if this string contains the specified character
Return this string with the first character converted lowercase
Get the character at the zero based index as a Unicode code point
Translate a display name like "Foo Bar" to a programmatic name "fooBar"
Trim whitespace from the beginning and end of the string
Convenience for Int.fromStr using this string
Return this
Internalize this Str such that two strings which are equal via the == operator will have the same reference such that === will be true
Convenience for Regex.fromStr using this string
Convenience for Uri.fromStr using this string
Return if size() == 0
Convenience for Float.fromStr using this string
Construct a string from a list of unicode code points
Reverse the contents of this string
Return true if c returns true for any of the characters in this string
Get this string encoded into a buffer of bytes
Find the index just like indexr, but ignoring case for ASCII chars only
Split string into lines and call specified function with each line
Return true if a Str with exact same char sequence
Return if every character in this Str is ASCII lowercase
Iterate each character in the string until the function returns non-null
Get the characters in this string as a list of integer code points
Return if this Str starts with the specified Str
Bool all(|Int,Int->Bool| c)
Return true if c returns true for all of the characters in this string. If this string is empty, return true.
Example:
"Bar".all |c| { c.isUpper } => false
"BAR".all |c| { c.isUpper } => true
Bool any(|Int,Int->Bool| c)
Return true if c returns true for any of the characters in this string. If this string is empty, return false.
Example:
"Foo".any |c| { c.isUpper } => true
"foo".any |c| { c.isUpper } => false
Str capitalize()
Return this string with the first character converted uppercase. The case conversion is for ASCII only. Also see decapitalize and localeCapitalize.
Example:
"foo".capitalize => "Foo"
Int[] chars()
Get the characters in this string as a list of integer code points. Also see fromChars.
virtual Int compare(Obj obj)
Compare based on Unicode character values. Case is not taken into account - also see compareIgnoreCase and localeCompare.
Examples:
"a".compare("b") => -1
"hi".compare("hi") => 0
"hi".compare("HI") => 1
"b".compare("a") => 1
Int compareIgnoreCase(Str s)
Compare two strings without regard to case and return -1, 0, or 1 if this string is less than, equal to, or greater than the specified string. Only ASCII character case is taken into account. See localeCompare for localized case insensitive comparisions.
Examples:
"a".compareIgnoreCase("b") => -1
"hi".compareIgnoreCase("HI") => 0
"b".compareIgnoreCase("a") => 1
Bool contains(Str s)
Return if this string contains the specified string. Convenience for index(s) != null
Bool containsChar(Int ch)
Return if this string contains the specified character.
Str decapitalize()
Return this string with the first character converted lowercase. The case conversion is for ASCII only. Also see capitalize and localeDecapitalize.
Example:
"Foo".decapitalize => "foo"
const static Str : defVal
Default value is "".
Void each(|Int,Int| c)
Call the specified function for every char in the string with index 0 and incrementing up to size-1.
Example:
"abc".each |Int c| { echo(c.toChar) }
Void eachLine(|Str| f)
Split string into lines and call specified function with each line. Each line is terminated by \n, \r\n, \r, or EOF using the same semantics as splitLines
Obj? eachWhile(|Int,Int->Obj?| c)
Iterate each character in the string until the function returns non-null. If function returns non-null, then break the iteration and return the resulting object. Return null if the function returns null for every item.
Void eachr(|Int,Int| c)
Reverse each - call the specified function for every char in the string starting with index size-1 and decrementing down to 0.
Example:
"abc".eachr |Int c| { echo(c.toChar) }
Bool endsWith(Str s)
Return if this Str ends with the specified Str.
virtual Bool equals(Obj? obj)
Return true if a Str with exact same char sequence.
Bool equalsIgnoreCase(Str s)
Convenience for compareIgnoreCase(s) == 0. Only ASCII character case is taken into account. See localeCompare for localized case insensitive comparisions.
static Str fromChars(Int[] chars)
Construct a string from a list of unicode code points. Also see chars.
Str fromDisplayName()
Translate a display name like "Foo Bar" to a programmatic name "fooBar". This method decapitalizes the first letter, then walks the string removing spaces. Also see toDisplayName.
Examples:
"Foo".fromDisplayName -> "foo" "Foo Bar".fromDisplayName -> "fooBar" "Foo Bar Baz".fromDisplayName -> "fooBarBaz" "Foo 33 Bar".fromDisplayName -> "foo33Bar" "Foo XML".fromDisplayName -> "fooXML" "foo bar".fromDisplayName -> "fooBar"
@Operator
Int get(Int index)
Get the character at the zero based index as a Unicode code point. Negative indexes may be used to access from the end of the string. This method is accessed via the [] operator. Throw IndexErr if the index is out of range.
@Operator
Str getRange(Range range)
Return a substring based on the specified range. Negative indexes may be used to access from the end of the string. This method is accessed via the [] operator. Throw IndexErr if range illegal.
Examples:
"abcd"[0..2] => "abc" "abcd"[3..3] => "d" "abcd"[-2..-1] => "cd" "abcd"[0..<2] => "ab" "abcd"[1..-2] => "bc" "abcd"[4..-1] => ""
Int getSafe(Int index, Int def)
Get the character at the zero based index as a Unicode code point. Negative indexes may be used to access from the end of the string. Unlike get, this method does not throw IndexErr when the index is out or range, instead it returns def.
virtual Int hash()
The hash for a Str is platform dependent.
InStream in()
Create an input stream to read characters from this string. The input stream is designed only to read character data. Attempts to perform binary reads will throw UnsupportedErr.
Int? index(Str s, Int offset)
Return the first occurrence of the specified substring searching forward, starting at the specified offset index. A negative offset may be used to access from the end of string. Return null if no occurrences are found.
Examples:
"abcabc".index("b") => 1
"abcabc".index("b", 1) => 1
"abcabc".index("b", 3) => 4
"abcabc".index("b", -3) => 4
"abcabc".index("x") => null
Int? indexIgnoreCase(Str s, Int offset)
Find the index just like fan.sys, but ignoring case for ASCII chars only.
Int? indexr(Str s, Int offset)
Reverse index - return the first occurrence of the specified substring searching backward, starting at the specified offset index. A negative offset may be used to access from the end of string. Return null if no occurrences are found.
Examples:
"abcabc".indexr("b") => 4
"abcabc".indexr("b", -3) => 1
"abcabc".indexr("b", 0) => null
Int? indexrIgnoreCase(Str s, Int offset)
Find the index just like indexr, but ignoring case for ASCII chars only.
Str intern()
Internalize this Str such that two strings which are equal via the == operator will have the same reference such that === will be true.
Bool isAlpha()
Return if every char is an ASCII letter.
Bool isAlphaNum()
Return if every char is an ASCII alpha-numeric.
Bool isAscii()
Return if every character in this Str is a US-ASCII character less than 128.
Bool isEmpty()
Return if size() == 0.
Bool isLower()
Return if every character in this Str is ASCII lowercase: a-'z'.
Bool isSpace()
Return if every character in this Str is whitespace: space \t \n \r \f
Bool isUpper()
Return if every character in this Str is ASCII uppercase: A-'Z'.
Str justl(Int width)
If size is less than width, then add spaces to the right to create a left justified string. Also see padr.
Examples:
"xyz".justl(2) => "xyz" "xyz".justl(4) => "xyz "
Str justr(Int width)
If size is less than width, then add spaces to the left to create a right justified string. Also see padl.
Examples:
"xyz".justr(2) => "xyz" "xyz".justr(4) => " xyz"
Str localeCapitalize()
Return this string with the first character converted to uppercase using the current locale. Also see localeDecapitalize and capitalize.
Int localeCompare(Str s)
Compare two strings without regard to case according to the current locale. Return -1, 0, or 1 if this string is less than, equal to, or greater than the specified string.
Examples (assuming English locale):
"a".localeCompare("b") => -1
"hi".localeCompare("HI") => 0
"b".localeCompare("A") => 1
Str localeDecapitalize()
Return this string with the first character converted to lowercase using the current locale. Also see localeCapitalize and decapitalize.
Str localeLower()
Return this string with all uppercase characters replaced to lowercase using the current locale. Also see localeUpper, lower, and Int.localeLower.
Str localeUpper()
Return this string with all lowercase characters replaced to uppercase using the current locale. Also see localeLower, upper, and Int.localeUpper.
Str lower()
Return this string with all uppercase characters replaced to lowercase. The case conversion is for ASCII only. Also see upper, localeLower, Int.lower, Int.localeLower.
Example:
"Apple".lower => "apple"
@Operator
Str mult(Int times)
Duplicate this string the given number of times. Any integer less than or equal to zero returns an empty string.
Examples:
"x" * 4 => "xxxx"
Int numNewlines()
Count the number of newline combinations: "\n", "\r", or "\r\n".
Str padl(Int width, Int char)
If size is less than width, then add the given char to the left to achieve the specified width. Also see justr.
Examples:
"3".padl(3, '0') => "003" "123".padl(2, '0') => "123"
Str padr(Int width, Int char)
If size is less than width, then add the given char to the left to achieve the specified width. Also see justl.
Examples:
"xyz".padr(2, '.') => "xyz" "xyz".padr(5, '-') => "xyz--"
@Operator
Str plus(Obj? obj)
Concat the value of obj.toStr
Str replace(Str from, Str to)
Replace all occurrences of from with to.
Examples:
"hello".replace("hell", "t") => "to"
"aababa".replace("ab", "-") => "a--a"
Str reverse()
Reverse the contents of this string.
Example:
"stressed".reverse => "desserts"
Int size()
Return number of characters in this string.
static Str spaces(Int n)
Get a Str containing the specified number of spaces. Also see justl and justr to justify an existing string.
Examples:
Str.spaces(1) => " " Str.spaces(2) => " "
Str[] split(Int? separator, Bool trim)
Split a string into a list of substrings using the given separator character. If there are contiguous separators, then they are split into empty strings. If trim is true, then whitespace is trimmed from the beginning and end of the results.
If separator is null, then the string is split according to any sequence of whitespace characters (any character equal to or less than the 0x20 space character including , \r, \n, and \t).
If this is the empty string or there are no splits return a list of one item.
Examples:
// split on whitespace
"".split => [""]
"x".split => ["x"]
"x y".split => ["x", "y"]
" x y ".split => ["x", "y"]
" x \n y \n z ".split => ["x", "y", "z"]
// split on sep with trim
"".split('|') => [""]
"22".split(';') => ["22"]
"22;33".split(';') => ["22","33"]
"22, 33".split(',') => ["22","33"]
" 22 ; 33 ".split(';') => ["22","33"]
// split on sep with no trim
"22#33".split('#', false) => ["22","33"]
" x ; y".split(';', false) => [" x "," y"]
Str[] splitLines()
Split this string into individual lines where lines are terminated by \n, \r\n, or \r. The returned strings do not contain the newline character.
Examples:
"x\ny".splitLines => ["x", "y"] "".splitLines => [""] "x".splitLines => ["x"] "\r\n".splitLines => ["", ""] "x\n".splitLines => ["x", ""]
Bool startsWith(Str s)
Return if this Str starts with the specified Str.
Bool? toBool(Bool checked)
Convenience for Bool.fromStr using this string.
Buf toBuf(Charset charset)
Get this string encoded into a buffer of bytes.
Str toCode(Int? quote, Bool escapeUnicode)
Return this string as its Fantom source code and serialization representation surrounded by the specified quote character (which defaults to "). If quote is null then the return is unquoted. This method will backslash escape the following characters: \n \r \f \t \\ $. If the quote character is the double quote, single quote, or backtick then it is escaped too. Control chars less than 0x20 are escaped as \uXXXX. If escapeUnicode is true then any char over 0x7F is escaped as \uXXXX.
Decimal? toDecimal(Bool checked)
Convenience for Decimal.fromStr using this string.
Str toDisplayName()
Translate a programmer name like "fooBar" to "Foo Bar". This method capitalizes the first letter, then walks the string looking for ASCII capital letters and inserting a space. Any underbars are replaced with a space. Also see fromDisplayName.
Examples:
"foo".toDisplayName -> "Foo "fooBar".toDisplayName -> "Foo Bar" "fooBarBaz".toDisplayName -> "Foo Bar Baz" "foo33".toDisplayName -> "Foo 33" "fooXML".toDisplayName -> "Foo XML" "Foo".toDisplayName -> "Foo" "foo_bar".toDisplayName -> "Foo Bar"
Float? toFloat(Bool checked)
Convenience for Float.fromStr using this string.
Int? toInt(Int radix, Bool checked)
Convenience for Int.fromStr using this string.
Str toLocale()
Return this. This method is used to enable toLocale to be used with duck typing across most built-in types.
Regex toRegex()
Convenience for Regex.fromStr using this string.
virtual Str toStr()
Return this.
Uri toUri()
Convenience for Uri.fromStr using this string.
Str toXml()
Return this string as valid XML text. The special control characters amp, lt, apos and quot are always escaped. The gt char is escaped only if it is the first char or if preceded by the ] char. Also see OutStream.writeXml which is more efficient if streaming.
Str trim()
Trim whitespace from the beginning and end of the string. For the purposes of this method, whitespace is defined as any character equal to or less than the 0x20 space character (including , \r, \n, and \t).
Examples:
"foo".trim => "foo" " foo".trim => "foo" " foo ".trim => "foo" " foo\n".trim => "foo" " ".trim => ""
Str trimEnd()
Trim whitespace only from the end of the string. See trim for definition of whitespace.
Examples:
"foo".trim => "foo" " foo ".trim => " foo"
Str trimStart()
Trim whitespace only from the beginning of the string. See trim for definition of whitespace.
Examples:
"foo".trim => "foo" " foo ".trim => "foo "
Str? trimToNull()
Trim whitespace from the beginning and end of the string. Should the resultant string be empty, null is returned.
For the purposes of this method, whitespace is defined as any character equal to or less than the 0x20 space character (including , \r, \n, and \t).
Examples:
"foo".trimToNull => "foo" " foo ".trimToNull => "foo" "".trimToNull => null " ".trimToNull => null
Str upper()
Return this string with all lowercase characters replaced to uppercase. The case conversion is for ASCII only. Also see lower, localeUpper, Int.upper, Int.localeUpper.
Example:
"Foo Bar".upper => "FOO BAR"