Packages

final class StringOps extends AnyVal

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.

Source
StringOps.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringOps
  2. AnyVal
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StringOps(s: String)

Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    Any
  3. def *(n: Int): String

    Return the current string concatenated n times.

  4. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from StringOps toany2stringadd[StringOps] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ++(xs: String): String

    Alias for concat

  6. def ++(suffix: IterableOnce[Char]): String

    Alias for concat

    Alias for concat

    Annotations
    @inline()
  7. def ++[B >: Char](suffix: Iterable[B]): immutable.IndexedSeq[B]

    Alias for concat

    Alias for concat

    Annotations
    @inline()
  8. def ++:(prefix: String): String

    Alias for prependedAll

    Alias for prependedAll

    Annotations
    @inline()
  9. def ++:[B >: Char](prefix: IterableOnce[B]): immutable.IndexedSeq[B]

    Alias for prependedAll

    Alias for prependedAll

    Annotations
    @inline()
  10. def +:(c: Char): String

    Alias for prepended

    Alias for prepended

    Annotations
    @inline()
  11. def +:[B >: Char](elem: B): immutable.IndexedSeq[B]

    Alias for prepended

    Alias for prepended

    Annotations
    @inline()
  12. def ->[B](y: B): (StringOps, B)
    Implicit
    This member is added by an implicit conversion from StringOps toArrowAssoc[StringOps] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  13. def :+(c: Char): String

    Alias for appended

    Alias for appended

    Annotations
    @inline()
  14. def :+[B >: Char](elem: B): immutable.IndexedSeq[B]

    Alias for appended

    Alias for appended

    Annotations
    @inline()
  15. def :++(suffix: String): String

    Alias for appendedAll

    Alias for appendedAll

    Annotations
    @inline()
  16. def :++[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

    Alias for appendedAll

    Alias for appendedAll

    Annotations
    @inline()
  17. def <(that: String): Boolean

    Returns true if this is less than that

  18. def <=(that: String): Boolean

    Returns true if this is less than or equal to that.

  19. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  20. def >(that: String): Boolean

    Returns true if this is greater than that.

  21. def >=(that: String): Boolean

    Returns true if this is greater than or equal to that.

  22. final def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder

    Appends this string to a string builder using start, end and separator strings.

  23. final def addString(b: mutable.StringBuilder, sep: String): mutable.StringBuilder

    Appends this string to a string builder using a separator string.

    Appends this string to a string builder using a separator string.

    Annotations
    @inline()
  24. final def addString(b: mutable.StringBuilder): mutable.StringBuilder

    Appends this string to a string builder.

    Appends this string to a string builder.

    Annotations
    @inline()
  25. def appended(c: Char): String

    A copy of the string with an element appended

  26. def appended[B >: Char](elem: B): immutable.IndexedSeq[B]

    A copy of the string with an element appended

  27. def appendedAll(suffix: String): String

    A copy of the string with another string appended

    A copy of the string with another string appended

    Annotations
    @inline()
  28. def appendedAll[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

    A copy of the string with all elements from a collection appended

    A copy of the string with all elements from a collection appended

    Annotations
    @inline()
  29. def apply(i: Int): Char

    Get the char at the specified index.

    Get the char at the specified index.

    Annotations
    @inline()
  30. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  31. def capitalize: String

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

  32. def charStepper: IntStepper with EfficientSplit

    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.

    Annotations
    @inline()
  33. def codePointStepper: IntStepper with EfficientSplit

    Steps over code points in this string.

    Steps over code points in this string.

    Annotations
    @inline()
  34. def collect[B](pf: PartialFunction[Char, B]): immutable.IndexedSeq[B]

    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.

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the String.

    returns

    a new collection resulting from applying the given partial function pf to each char on which it is defined and collecting the results.

  35. def collect(pf: PartialFunction[Char, Char]): String

    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.

    pf

    the partial function which filters and maps the String.

    returns

    a new String resulting from applying the given partial function pf to each char on which it is defined and collecting the results.

  36. def combinations(n: Int): Iterator[String]

    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.

    Example:
    1. "abbbc".combinations(2) = Iterator(ab, ac, bb, bc)

    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.

  37. def compare(that: String): Int
  38. def concat(suffix: String): String

    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.

    suffix

    the string to append.

    returns

    a new string which contains all chars of this string followed by all chars of suffix.

    Annotations
    @inline()
  39. def concat(suffix: IterableOnce[Char]): String

    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.

    suffix

    the collection to append.

    returns

    a new string which contains all chars of this string followed by all chars of suffix.

  40. def concat[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

    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.

    suffix

    the collection to append.

    returns

    a new collection which contains all chars of this string followed by all elements of suffix.

  41. def contains(elem: Char): Boolean

    Tests whether this string contains the given character.

    Tests whether this string contains the given character.

    elem

    the character to test.

    returns

    true if this string has an element that is equal (as determined by ==) to elem, false otherwise.

  42. def copyToArray(xs: Array[Char], start: Int, len: Int): Int

    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.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

  43. def copyToArray(xs: Array[Char], start: Int): Int

    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

    xs

    the array to fill.

    start

    the starting index.

    Annotations
    @inline()
  44. def copyToArray(xs: Array[Char]): Int

    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

    xs

    the array to fill.

    Annotations
    @inline()
  45. def count(p: (Char) => Boolean): Int

    Counts the number of chars in this string which satisfy a predicate

  46. def diff[B >: Char](that: Seq[B]): String

    Computes the multiset difference between this string and another sequence.

    Computes the multiset difference between this string and another sequence.

    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 value x appears n times in that, then the first n occurrences of x will 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.

  47. def distinct: 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.

  48. def distinctBy[B](f: (Char) => B): 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.

    B

    the type of the elements after being transformed by f

    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.

  49. def drop(n: Int): 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.

  50. def dropRight(n: Int): 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.

  51. def dropWhile(p: (Char) => Boolean): String

    Drops longest prefix of chars that satisfy a predicate.

    Drops longest prefix of chars that satisfy a predicate.

    p

    The predicate used to test elements.

    returns

    the longest suffix of this string whose first element does not satisfy the predicate p.

  52. def ensuring(cond: (StringOps) => Boolean, msg: => Any): StringOps
    Implicit
    This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  53. def ensuring(cond: (StringOps) => Boolean): StringOps
    Implicit
    This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  54. def ensuring(cond: Boolean, msg: => Any): StringOps
    Implicit
    This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  55. def ensuring(cond: Boolean): StringOps
    Implicit
    This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  56. def exists(p: (Char) => Boolean): Boolean

    Tests whether a predicate holds for at least one char of this string.

  57. def filter(pred: (Char) => Boolean): String

    Selects all chars of this string which satisfy a predicate.

  58. def filterNot(pred: (Char) => Boolean): String

    Selects all chars of this string which do not satisfy a predicate.

    Selects all chars of this string which do not satisfy a predicate.

    Annotations
    @inline()
  59. def find(p: (Char) => Boolean): Option[Char]

    Finds the first char of the string satisfying a predicate, if any.

    Finds the first char of the string satisfying a predicate, if any.

    p

    the predicate used to test elements.

    returns

    an option value containing the first element in the string that satisfies p, or None if none exists.

  60. def flatMap(f: (Char) => String): String

    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.

    f

    the function to apply to each char.

    returns

    a new string resulting from applying the given string-valued function f to each char of this string and concatenating the results.

  61. def flatMap[B](f: (Char) => IterableOnce[B]): immutable.IndexedSeq[B]

    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.

    f

    the function to apply to each char.

    returns

    a new collection resulting from applying the given collection-valued function f to each char of this string and concatenating the results.

  62. def fold[A1 >: Char](z: A1)(op: (A1, A1) => A1): A1

    Folds the chars of this string using the specified associative binary operator.

    Folds the chars of this string using the specified associative binary operator.

    A1

    a type parameter for the binary operator, a supertype of Char.

    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., Nil for list concatenation, 0 for addition, or 1 for multiplication).

    op

    a binary operator that must be associative.

    returns

    the result of applying the fold operator op between all the chars and z, or z if this string is empty.

    Annotations
    @inline()
  63. def foldLeft[B](z: B)(op: (B, Char) => B): B

    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.

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive chars of this string, going left to right with the start value z on the left:

    op(...op(z, x_1), x_2, ..., x_n)

    where x1, ..., xn are the chars of this string. Returns z if this string is empty.

  64. def foldRight[B](z: B)(op: (Char, B) => B): B

    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.

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive chars of this string, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))

    where x1, ..., xn are the chars of this string. Returns z if this string is empty.

  65. def forall(p: (Char) => Boolean): Boolean

    Tests whether a predicate holds for all chars of this string.

    Tests whether a predicate holds for all chars of this string.

    p

    the predicate used to test elements.

    returns

    true if this string is empty or the given predicate p holds for all chars of this string, otherwise false.

  66. def foreach[U](f: (Char) => U): Unit

    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.

  67. def format(args: Any*): String

    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.

    args

    the arguments used to instantiating the pattern.

    Exceptions thrown
  68. def formatLocal(l: Locale, args: Any*): String

    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.

    l

    an instance of java.util.Locale

    args

    the arguments used to instantiating the pattern.

    Exceptions thrown
  69. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit
    This member is added by an implicit conversion from StringOps toStringFormat[StringOps] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  70. def getClass(): Class[_ <: AnyVal]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    AnyValAny
  71. def groupBy[K](f: (Char) => K): immutable.Map[K, String]

    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.

    K

    the type of keys returned by the discriminator function.

    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 k is bound to a string of those elements x for which f(x) equals k.

    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.

  72. def grouped(size: Int): Iterator[String]

    Partitions elements in fixed size strings.

    Partitions elements in fixed size strings.

    size

    the number of elements per group

    returns

    An iterator producing strings of size size, except the last will be less than size size if the elements don't divide evenly.

    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.

    See also

    scala.collection.Iterator, method grouped

  73. def head: Char

    Selects the first char of this string.

    Selects the first char of this string.

    returns

    the first char of this string.

    Exceptions thrown

    NoSuchElementException if the string is empty.

  74. def headOption: Option[Char]

    Optionally selects the first char.

    Optionally selects the first char.

    returns

    the first char of this string if it is nonempty, None if it is empty.

  75. def indexWhere(p: (Char) => Boolean, from: Int = 0): Int

    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.

    p

    the predicate used to test elements.

    from

    the start index

    returns

    the index >= from of the first element of this string that satisfies the predicate p, or -1, if none exists.

  76. def indices: Range

    Produces the range of all indices of this string.

    Produces the range of all indices of this string.

    returns

    a Range value from 0 to one less than the length of this string.

  77. def init: 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.

  78. def inits: Iterator[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.

  79. def intersect[B >: Char](that: Seq[B]): String

    Computes the multiset intersection between this string and another sequence.

    Computes the multiset intersection between this string and another sequence.

    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 value x appears n times in that, then the first n occurrences of x will 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.

  80. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  81. def iterator: Iterator[Char]

    Iterator can be used only once

  82. def knownSize: Int
    Annotations
    @inline()
  83. def last: Char

    Selects the last char of this string.

    Selects the last char of this string.

    returns

    the last char of this string.

    Exceptions thrown

    NoSuchElementException if the string is empty.

  84. def lastIndexWhere(p: (Char) => Boolean, end: Int = Int.MaxValue): Int

    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.

    p

    the predicate used to test elements.

    end

    the end index

    returns

    the index <= end of the last element of this string that satisfies the predicate p, or -1, if none exists.

  85. def lastOption: Option[Char]

    Optionally selects the last char.

    Optionally selects the last char.

    returns

    the last char of this string if it is nonempty, None if it is empty.

  86. def lazyZip[B](that: Iterable[B]): LazyZip2[Char, B, String]

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

    the type of the second element in each eventual pair

    that

    the iterable providing the second element of each eventual pair

    returns

    a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.

  87. def lengthCompare(len: Int): Int
  88. def lengthIs: Int
  89. def linesIterator: Iterator[String]

    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.

  90. def linesWithSeparators: Iterator[String]

    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.

  91. def map(f: (Char) => Char): String

    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.

    f

    the function to apply to each char.

    returns

    a new string resulting from applying the given function f to each char of this string and collecting the results.

  92. def map[B](f: (Char) => B): immutable.IndexedSeq[B]

    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.

    f

    the function to apply to each char.

    returns

    a new collection resulting from applying the given function f to each char of this string and collecting the results.

  93. final def mkString: String

    Returns this string

    Returns this string

    Annotations
    @inline()
  94. final def mkString(sep: String): 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.

    sep

    the separator string.

    returns

    In the resulting string the chars of this string are separated by the string sep.

    Annotations
    @inline()
    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.

  95. final def mkString(start: String, sep: String, end: String): String

    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.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    The resulting string begins with the string start and ends with the string end. Inside, the string 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.

  96. def nonEmpty: Boolean

    Tests whether the string is not empty.

    Tests whether the string is not empty.

    Annotations
    @inline()
  97. def padTo(len: Int, elem: Char): String

    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.

    len

    the target length

    elem

    the padding value

    returns

    a string consisting of this string followed by the minimal number of occurrences of elem so that the resulting string has a length of at least len.

  98. def padTo[B >: Char](len: Int, elem: B): immutable.IndexedSeq[B]

    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.

    len

    the target length

    elem

    the padding value

    returns

    a collection consisting of this string followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

  99. def partition(p: (Char) => Boolean): (String, String)

    A pair of, first, all chars that satisfy predicate p and, second, all chars that do not.

  100. def partitionMap(f: (Char) => Either[Char, Char]): (String, String)

    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")
    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 f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

  101. def patch(from: Int, other: String, replaced: Int): 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.

    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 replaced chars starting from from are replaced by other.

    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.

  102. def patch(from: Int, other: IterableOnce[Char], replaced: Int): String

    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.

    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 replaced chars starting from from are replaced by other.

    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.

  103. def patch[B >: Char](from: Int, other: IterableOnce[B], replaced: Int): immutable.IndexedSeq[B]

    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.

    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 replaced chars starting from from are replaced by other.

  104. def permutations: Iterator[String]

    Iterates over distinct permutations.

    Iterates over distinct permutations.

    returns

    An Iterator which traverses the distinct permutations of this string.

    Example:
    1. "abb".permutations = Iterator(abb, bab, bba)

    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.

  105. def prepended(c: Char): String

    A copy of the string with an char prepended

  106. def prepended[B >: Char](elem: B): immutable.IndexedSeq[B]

    A copy of the string with an element prepended

  107. def prependedAll(prefix: String): String

    A copy of the string with another string prepended

  108. def prependedAll[B >: Char](prefix: IterableOnce[B]): immutable.IndexedSeq[B]

    A copy of the string with all elements from a collection prepended

  109. def r(groupNames: String*): Regex

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

    groupNames

    The names of the groups in the pattern, in the order they appear.

  110. def r: Regex

    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.

  111. def reverse: String

    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.

  112. def reverseIterator: Iterator[Char]

    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

  113. def size: Int
    Annotations
    @inline()
  114. def sizeCompare(otherSize: Int): Int
  115. def sizeIs: Int
  116. def slice(from: Int, until: Int): String

    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
    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 from extending up to (but not including) index until 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.

  117. def sliding(size: Int, step: Int = 1): Iterator[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.)

    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 than size chars remaining to be 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.

    See also

    scala.collection.Iterator, method sliding

  118. def sortBy[B](f: (Char) => B)(implicit ord: Ordering[B]): 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.

    B

    the target type of the transformation f, and the type where the ordering ord is defined.

    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 < y if ord.lt(f(x), f(y)).

    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.

    See also

    scala.math.Ordering

  119. def sortWith(lt: (Char, Char) => Boolean): 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.

    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.

  120. def sorted[B >: Char](implicit ord: Ordering[B]): 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.

    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.

    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.

    See also

    scala.math.Ordering

  121. def span(p: (Char) => Boolean): (String, 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.

    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.

  122. def split(separators: Array[Char]): Array[String]
    Annotations
    @throws(clazz = classOf[java.util.regex.PatternSyntaxException])
  123. def split(separator: Char): Array[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)

    separator

    the character used as a delimiter

    Example:
    1. "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("_", "_")
  124. def splitAt(n: Int): (String, String)

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

    n

    the position at which to split.

    returns

    a pair of strings consisting of the first n chars 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.

  125. def stepper: IntStepper with EfficientSplit

    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.

    Annotations
    @inline()
  126. def stripLineEnd: String

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

  127. def stripMargin: String

    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.

  128. def stripMargin(marginChar: Char): String

    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.

  129. def stripPrefix(prefix: String): String

    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.

  130. def stripSuffix(suffix: String): String

    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.

  131. def tail: String

    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.

  132. def tails: Iterator[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.

  133. def take(n: Int): 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.

  134. def takeRight(n: Int): 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.

  135. def takeWhile(p: (Char) => Boolean): String

    Takes longest prefix of chars that satisfy a predicate.

  136. def toArray[B >: Char](implicit tag: ClassTag[B]): Array[B]
  137. def toBoolean: Boolean

    Exceptions thrown

    java.lang.IllegalArgumentException If the string does not contain a parsable Boolean.

  138. def toBooleanOption: Option[Boolean]

    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, and None if the string is anything else

    Exceptions thrown

    java.lang.NullPointerException if the string is null

  139. def toByte: Byte

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

    Exceptions thrown

    java.lang.NumberFormatException If the string does not contain a parsable Byte.

  140. def toByteOption: Option[Byte]

    Try to parse as a Byte

    Try to parse as a Byte

    returns

    Some(value) if the string contains a valid byte value, otherwise None

    Exceptions thrown

    java.lang.NullPointerException if the string is null

  141. def toDouble: Double

    Parse as a Double (surrounding whitespace is removed with a trim).

    Parse as a Double (surrounding whitespace is removed with a trim).

    Exceptions thrown

    java.lang.NullPointerException If the string is null.

    java.lang.NumberFormatException If the string does not contain a parsable Double.

  142. def toDoubleOption: Option[Double]

    Try to parse as a Double

    Try to parse as a Double

    returns

    Some(value) if the string is a parsable Double, None otherwise

    Exceptions thrown

    java.lang.NullPointerException If the string is null

  143. def toFloat: Float

    Parse as a Float (surrounding whitespace is removed with a trim).

    Parse as a Float (surrounding whitespace is removed with a trim).

    Exceptions thrown

    java.lang.NullPointerException If the string is null.

    java.lang.NumberFormatException If the string does not contain a parsable Float.

  144. def toFloatOption: Option[Float]

    Try to parse as a Float

    Try to parse as a Float

    returns

    Some(value) if the string is a parsable Float, None otherwise

    Exceptions thrown

    java.lang.NullPointerException If the string is null

  145. def toInt: Int

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

    Exceptions thrown

    java.lang.NumberFormatException If the string does not contain a parsable Int.

  146. def toIntOption: Option[Int]

    Try to parse as an Int

    Try to parse as an Int

    returns

    Some(value) if the string contains a valid Int value, otherwise None

    Exceptions thrown

    java.lang.NullPointerException if the string is null

  147. def toLong: Long

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

    Exceptions thrown

    java.lang.NumberFormatException If the string does not contain a parsable Long.

  148. def toLongOption: Option[Long]

    Try to parse as a Long

    Try to parse as a Long

    returns

    Some(value) if the string contains a valid long value, otherwise None

    Exceptions thrown

    java.lang.NullPointerException if the string is null

  149. def toShort: Short

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

    Exceptions thrown

    java.lang.NumberFormatException If the string does not contain a parsable Short.

  150. def toShortOption: Option[Short]

    Try to parse as a Short

    Try to parse as a Short

    returns

    Some(value) if the string contains a valid short value, otherwise None

    Exceptions thrown

    java.lang.NullPointerException if the string is null

  151. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    Definition Classes
    Any
  152. def updated(index: Int, elem: Char): String

    A copy of this string with one single replaced element.

    A copy of this string with one single replaced element.

    index

    the position of the replacement

    elem

    the replacing element

    returns

    a new string which is a copy of this string with the element at position index replaced by elem.

    Exceptions thrown

    IndexOutOfBoundsException if index does not satisfy 0 <= 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.

  153. def view: StringView
    Annotations
    @inline()
  154. def withFilter(p: (Char) => Boolean): StringOps.WithFilter

    Creates a non-strict filter of this string.

    Creates a non-strict filter of this string.

    p

    the predicate used to test elements.

    returns

    an object of class stringOps.WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those chars of this string which satisfy the predicate p.

    Note

    the difference between c filter p and c withFilter p is that the former creates a new string, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

Deprecated Value Members

  1. def lines: Iterator[String]

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use linesIterator, because JDK 11 adds a lines method on String

  2. def replaceAllLiterally(literal: String, replacement: String): String

    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(CharSequence,CharSequence).

    literal

    the string which should be replaced everywhere it occurs

    replacement

    the replacement string

    returns

    the resulting string

    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.2) Use s.replace as an exact replacement

  3. def [B](y: B): (StringOps, B)
    Implicit
    This member is added by an implicit conversion from StringOps toArrowAssoc[StringOps] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd fromStringOps to any2stringadd[StringOps]

Inherited by implicit conversion StringFormat fromStringOps to StringFormat[StringOps]

Inherited by implicit conversion Ensuring fromStringOps to Ensuring[StringOps]

Inherited by implicit conversion ArrowAssoc fromStringOps to ArrowAssoc[StringOps]

Ungrouped