Provides extension methods for strings.
Provides extension methods for strings.
Some of these methods treat strings as a plain collection of Chars without any regard for Unicode handling. Unless the user takes Unicode handling in to account or makes sure the strings don't require such handling, these methods may result in unpaired or invalidly paired surrogate code units.
- Companion
- object
Value members
Concrete methods
Returns true if this is less than or equal to that.
Returns true if this is less than or equal to that.
Returns true if this is greater than or equal to that.
Returns true if this is greater than or equal to that.
Appends this string to a string builder using a separator string.
Appends this string to a string builder using a separator string.
Appends this string to a string builder using start, end and separator strings.
Appends this string to a string builder using start, end and separator strings.
A copy of the string with all elements from a collection appended
A copy of the string with all elements from a collection appended
Returns this string with first character converted to upper case.
Returns this string with first character converted to upper case. If the first character of the string is capitalized, it is returned unchanged. This method does not convert characters outside the Basic Multilingual Plane (BMP).
Steps over characters in this string.
Steps over characters in this string. Values are packed in Int for efficiency
and compatibility with Java 8 Streams which have an efficient specialization for Int.
Builds a new String by applying a partial function to all chars of this String on which the function is defined.
Builds a new String by applying a partial function to all chars of this String on which the function is defined.
- Value Params
- pf
the partial function which filters and maps the String.
- Returns
a new String resulting from applying the given partial function
pfto each char on which it is defined and collecting the results.
Builds a new collection by applying a partial function to all chars of this String on which the function is defined.
Builds a new collection by applying a partial function to all chars of this String on which the function is defined.
- Type Params
- B
the element type of the returned collection.
- Value Params
- pf
the partial function which filters and maps the String.
- Returns
a new collection resulting from applying the given partial function
pfto each char on which it is defined and collecting the results.
Iterates over combinations.
Iterates over combinations. A _combination_ of length n is a subsequence of
the original string, with the chars taken in order. Thus, "xy" and "yy"
are both length-2 combinations of "xyy", but "yx" is not. If there is
more than one way to generate the same subsequence, only one will be returned.
For example, "xyyy" has three different ways to generate "xy" depending on
whether the first, second, or third "y" is selected. However, since all are
identical, only one will be chosen. Which of the three will be taken is an
implementation detail that is not defined.
- Returns
An Iterator which traverses the possible n-element combinations of this string.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
- Example
"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)
Returns a new collection containing the chars from this string followed by the elements from the right hand operand.
Returns a new collection containing the chars from this string followed by the elements from the right hand operand.
- Value Params
- suffix
the collection to append.
- Returns
a new collection which contains all chars of this string followed by all elements of
suffix.
Returns a new string containing the chars from this string followed by the chars from the right hand operand.
Returns a new string containing the chars from this string followed by the chars from the right hand operand.
- Value Params
- suffix
the collection to append.
- Returns
a new string which contains all chars of this string followed by all chars of
suffix.
Returns a new string containing the chars from this string followed by the chars from the right hand operand.
Returns a new string containing the chars from this string followed by the chars from the right hand operand.
- Value Params
- suffix
the string to append.
- Returns
a new string which contains all chars of this string followed by all chars of
suffix.
Tests whether this string contains the given character.
Tests whether this string contains the given character.
- Value Params
- elem
the character to test.
- Returns
trueif this string has an element that is equal (as determined by==) toelem,falseotherwise.
Copy chars of this string to an array.
Copy chars of this string to an array.
Fills the given array xs starting at index 0.
Copying will stop once either the entire string has been copied
or the end of the array is reached
- Value Params
- xs
the array to fill.
Copy chars of this string to an array.
Copy chars of this string to an array.
Fills the given array xs starting at index start.
Copying will stop once either the entire string has been copied
or the end of the array is reached
- Value Params
- start
the starting index.
- xs
the array to fill.
Copy chars of this string to an array.
Copy chars of this string to an array.
Fills the given array xs starting at index start with at most len chars.
Copying will stop once either the entire string has been copied,
or the end of the array is reached or len chars have been copied.
- Value Params
- len
the maximal number of elements to copy.
- start
the starting index.
- xs
the array to fill.
Counts the number of chars in this string which satisfy a predicate
Counts the number of chars in this string which satisfy a predicate
Computes the multiset difference between this string and another sequence.
Computes the multiset difference between this string and another sequence.
- Value Params
- that
the sequence of chars to remove
- Returns
a new string which contains all chars of this string except some of occurrences of elements that also appear in
that. If an element valuexappears n times inthat, then the first n occurrences ofxwill not form part of the result, but any following occurrences will.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Selects all distinct chars of this string ignoring the duplicates.
Selects all distinct chars of this string ignoring the duplicates.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Selects all distinct chars of this string ignoring the duplicates as determined by == after applying
the transforming function f.
Selects all distinct chars of this string ignoring the duplicates as determined by == after applying
the transforming function f.
- Type Params
- B
the type of the elements after being transformed by
f
- Value Params
- f
The transforming function whose result is used to determine the uniqueness of each element
- Returns
a new string consisting of all the chars of this string without duplicates.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
The rest of the string without its n first chars.
The rest of the string without its n first chars.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
The rest of the string without its n last chars.
The rest of the string without its n last chars.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Drops longest prefix of chars that satisfy a predicate.
Drops longest prefix of chars that satisfy a predicate.
- Value Params
- p
The predicate used to test elements.
- Returns
the longest suffix of this string whose first element does not satisfy the predicate
p.
Tests whether a predicate holds for at least one char of this string.
Tests whether a predicate holds for at least one char of this string.
Selects all chars of this string which satisfy a predicate.
Selects all chars of this string which satisfy a predicate.
Selects all chars of this string which do not satisfy a predicate.
Selects all chars of this string which do not satisfy a predicate.
Finds the first char of the string satisfying a predicate, if any.
Finds the first char of the string satisfying a predicate, if any.
- Value Params
- p
the predicate used to test elements.
- Returns
an option value containing the first element in the string that satisfies
p, orNoneif none exists.
Builds a new collection by applying a function to all chars of this string and using the elements of the resulting collections.
Builds a new collection by applying a function to all chars of this string and using the elements of the resulting collections.
- Value Params
- f
the function to apply to each char.
- Returns
a new collection resulting from applying the given collection-valued function
fto each char of this string and concatenating the results.
Builds a new string by applying a function to all chars of this string and using the elements of the resulting strings.
Builds a new string by applying a function to all chars of this string and using the elements of the resulting strings.
- Value Params
- f
the function to apply to each char.
- Returns
a new string resulting from applying the given string-valued function
fto each char of this string and concatenating the results.
Folds the chars of this string using the specified associative binary operator.
Folds the chars of this string using the specified associative binary operator.
- Type Params
- A1
a type parameter for the binary operator, a supertype of Char.
- Value Params
- op
a binary operator that must be associative.
- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nilfor list concatenation, 0 for addition, or 1 for multiplication).
- Returns
the result of applying the fold operator
opbetween all the chars andz, orzif this string is empty.
Applies a binary operator to a start value and all chars of this string, going left to right.
Applies a binary operator to a start value and all chars of this string, going left to right.
- Type Params
- B
the result type of the binary operator.
- Value Params
- op
the binary operator.
- z
the start value.
- Returns
the result of inserting
opbetween consecutive chars of this string, going left to right with the start valuezon the left:op(...op(z, x_1), x_2, ..., x_n)where
x1, ..., xnare the chars of this string. Returnszif this string is empty.
Applies a binary operator to all chars of this string and a start value, going right to left.
Applies a binary operator to all chars of this string and a start value, going right to left.
- Type Params
- B
the result type of the binary operator.
- Value Params
- op
the binary operator.
- z
the start value.
- Returns
the result of inserting
opbetween consecutive chars of this string, going right to left with the start valuezon the right:op(x_1, op(x_2, ... op(x_n, z)...))where
x1, ..., xnare the chars of this string. Returnszif this string is empty.
Tests whether a predicate holds for all chars of this string.
Tests whether a predicate holds for all chars of this string.
- Value Params
- p
the predicate used to test elements.
- Returns
trueif this string is empty or the given predicatepholds for all chars of this string, otherwisefalse.
Apply f to each element for its side effects.
Apply f to each element for its side effects.
Note: [U] parameter needed to help scalac's type inference.
Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.
Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.
The interpretation of the formatting patterns is described in
java.util.Formatter, with the addition that
classes deriving from ScalaNumber (such as scala.BigInt and
scala.BigDecimal) are unwrapped to pass a type which Formatter
understands.
- Value Params
- args
the arguments used to instantiating the pattern.
Like format(args*) but takes an initial Locale parameter
which influences formatting as in java.lang.String's format.
Like format(args*) but takes an initial Locale parameter
which influences formatting as in java.lang.String's format.
The interpretation of the formatting patterns is described in
java.util.Formatter, with the addition that
classes deriving from ScalaNumber (such as scala.BigInt and
scala.BigDecimal) are unwrapped to pass a type which Formatter
understands.
- Value Params
- args
the arguments used to instantiating the pattern.
- l
an instance of
java.util.Locale
Partitions this string into a map of strings according to some discriminator function.
Partitions this string into a map of strings according to some discriminator function.
- Type Params
- K
the type of keys returned by the discriminator function.
- Value Params
- f
the discriminator function.
- Returns
A map from keys to strings such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)That is, every key
kis bound to a string of those elementsxfor whichf(x)equalsk.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Partitions elements in fixed size strings.
Partitions elements in fixed size strings.
- Value Params
- size
the number of elements per group
- Returns
An iterator producing strings of size
size, except the last will be less than sizesizeif the elements don't divide evenly.- See also
scala.collection.Iterator, method
grouped- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Selects the first char of this string.
Selects the first char of this string.
- Returns
the first char of this string.
- Throws
- NoSuchElementException
if the string is empty.
Optionally selects the first char.
Optionally selects the first char.
- Returns
the first char of this string if it is nonempty,
Noneif it is empty.
Finds index of the first char satisfying some predicate after or at some start index.
Finds index of the first char satisfying some predicate after or at some start index.
- Value Params
- from
the start index
- p
the predicate used to test elements.
- Returns
the index
>= fromof the first element of this string that satisfies the predicatep, or-1, if none exists.
Produces the range of all indices of this string.
Produces the range of all indices of this string.
- Returns
a
Rangevalue from0to one less than the length of this string.
The initial part of the string without its last char.
The initial part of the string without its last char.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Iterates over the inits of this string.
Iterates over the inits of this string. The first value will be this
string and the final one will be an empty string, with the intervening
values the results of successive applications of init.
- Returns
an iterator over all the inits of this string
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Computes the multiset intersection between this string and another sequence.
Computes the multiset intersection between this string and another sequence.
- Value Params
- that
the sequence of chars to intersect with.
- Returns
a new string which contains all chars of this string which also appear in
that. If an element valuexappears n times inthat, then the first n occurrences ofxwill be retained in the result, but any following occurrences will be omitted.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Selects the last char of this string.
Selects the last char of this string.
- Returns
the last char of this string.
- Throws
- NoSuchElementException
if the string is empty.
Finds index of the last char satisfying some predicate before or at some end index.
Finds index of the last char satisfying some predicate before or at some end index.
- Value Params
- end
the end index
- p
the predicate used to test elements.
- Returns
the index
<= endof the last element of this string that satisfies the predicatep, or-1, if none exists.
Optionally selects the last char.
Optionally selects the last char.
- Returns
the last char of this string if it is nonempty,
Noneif it is empty.
Analogous to zip except that the elements in each collection are not consumed until a strict operation is
invoked on the returned LazyZip2 decorator.
Analogous to zip except that the elements in each collection are not consumed until a strict operation is
invoked on the returned LazyZip2 decorator.
Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of
constructing and deconstructing intermediary tuples.
val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)- Type Params
- B
the type of the second element in each eventual pair
- Value Params
- that
the iterable providing the second element of each eventual pair
- Returns
a decorator
LazyZip2that allows strict operations to be performed on the lazily evaluated pairs or chained calls tolazyZip. Implicit conversion toIterable[(A, B)]is also supported.
Lines in this string, where a line is terminated by
"\n", "\r", "\r\n", or the end of the string.
Lines in this string, where a line is terminated by
"\n", "\r", "\r\n", or the end of the string.
A line may be empty. Line terminators are removed.
Return an iterator of all lines embedded in this string, including trailing line separator characters.
Return an iterator of all lines embedded in this string, including trailing line separator characters.
The empty string yields an empty iterator.
Builds a new collection by applying a function to all chars of this string.
Builds a new collection by applying a function to all chars of this string.
- Value Params
- f
the function to apply to each char.
- Returns
a new collection resulting from applying the given function
fto each char of this string and collecting the results.
Builds a new string by applying a function to all chars of this string.
Builds a new string by applying a function to all chars of this string.
- Value Params
- f
the function to apply to each char.
- Returns
a new string resulting from applying the given function
fto each char of this string and collecting the results.
Displays all elements of this string in a string using start, end, and separator strings.
Displays all elements of this string in a string using start, end, and separator strings.
- Value Params
- end
the ending string.
- sep
the separator string.
- start
the starting string.
- Returns
The resulting string begins with the string
startand ends with the stringend. Inside, the string chars of this string are separated by the stringsep.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Displays all elements of this string in a string using a separator string.
Displays all elements of this string in a string using a separator string.
- Value Params
- sep
the separator string.
- Returns
In the resulting string the chars of this string are separated by the string
sep.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Returns a collection with an element appended until a given target length is reached.
Returns a collection with an element appended until a given target length is reached.
- Value Params
- elem
the padding value
- len
the target length
- Returns
a collection consisting of this string followed by the minimal number of occurrences of
elemso that the resulting collection has a length of at leastlen.
Returns a string with a char appended until a given target length is reached.
Returns a string with a char appended until a given target length is reached.
- Value Params
- elem
the padding value
- len
the target length
- Returns
a string consisting of this string followed by the minimal number of occurrences of
elemso that the resulting string has a length of at leastlen.
A pair of, first, all chars that satisfy predicate p and, second, all chars that do not.
A pair of, first, all chars that satisfy predicate p and, second, all chars that do not.
Applies a function f to each character of the string and returns a pair of strings: the first one
made of those characters returned by f that were wrapped in scala.util.Left, and the second
one made of those wrapped in scala.util.Right.
Applies a function f to each character of the string and returns a pair of strings: the first one
made of those characters returned by f that were wrapped in scala.util.Left, and the second
one made of those wrapped in scala.util.Right.
Example:
val xs = "1one2two3three" partitionMap { c =>
if (c > 'a') Left(c) else Right(c)
}
// xs == ("onetwothree", "123")- Value Params
- f
the 'split function' mapping the elements of this string to an scala.util.Either
- Returns
a pair of strings: the first one made of those characters returned by
fthat were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.
Produces a new collection where a slice of characters in this string is replaced by another collection.
Produces a new collection where a slice of characters in this string is replaced by another collection.
Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
- Value Params
- from
the index of the first replaced char
- other
the replacement collection
- replaced
the number of chars to drop in the original string
- Returns
a new collection consisting of all chars of this string except that
replacedchars starting fromfromare replaced byother.
Produces a new collection where a slice of characters in this string is replaced by another collection.
Produces a new collection where a slice of characters in this string is replaced by another collection.
Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
- Value Params
- from
the index of the first replaced char
- other
the replacement string
- replaced
the number of chars to drop in the original string
- Returns
a new string consisting of all chars of this string except that
replacedchars starting fromfromare replaced byother.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Produces a new string where a slice of characters in this string is replaced by another string.
Produces a new string where a slice of characters in this string is replaced by another string.
Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
- Value Params
- from
the index of the first replaced char
- other
the replacement string
- replaced
the number of chars to drop in the original string
- Returns
a new string consisting of all chars of this string except that
replacedchars starting fromfromare replaced byother.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Iterates over distinct permutations.
Iterates over distinct permutations.
- Returns
An Iterator which traverses the distinct permutations of this string.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
- Example
"abb".permutations = Iterator(abb, bab, bba)
A copy of the string with all elements from a collection prepended
A copy of the string with all elements from a collection prepended
A copy of the string with another string prepended
A copy of the string with another string prepended
You can follow a string with .r, turning it into a Regex.
You can follow a string with .r, turning it into a Regex. E.g.
"""A\w*""".r is the regular expression for identifiers starting with A.
You can follow a string with .r(g1, ... , gn), turning it into a Regex,
with group names g1 through gn.
You can follow a string with .r(g1, ... , gn), turning it into a Regex,
with group names g1 through gn.
"""(\d\d)-(\d\d)-(\d\d\d\d)""".r("month", "day", "year") matches dates
and provides its subcomponents through groups named "month", "day" and
"year".
- Value Params
- groupNames
The names of the groups in the pattern, in the order they appear.
Returns new sequence with elements in reversed order.
Returns new sequence with elements in reversed order.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
An iterator yielding chars in reversed order.
An iterator yielding chars in reversed order.
Note: xs.reverseIterator is the same as xs.reverse.iterator but implemented more efficiently.
- Returns
an iterator yielding the chars of this string in reversed order
Selects an interval of elements.
Selects an interval of elements. The returned string is made up
of all elements x which satisfy the invariant:
from <= indexOf(x) < until- Value Params
- from
the lowest index to include from this string.
- until
the lowest index to EXCLUDE from this string.
- Returns
a string containing the elements greater than or equal to index
fromextending up to (but not including) indexuntilof this string.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Groups chars in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
Groups chars in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
- Value Params
- size
the number of chars per group
- step
the distance between the first chars of successive groups
- Returns
An iterator producing strings of size
size, except the last element (which may be the only element) will be truncated if there are fewer thansizechars remaining to be grouped.- See also
scala.collection.Iterator, method
sliding- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Sorts this string according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
Sorts this string according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
The sort is stable. That is, elements that are equal (as determined by
ord.compare) appear in the same order in the sorted sequence as in the original.
- Type Params
- B
the target type of the transformation
f, and the type where the orderingordis defined.
- Value Params
- f
the transformation function mapping elements to some other domain
B.- ord
the ordering assumed on domain
B.
- Returns
a string consisting of the chars of this string sorted according to the ordering where
x < yiford.lt(f(x), f(y)).- See also
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Sorts this string according to a comparison function.
Sorts this string according to a comparison function.
The sort is stable. That is, elements that are equal (as determined by
lt) appear in the same order in the sorted sequence as in the original.
- Value Params
- lt
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
- Returns
a string consisting of the elements of this string sorted according to the comparison function
lt.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Sorts the characters of this string according to an Ordering.
Sorts the characters of this string according to an Ordering.
The sort is stable. That is, elements that are equal (as determined by
ord.compare) appear in the same order in the sorted sequence as in the original.
- Value Params
- ord
the ordering to be used to compare elements.
- Returns
a string consisting of the chars of this string sorted according to the ordering
ord.- See also
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Splits this string into a prefix/suffix pair according to a predicate.
Splits this string into a prefix/suffix pair according to a predicate.
Note: c span p is equivalent to (but more efficient than)
(c takeWhile p, c dropWhile p), provided the evaluation of the
predicate p does not cause any side-effects.
- Value Params
- p
the test predicate
- Returns
a pair consisting of the longest prefix of this string whose chars all satisfy
p, and the rest of this string.
Split this string around the separator character
Split this string around the separator character
If this string is the empty string, returns an array of strings that contains a single empty string.
If this string is not the empty string, returns an array containing the substrings terminated by the start of the string, the end of the string or the separator character, excluding empty trailing substrings
If the separator character is a surrogate character, only split on matching surrogate characters if they are not part of a surrogate pair
The behaviour follows, and is implemented in terms of String.split(re: String)
- Value Params
- separator
the character used as a delimiter
- Example
"a.b".split('.') //returns Array("a", "b") //splitting the empty string always returns the array with a single //empty string "".split('.') //returns Array("") //only trailing empty substrings are removed "a.".split('.') //returns Array("a") ".a.".split('.') //returns Array("", "a") "..a..".split('.') //returns Array("", "", "a") //all parts are empty and trailing ".".split('.') //returns Array() "..".split('.') //returns Array() //surrogate pairs val high = 0xD852.toChar val low = 0xDF62.toChar val highstring = high.toString val lowstring = low.toString //well-formed surrogate pairs are not split val highlow = highstring + lowstring highlow.split(high) //returns Array(highlow) //bare surrogate characters are split val bare = "_" + highstring + "_" bare.split(high) //returns Array("_", "_")
Splits this string into two at a given position.
Splits this string into two at a given position.
Note: c splitAt n is equivalent to (c take n, c drop n).
- Value Params
- n
the position at which to split.
- Returns
a pair of strings consisting of the first
nchars of this string, and the other chars.- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Stepper can be used with Java 8 Streams.
Stepper can be used with Java 8 Streams. This method is equivalent to a call to charStepper. See also codePointStepper.
Strip the trailing line separator from this string if there is one.
Strip the trailing line separator from this string if there is one.
The line separator is taken as "\n", "\r", or "\r\n".
For every line in this string:
For every line in this string:
Strip a leading prefix consisting of blanks or control characters
followed by marginChar from the line.
For every line in this string:
For every line in this string:
Strip a leading prefix consisting of blanks or control characters
followed by | from the line.
Returns this string with the given prefix stripped.
Returns this string with the given prefix stripped. If this string does not
start with prefix, it is returned unchanged.
Returns this string with the given suffix stripped.
Returns this string with the given suffix stripped. If this string does not
end with suffix, it is returned unchanged.
The rest of the string without its first char.
The rest of the string without its first char.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Iterates over the tails of this string.
Iterates over the tails of this string. The first value will be this
string and the final one will be an empty string, with the intervening
values the results of successive applications of tail.
- Returns
an iterator over all the tails of this string
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
A string containing the first n chars of this string.
A string containing the first n chars of this string.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
A string containing the last n chars of this string.
A string containing the last n chars of this string.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Takes longest prefix of chars that satisfy a predicate.
Takes longest prefix of chars that satisfy a predicate.
Try to parse as a Boolean
Try to parse as a Boolean
- Returns
Some(true)if the string is "true" case insensitive,Some(false)if the string is "false" case insensitive, andNoneif the string is anything else- Throws
- java.lang.NullPointerException
if the string is
null
Parse as a Byte (string must contain only decimal digits and optional leading - or +).
Parse as a Byte (string must contain only decimal digits and optional leading - or +).
- Throws
- java.lang.NumberFormatException
If the string does not contain a parsable
Byte.
Try to parse as a Byte
Try to parse as a Byte
- Returns
Some(value)if the string contains a valid byte value, otherwiseNone- Throws
- java.lang.NullPointerException
if the string is
null
Parse as a Double (surrounding whitespace is removed with a trim).
Parse as a Double (surrounding whitespace is removed with a trim).
- Throws
- java.lang.NullPointerException
If the string is null.
- java.lang.NumberFormatException
If the string does not contain a parsable
Double.
Try to parse as a Double
Try to parse as a Double
- Returns
Some(value)if the string is a parsableDouble,Noneotherwise- Throws
- java.lang.NullPointerException
If the string is null
Parse as a Float (surrounding whitespace is removed with a trim).
Parse as a Float (surrounding whitespace is removed with a trim).
- Throws
- java.lang.NullPointerException
If the string is null.
- java.lang.NumberFormatException
If the string does not contain a parsable
Float.
Try to parse as a Float
Try to parse as a Float
- Returns
Some(value)if the string is a parsableFloat,Noneotherwise- Throws
- java.lang.NullPointerException
If the string is null
Parse as an Int (string must contain only decimal digits and optional leading - or +).
Parse as an Int (string must contain only decimal digits and optional leading - or +).
- Throws
- java.lang.NumberFormatException
If the string does not contain a parsable
Int.
Try to parse as an Int
Try to parse as an Int
- Returns
Some(value)if the string contains a valid Int value, otherwiseNone- Throws
- java.lang.NullPointerException
if the string is
null
Parse as a Long (string must contain only decimal digits and optional leading - or +).
Parse as a Long (string must contain only decimal digits and optional leading - or +).
- Throws
- java.lang.NumberFormatException
If the string does not contain a parsable
Long.
Try to parse as a Long
Try to parse as a Long
- Returns
Some(value)if the string contains a valid long value, otherwiseNone- Throws
- java.lang.NullPointerException
if the string is
null
Parse as a Short (string must contain only decimal digits and optional leading - or +).
Parse as a Short (string must contain only decimal digits and optional leading - or +).
- Throws
- java.lang.NumberFormatException
If the string does not contain a parsable
Short.
Try to parse as a Short
Try to parse as a Short
- Returns
Some(value)if the string contains a valid short value, otherwiseNone- Throws
- java.lang.NullPointerException
if the string is
null
A copy of this string with one single replaced element.
A copy of this string with one single replaced element.
- Value Params
- elem
the replacing element
- index
the position of the replacement
- Returns
a new string which is a copy of this string with the element at position
indexreplaced byelem.- Throws
- IndexOutOfBoundsException
if
indexdoes not satisfy0 <= index < length.
- Note
This method treats a string as a plain sequence of Char code units and makes no attempt to keep surrogate pairs or codepoint sequences together. The user is responsible for making sure such cases are handled correctly. Failing to do so may result in an invalid Unicode string.
Creates a non-strict filter of this string.
Creates a non-strict filter of this string.
- Value Params
- p
the predicate used to test elements.
- Returns
an object of class
stringOps.WithFilter, which supportsmap,flatMap,foreach, andwithFilteroperations. All these operations apply to those chars of this string which satisfy the predicatep.- Note
the difference between
c filter pandc withFilter pis that the former creates a new string, whereas the latter only restricts the domain of subsequentmap,flatMap,foreach, andwithFilteroperations.
Deprecated methods
Return all lines in this string in an iterator, excluding trailing line
end characters; i.e., apply .stripLineEnd to all lines
returned by linesWithSeparators.
Return all lines in this string in an iterator, excluding trailing line
end characters; i.e., apply .stripLineEnd to all lines
returned by linesWithSeparators.
- Deprecated
Replace all literal occurrences of literal with the literal string replacement.
Replace all literal occurrences of literal with the literal string replacement.
This method is equivalent to java.lang.String#replace.
- Value Params
- literal
the string which should be replaced everywhere it occurs
- replacement
the replacement string
- Returns
the resulting string
- Deprecated