scala.collection.immutable

# StringLike

#### trait StringLike [+Repr] extends IndexedSeqOptimized[Char, Repr] with Ordered[String]

A trait describing stringlike collections.

Repr

  The type of the actual collection inheriting `StringLike`.

Self Type
  StringLike[Repr]
Source
  StringLike.scala
Since

  2.8

Linear Supertypes
Ordered[String], Comparable[String], IndexedSeqOptimized[Char, Repr], IndexedSeqLike[Char, Repr], SeqLike[Char, Repr], GenSeqLike[Char, Repr], IterableLike[Char, Repr], GenIterableLike[Char, Repr], TraversableLike[Char, Repr], GenTraversableLike[Char, Repr], Parallelizable[Char, ParSeq[Char]], TraversableOnce[Char], GenTraversableOnce[Char], FilterMonadic[Char, Repr], HasNewBuilder[Char, Repr], Equals, AnyRef, Any
Known Subclasses
StringBuilder, StringOps, WrappedString
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. StringLike
2. Ordered
3. Comparable
4. IndexedSeqOptimized
5. IndexedSeqLike
6. SeqLike
7. GenSeqLike
8. IterableLike
9. GenIterableLike
10. TraversableLike
11. GenTraversableLike
12. Parallelizable
13. TraversableOnce
14. GenTraversableOnce
15. FilterMonadic
16. HasNewBuilder
17. Equals
18. AnyRef
19. Any

Visibility

1. Public
2. All

### Type Members

1. #### class Elements extends BufferedIterator[A] with Serializable

   The class of the iterator returned by the `iterator` method.

2. #### type Self = Repr

   The type implementing this traversable

   The type implementing this traversable

   Attributes
     protected
   Definition Classes
     TraversableLike

3. #### class WithFilter extends FilterMonadic[A, Repr]

   A class supporting filtered operations.

### Abstract Value Members

1. #### def newBuilder : Builder[Char, Repr]

   Creates a string builder buffer as builder for this class

   Creates a string builder buffer as builder for this class

   Attributes
     protected[this] abstract
   Definition Classes
     StringLike → TraversableLike → HasNewBuilder

2. #### def seq : TraversableOnce[Char]

   Attributes
     abstract
   Definition Classes
     Parallelizable

### Concrete Value Members

1. #### def != (arg0: AnyRef): Boolean

   Attributes
     final
   Definition Classes
     AnyRef

2. #### def != (arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Attributes
     final
   Definition Classes
     Any

3. #### def ## (): Int

   Equivalent to `x.hashCode` except for boxed numeric types.

   Equivalent to `x.hashCode` except for boxed numeric types. 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.

   returns

     a hash value consistent with ==

   Attributes
     final
   Definition Classes
     AnyRef → Any

4. #### def * (n: Int): String

   Return the current string concatenated `n` times.

5. #### def ++ [B >: Char, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

   Definition Classes
     TraversableLike
   Annotations
     @bridge()

6. #### def ++ [B] (that: GenTraversableOnce[B]): String[B]

   [use case] Concatenates this string with the elements of a traversable collection.

   [use case]

   Concatenates this string with the elements of a traversable collection.

   B

     the element type of the returned collection.

   that

     the traversable to append.

   returns

     a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

   Attributes
     abstract
   Definition Classes
     GenTraversableLike

7. #### def ++ [B >: Char, That] (that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

   Concatenates this string with the elements of a traversable collection.

   Concatenates this string with the elements of a traversable collection.

   B

     the element type of the returned collection.

   That

     the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

   that

     the traversable to append.

   bf

     an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

   returns

     a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

   Definition Classes
     TraversableLike → GenTraversableLike

8. #### def ++: [B >: Char, That] (that: Traversable[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

   This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

   This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions. Since TraversableOnce has no '++' method, we have to implement that directly, but Traversable and down can use the overload.

   Definition Classes
     TraversableLike

9. #### def ++: [B] (that: TraversableOnce[B]): String[B]

   [use case] Concatenates this string with the elements of a traversable collection.

   [use case]

   Concatenates this string with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

   B

     the element type of the returned collection.

   that

     the traversable to append.

   returns

     a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

   Attributes
     abstract
   Definition Classes
     TraversableLike

10. #### def ++: [B >: Char, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

    Concatenates this string with the elements of a traversable collection.

    Concatenates this string with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

    B

      the element type of the returned collection.

    That

      the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

    that

      the traversable to append.

    bf

      an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

    returns

      a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

    Definition Classes
      TraversableLike

11. #### def +: (elem: Char): String[Char]

    [use case] Prepends an element to this string

    [use case]

    Prepends an element to this string

    elem

      the prepended element

    returns

      a new collection of type `That` consisting of `elem` followed by all elements of this string.

    Attributes
      abstract
    Definition Classes
      GenSeqLike

12. #### def +: [B >: Char, That] (elem: B)(implicit bf: CanBuildFrom[Repr, B, That]): That

    Prepends an element to this string

    Prepends an element to this string

    B

      the element type of the returned string.

    That

      the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

    elem

      the prepended element

    bf

      an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

    returns

      a new collection of type `That` consisting of `elem` followed by all elements of this string.

    Definition Classes
      SeqLike → GenSeqLike

13. #### def /: [B] (z: B)(op: (B, Char) ⇒ B): B

    Applies a binary operator to a start value and all elements of this string, going left to right.

    Applies a binary operator to a start value and all elements of this string, going left to right.

    Note: `/:` is alternate syntax for `foldLeft`; `z /: xs` is the same as `xs foldLeft z`.

    B

      the result type of the binary operator.

    z

      the start value.

    op

      the binary operator.

    returns

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

                      op(...op(op(z, x,,1,,), x,,2,,), ..., x,,n,,)

      where `x,,1,,, ..., x,,n,,` are the elements of this string.

    Definition Classes
      TraversableOnce → GenTraversableOnce

14. #### def /:\ [A1 >: Char] (z: A1)(op: (A1, A1) ⇒ A1): A1

    A syntactic sugar for out of order folding.

    A syntactic sugar for out of order folding. See `fold`.

    Definition Classes
      GenTraversableOnce

15. #### def :+ (elem: Char): String[Char]

    [use case] Appends an element to this string

    [use case]

    Appends an element to this string

    elem

      the appended element

    returns

      a new collection of type `That` consisting of all elements of this string followed by `elem`.

    Attributes
      abstract
    Definition Classes
      GenSeqLike

16. #### def :+ [B >: Char, That] (elem: B)(implicit bf: CanBuildFrom[Repr, B, That]): That

    Appends an element to this string

    Appends an element to this string

    B

      the element type of the returned string.

    That

      the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

    elem

      the appended element

    bf

      an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

    returns

      a new collection of type `That` consisting of all elements of this string followed by `elem`.

    Definition Classes
      SeqLike → GenSeqLike

17. #### def :\ [B] (z: B)(op: (Char, B) ⇒ B): B

    Applies a binary operator to all elements of this string and a start value, going right to left.

    Applies a binary operator to all elements of this string and a start value, going right to left.

    Note: `:\` is alternate syntax for `foldRight`; `xs :\ z` is the same as `xs foldRight z`.

    B

      the result type of the binary operator.

    z

      the start value

    op

      the binary operator

    returns

      the result of inserting `op` between consecutive elements 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 `x,,1,,, ..., x,,n,,` are the elements of this string.

    Definition Classes
      TraversableOnce → GenTraversableOnce

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

    Definition Classes
      Ordered

19. #### def <= (that: String): Boolean

    Definition Classes
      Ordered

20. #### def == (arg0: AnyRef): Boolean

    Attributes
      final
    Definition Classes
      AnyRef

21. #### def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

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

    Attributes
      final
    Definition Classes
      Any

22. #### def > (that: String): Boolean

    Definition Classes
      Ordered

23. #### def >= (that: String): Boolean

    Definition Classes
      Ordered

24. #### def addString (b: StringBuilder): StringBuilder

    Appends all elements of this string to a string builder.

    Appends all elements of this string to a string builder. The written text consists of the string representations (w.r.t. the method `toString`) of all elements of this string without any separator string.

    b

      the string builder to which elements are appended.

    returns

      the string builder `b` to which elements were appended.

    Definition Classes
      TraversableOnce

25. #### def addString (b: StringBuilder, sep: String): StringBuilder

    Appends all elements of this string to a string builder using a separator string.

    Appends all elements of this string to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method `toString`) of all elements of this string, separated by the string `sep`.

    b

      the string builder to which elements are appended.

    sep

      the separator string.

    returns

      the string builder `b` to which elements were appended.

    Definition Classes
      TraversableOnce

26. #### def addString (b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

    Appends all elements of this string to a string builder using start, end, and separator strings. The written text begins with the string `start` and ends with the string `end`. Inside, the string representations (w.r.t. the method `toString`) of all elements of this string are separated by the string `sep`.

    b

      the string builder to which elements are appended.

    start

      the starting string.

    sep

      the separator string.

    end

      the ending string.

    returns

      the string builder `b` to which elements were appended.

    Definition Classes
      TraversableOnce

27. #### def aggregate [B] (z: B)(seqop: (B, Char) ⇒ B, combop: (B, B) ⇒ B): B

    Aggregates the results of applying an operator to subsequent elements.

    Aggregates the results of applying an operator to subsequent elements.

    This is a more general form of `fold` and `reduce`. It has similar semantics, but does not require the result to be a supertype of the element type. It traverses the elements in different partitions sequentially, using `seqop` to update the result, and then applies `combop` to results from different partitions. The implementation of this operation may operate on an arbitrary number of collection partitions, so `combop` may be invoked arbitrary number of times.

    For example, one might want to process some elements and then produce a `Set`. In this case, `seqop` would process an element and append it to the list, while `combop` would concatenate two lists from different partitions together. The initial value `z` would be an empty set.

           pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)

    Another example is calculating geometric mean from a collection of doubles (one would typically require big doubles for this).

    z

      the initial value for the accumulated result of the partition - this will typically be the neutral element for the `seqop` operator (e.g. `Nil` for list concatenation or `0` for summation)

    seqop

      an operator used to accumulate results within a partition

    combop

      an associative operator used to combine results from different partitions

    Definition Classes
      TraversableOnce → GenTraversableOnce

28. #### def apply (n: Int): Char

    Return element at index `n`

    Return element at index `n`

    returns

      the element of this string at index `idx`, where `0` indicates the first element.

    Definition Classes
      StringLike → SeqLike → GenSeqLike

29. #### 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.

    Attributes
      final
    Definition Classes
      Any

30. #### def canEqual (that: Any): Boolean

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    that

      The object with which this string should be compared

    returns

      `true`, if this string can possibly equal `that`, `false` otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

    Definition Classes
      IterableLike → Equals

31. #### def capitalize : String

    Returns this string with first character converted to upper case

32. #### def clone (): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()

33. #### def collect [B] (pf: PartialFunction[Char, B]): String[B]

    [use case] Builds a new collection by applying a partial function to all elements of this string on which the function is defined.

    [use case]

    Builds a new collection by applying a partial function to all elements 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 of type `That` resulting from applying the partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

    Attributes
      abstract
    Definition Classes
      GenTraversableLike

34. #### def collect [B, That] (pf: PartialFunction[Char, B])(implicit bf: CanBuildFrom[Repr, B, That]): That

    Builds a new collection by applying a partial function to all elements of this string on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this string on which the function is defined.

    B

      the element type of the returned collection.

    That

      the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

    pf

      the partial function which filters and maps the string.

    bf

      an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

    returns

      a new collection of type `That` resulting from applying the partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

    Definition Classes
      TraversableLike → GenTraversableLike

35. #### def collectFirst [B] (pf: PartialFunction[Char, B]): Option[B]

    Finds the first element of the string for which the given partial function is defined, and applies the partial function to it.

    Finds the first element of the string for which the given partial function is defined, and applies the partial function to it.

    pf

      the partial function

    returns

      an option value containing pf applied to the first value for which it is defined, or `None` if none exists.

    Definition Classes
      TraversableOnce
    Example:

    1. `Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)`

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

    Iterates over combinations.

    Iterates over combinations.

    returns

      An Iterator which traverses the possible n-element combinations of this string.

    Definition Classes
      SeqLike
    Example:

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

37. #### def compare (other: String): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`. returns `x` where `x < 0` iff `this < that` `x == 0` iff `this == that` `x > 0` iff `this > that`

    Definition Classes
      StringLike → Ordered

38. #### def compareTo (that: String): Int

    Definition Classes
      Ordered → Comparable

39. #### def contains (elem: Any): Boolean

    Tests whether this string contains a given value as an element.

    Tests whether this string contains a given value as an element.

    elem

      the element to test.

    returns

      `true` if this string has an element that is is equal (wrt `==`) to `elem`, `false` otherwise.

    Definition Classes
      SeqLike

40. #### def containsSlice [B] (that: Seq[B]): Boolean

    Definition Classes
      SeqLike
    Annotations
      @bridge()

41. #### def containsSlice [B] (that: GenSeq[B]): Boolean

    Tests whether this string contains a given sequence as a slice.

    Tests whether this string contains a given sequence as a slice.

    that

      the sequence to test

    returns

      `true` if this string contains a slice with the same elements as `that`, otherwise `false`.

    Definition Classes
      SeqLike

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

    [use case] Copies elements of this string to an array.

    [use case]

    Copies elements of this string to an array. Fills the given array `xs` with at most `len` elements of this string, starting at position `start`. Copying will stop once either the end of the current string is reached, or the end of the array is reached, or `len` elements have been copied.

    xs

      the array to fill.

    start

      the starting index.

    len

      the maximal number of elements to copy.

    Attributes
      abstract
    Definition Classes
      TraversableLike

43. #### def copyToArray [B >: Char] (xs: Array[B], start: Int, len: Int): Unit

    Copies elements of this string to an array.

    Copies elements of this string to an array. Fills the given array `xs` with at most `len` elements of this string, starting at position `start`. Copying will stop once either the end of the current string is reached, or the end of the array is reached, or `len` elements have been copied.

    B

      the type of the elements of the array.

    xs

      the array to fill.

    start

      the starting index.

    len

      the maximal number of elements to copy.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

44. #### def copyToArray (xs: Array[Char]): Unit

    [use case] Copies values of this string to an array.

    [use case]

    Copies values of this string to an array. Fills the given array `xs` with values of this string. Copying will stop once either the end of the current string is reached, or the end of the array is reached.

    xs

      the array to fill.

    Attributes
      abstract
    Definition Classes
      GenTraversableOnce

45. #### def copyToArray [B >: Char] (xs: Array[B]): Unit

    Copies values of this string to an array.

    Copies values of this string to an array. Fills the given array `xs` with values of this string. Copying will stop once either the end of the current string is reached, or the end of the array is reached.

    B

      the type of the elements of the array.

    xs

      the array to fill.

    Definition Classes
      TraversableOnce → GenTraversableOnce

46. #### def copyToArray (xs: Array[Char], start: Int): Unit

    [use case] Copies values of this string to an array.

    [use case]

    Copies values of this string to an array. Fills the given array `xs` with values of this string, beginning at index `start`. Copying will stop once either the end of the current string is reached, or the end of the array is reached.

    xs

      the array to fill.

    start

      the starting index.

    Attributes
      abstract
    Definition Classes
      GenTraversableOnce

47. #### def copyToArray [B >: Char] (xs: Array[B], start: Int): Unit

    Copies values of this string to an array.

    Copies values of this string to an array. Fills the given array `xs` with values of this string, beginning at index `start`. Copying will stop once either the end of the current string is reached, or the end of the array is reached.

    B

      the type of the elements of the array.

    xs

      the array to fill.

    start

      the starting index.

    Definition Classes
      TraversableOnce → GenTraversableOnce

48. #### def copyToBuffer [B >: Char] (dest: Buffer[B]): Unit

    Copies all elements of this string to a buffer.

    Copies all elements of this string to a buffer.

    dest

      The buffer to which elements are copied.

    Definition Classes
      TraversableOnce

49. #### def corresponds [B] (that: Seq[B])(p: (Char, B) ⇒ Boolean): Boolean

    Definition Classes
      SeqLike
    Annotations
      @bridge()

50. #### def corresponds [B] (that: GenSeq[B])(p: (Char, B) ⇒ Boolean): Boolean

    Tests whether every element of this string relates to the corresponding element of another sequence by satisfying a test predicate.

    Tests whether every element of this string relates to the corresponding element of another sequence by satisfying a test predicate.

    B

      the type of the elements of `that`

    that

      the other sequence

    p

      the test predicate, which relates elements from both sequences

    returns

      `true` if both sequences have the same length and `p(x, y)` is `true` for all corresponding elements `x` of this string and `y` of `that`, otherwise `false`.

    Definition Classes
      SeqLike → GenSeqLike

51. #### def count (p: (Char) ⇒ Boolean): Int

    Counts the number of elements in the string which satisfy a predicate.

    Counts the number of elements in the string which satisfy a predicate.

    p

      the predicate used to test elements.

    returns

      the number of elements satisfying the predicate `p`.

    Definition Classes
      TraversableOnce → GenTraversableOnce

52. #### def diff [B >: Char] (that: Seq[B]): Repr

    Definition Classes
      SeqLike
    Annotations
      @bridge()

53. #### def diff (that: Seq[Char]): String[Char]

    [use case] Computes the multiset difference between this string and another sequence.

    [use case]

    Computes the multiset difference between this string and another sequence.

    that

      the sequence of elements to remove

    returns

      a new collection of type `That` which contains all elements 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.

    Attributes
      abstract
    Definition Classes
      SeqLike

54. #### def diff [B >: Char] (that: GenSeq[B]): Repr

    Computes the multiset difference between this string and another sequence.

    Computes the multiset difference between this string and another sequence.

    B

      the element type of the returned string.

    that

      the sequence of elements to remove

    returns

      a new collection of type `That` which contains all elements 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.

    Definition Classes
      SeqLike → GenSeqLike

55. #### def distinct : Repr

    Builds a new string from this string without any duplicate elements.

    Builds a new string from this string without any duplicate elements.

    returns

      A new string which contains the first occurrence of every element of this string.

    Definition Classes
      SeqLike → GenSeqLike

56. #### def drop (n: Int): Repr

    Selects all elements except first n ones.

    Selects all elements except first n ones.

    n

      the number of elements to drop from this string.

    returns

      a string consisting of all elements of this string except the first `n` ones, or else the empty string, if this string has less than `n` elements.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

57. #### def dropRight (n: Int): Repr

    Selects all elements except last n ones.

    Selects all elements except last n ones.

    n

      The number of elements to take

    returns

      a string consisting of all elements of this string except the last `n` ones, or else the empty string, if this string has less than `n` elements.

    Definition Classes
      IndexedSeqOptimized → IterableLike

58. #### def dropWhile (p: (Char) ⇒ Boolean): Repr

    Drops longest prefix of elements that satisfy a predicate.

    Drops longest prefix of elements 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`.

    Definition Classes
      IndexedSeqOptimized → TraversableLike → GenTraversableLike

59. #### def endsWith [B] (that: GenSeq[B]): Boolean

    Tests whether this string ends with the given sequence.

    Tests whether this string ends with the given sequence.

    that

      the sequence to test

    returns

      `true` if this string has `that` as a suffix, `false` otherwise.

    Definition Classes
      IndexedSeqOptimized → SeqLike → GenSeqLike

60. #### def endsWith [B] (that: Seq[B]): Boolean

    Definition Classes
      SeqLike
    Annotations
      @bridge()

61. #### def eq (arg0: AnyRef): Boolean

    Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

    Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an equivalence relation on non-null instances of `AnyRef`, and has three additional properties:

    - It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`.
    - For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`.
    - `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    Attributes
      final
    Definition Classes
      AnyRef

62. #### def equals (that: Any): Boolean

    The equals method for arbitrary sequences.

    The equals method for arbitrary sequences. Compares this sequence to some other object.

    that

      The object to compare the sequence to

    returns

      `true` if `that` is a sequence that has the same elements as this sequence in the same order, `false` otherwise

    Definition Classes
      GenSeqLike → Equals → AnyRef → Any

63. #### def exists (p: (Char) ⇒ Boolean): Boolean

    Tests whether a predicate holds for some of the elements of this string.

    Tests whether a predicate holds for some of the elements of this string.

    p

      the predicate used to test elements.

    returns

      `true` if the given predicate `p` holds for some of the elements of this string, otherwise `false`.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

64. #### def filter (p: (Char) ⇒ Boolean): Repr

    Selects all elements of this string which satisfy a predicate.

    Selects all elements of this string which satisfy a predicate.

    p

      the predicate used to test elements.

    returns

      a new string consisting of all elements of this string that satisfy the given predicate `p`. The order of the elements is preserved.

    Definition Classes
      TraversableLike → GenTraversableLike

65. #### def filterNot (p: (Char) ⇒ Boolean): Repr

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

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

    p

      the predicate used to test elements.

    returns

      a new string consisting of all elements of this string that do not satisfy the given predicate `p`. The order of the elements is preserved.

    Definition Classes
      TraversableLike → GenTraversableLike

66. #### def finalize (): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the `finalize` method is invoked, as well as the interaction between `finalize` and non-local returns and exceptions, are all platform dependent.

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()

67. #### def find (p: (Char) ⇒ Boolean): Option[Char]

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

    Finds the first element 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.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

68. #### def flatMap [B] (f: (Char) ⇒ GenTraversableOnce[B]): String[B]

    [use case] Builds a new collection by applying a function to all elements of this string and concatenating the results.

    [use case]

    Builds a new collection by applying a function to all elements of this string and concatenating the results.

    B

      the element type of the returned collection.

    f

      the function to apply to each element.

    returns

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

    Attributes
      abstract
    Definition Classes
      GenTraversableLike

69. #### def flatMap [B, That] (f: (Char) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

    Builds a new collection by applying a function to all elements of this string and concatenating the results.

    Builds a new collection by applying a function to all elements of this string and concatenating the results.

    B

      the element type of the returned collection.

    That

      the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

    f

      the function to apply to each element.

    bf

      an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

    returns

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

    Definition Classes
      TraversableLike → GenTraversableLike → FilterMonadic

70. #### def fold [A1 >: Char] (z: A1)(op: (A1, A1) ⇒ A1): A1

    Folds the elements of this sequence using the specified associative binary operator.

    Folds the elements of this sequence using the specified associative binary operator. The order in which the elements are reduced is unspecified and may be nondeterministic.

    Note this method has a different signature than the `foldLeft` and `foldRight` methods of the trait `Traversable`. The result of folding may only be a supertype of this parallel collection's type parameter `T`.

    z

      a neutral element for the fold operation, it may be added to the result an arbitrary number of times, not changing 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 fold operator `op` between all the elements and `z`

    Definition Classes
      TraversableOnce → GenTraversableOnce

71. #### def foldLeft [B] (z: B)(op: (B, Char) ⇒ B): B

    Applies a binary operator to a start value and all elements of this string, going left to right.

    Applies a binary operator to a start value and all elements 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 elements 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 `x,,1,,, ..., x,,n,,` are the elements of this string.

    Definition Classes
      IndexedSeqOptimized → TraversableOnce → GenTraversableOnce

72. #### def foldRight [B] (z: B)(op: (Char, B) ⇒ B): B

    Applies a binary operator to all elements of this string and a start value, going right to left.

    Applies a binary operator to all elements 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 elements 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 `x,,1,,, ..., x,,n,,` are the elements of this string.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce

73. #### def forall (p: (Char) ⇒ Boolean): Boolean

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

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

    p

      the predicate used to test elements.

    returns

      `true` if the given predicate `p` holds for all elements of this string, otherwise `false`.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

74. #### def foreach (f: (Char) ⇒ Unit): Unit

    [use case] Applies a function `f` to all elements of this string.

    [use case]

    Applies a function `f` to all elements of this string.

    f

      the function that is applied for its side-effect to every element. The result of function `f` is discarded.

    Attributes
      abstract
    Definition Classes
      IterableLike

75. #### def foreach [U] (f: (Char) ⇒ U): Unit

    Applies a function `f` to all elements of this string.

    Applies a function `f` to all elements of this string.

    Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

    U

      the type parameter describing the result of function `f`. This result will always be ignored. Typically `U` is `Unit`, but this is not necessary.

    f

      the function that is applied for its side-effect to every element. The result of function `f` is discarded.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic

76. #### 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.

77. #### 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.

    args

      the arguments used to instantiating the pattern.

78. #### def getClass (): java.lang.Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    Attributes
      final
    Definition Classes
      AnyRef → Any

79. #### def groupBy [K] (f: (Char) ⇒ K): Map[K, Repr]

    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.

    Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new string.

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

    Definition Classes
      TraversableLike → GenTraversableLike

80. #### def grouped (size: Int): Iterator[Repr]

    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 truncated if the elements don't divide evenly.

    Definition Classes
      IterableLike
    See also

      Iterator#grouped

81. #### def hasDefiniteSize : Boolean

    Tests whether this string is known to have a finite size.

    Tests whether this string is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as `Stream`, the predicate returns `true` if all elements have been computed. It returns `false` if the stream is not yet evaluated to the end.

    Note: many collection methods will not work on collections of infinite sizes.

    returns

      `true` if this collection is known to have finite size, `false` otherwise.

    Definition Classes
      TraversableLike → TraversableOnce → GenTraversableOnce

82. #### def hashCode (): Int

    Hashcodes for String produce a value from the hashcodes of all the elements of the string.

    Hashcodes for String produce a value from the hashcodes of all the elements of the string.

    returns

      the hash code value for this object.

    Definition Classes
      GenSeqLike → AnyRef → Any

83. #### def head : Char

    Selects the first element of this string.

    Selects the first element of this string.

    returns

      the first element of this string.

    Definition Classes
      IndexedSeqOptimized → IterableLike → GenIterableLike → TraversableLike → GenTraversableLike

84. #### def headOption : Option[Char]

    Optionally selects the first element.

    Optionally selects the first element.

    returns

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

    Definition Classes
      TraversableLike

85. #### def indexOf (elem: Char, from: Int): Int

    [use case] Finds index of first occurrence of some value in this string after or at some start index.

    [use case]

    Finds index of first occurrence of some value in this string after or at some start index.

    elem

      the element value to search for.

    from

      the start index

    returns

      the index `>= from` of the first element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

    Attributes
      abstract
    Definition Classes
      GenSeqLike

86. #### def indexOf [B >: Char] (elem: B, from: Int): Int

    Finds index of first occurrence of some value in this string after or at some start index.

    Finds index of first occurrence of some value in this string after or at some start index.

    B

      the type of the element `elem`.

    elem

      the element value to search for.

    from

      the start index

    returns

      the index `>= from` of the first element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

    Definition Classes
      GenSeqLike

87. #### def indexOf (elem: Char): Int

    [use case] Finds index of first occurrence of some value in this string.

    [use case]

    Finds index of first occurrence of some value in this string.

    elem

      the element value to search for.

    returns

      the index of the first element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

    Attributes
      abstract
    Definition Classes
      GenSeqLike

88. #### def indexOf [B >: Char] (elem: B): Int

    Finds index of first occurrence of some value in this string.

    Finds index of first occurrence of some value in this string.

    B

      the type of the element `elem`.

    elem

      the element value to search for.

    returns

      the index of the first element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

    Definition Classes
      GenSeqLike

89. #### def indexOfSlice [B >: Char] (that: Seq[B], from: Int): Int

    Definition Classes
      SeqLike
    Annotations
      @bridge()

90. #### def indexOfSlice [B >: Char] (that: GenSeq[B], from: Int): Int

    Finds first index after or at a start index where this string contains a given sequence as a slice.

    Finds first index after or at a start index where this string contains a given sequence as a slice.

    that

      the sequence to test

    from

      the start index

    returns

      the first index `>= from` such that the elements of this string starting at this index match the elements of sequence `that`, or `-1` of no such subsequence exists.

    Definition Classes
      SeqLike

91. #### def indexOfSlice [B >: Char] (that: Seq[B]): Int

    Definition Classes
      SeqLike
    Annotations
      @bridge()

92. #### def indexOfSlice [B >: Char] (that: GenSeq[B]): Int

    Finds first index where this string contains a given sequence as a slice.

    Finds first index where this string contains a given sequence as a slice.

    that

      the sequence to test

    returns

      the first index such that the elements of this string starting at this index match the elements of sequence `that`, or `-1` of no such subsequence exists.

    Definition Classes
      SeqLike

93. #### def indexWhere (p: (Char) ⇒ Boolean, from: Int): Int

    Finds index of the first element satisfying some predicate after or at some start index.

    Finds index of the first element 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.

    Definition Classes
      IndexedSeqOptimized → SeqLike → GenSeqLike

94. #### def indexWhere (p: (Char) ⇒ Boolean): Int

    Finds index of first element satisfying some predicate.

    Finds index of first element satisfying some predicate.

    p

      the predicate used to test elements.

    returns

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

    Definition Classes
      GenSeqLike

95. #### def indices : Range

    Produces the range of all indices of this sequence.

    Produces the range of all indices of this sequence.

    returns

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

    Definition Classes
      SeqLike

96. #### def init : Repr

    Selects all elements except the last.

    Selects all elements except the last.

    returns

      a string consisting of all elements of this string except the last one.

    Definition Classes
      IndexedSeqOptimized → TraversableLike

97. #### def inits : Iterator[Repr]

    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

    Definition Classes
      TraversableLike
    Example:

    1. `List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)`

98. #### def intersect [B >: Char] (that: Seq[B]): Repr

    Definition Classes
      SeqLike
    Annotations
      @bridge()

99. #### def intersect (that: Seq[Char]): String[Char]

    [use case] Computes the multiset intersection between this string and another sequence.

    [use case]

    Computes the multiset intersection between this string and another sequence.

    that

      the sequence of elements to intersect with.

    returns

      a new collection of type `That` which contains all elements 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.

    Attributes
      abstract
    Definition Classes
      SeqLike

100. #### def intersect [B >: Char] (that: GenSeq[B]): Repr

     Computes the multiset intersection between this string and another sequence.

     Computes the multiset intersection between this string and another sequence.

     B

       the element type of the returned string.

     that

       the sequence of elements to intersect with.

     returns

       a new collection of type `That` which contains all elements 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.

     Definition Classes
       SeqLike → GenSeqLike

101. #### def isDefinedAt (idx: Int): Boolean

     Tests whether this string contains given index.

     Tests whether this string contains given index.

     The implementations of methods `apply` and `isDefinedAt` turn a `Seq[A]` into a `PartialFunction[Int, A]`.

     idx

       the index to test

     returns

       `true` if this string contains an element at position `idx`, `false` otherwise.

     Definition Classes
       GenSeqLike

102. #### def isEmpty : Boolean

     Tests whether the string is empty.

     Tests whether the string is empty.

     returns

       `true` if the string contains no elements, `false` otherwise.

     Definition Classes
       IndexedSeqOptimized → IterableLike → GenIterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

103. #### 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.

     Attributes
       final
     Definition Classes
       Any

104. #### def isTraversableAgain : Boolean

     Tests whether this string can be repeatedly traversed.

     Tests whether this string can be repeatedly traversed.

     returns

       `true`

     Attributes
       final
     Definition Classes
       GenTraversableLike → GenTraversableOnce

105. #### def iterator : Iterator[Char]

     Creates a new iterator over all elements contained in this iterable object.

     Creates a new iterator over all elements contained in this iterable object.

     returns

       the new iterator

     Definition Classes
       IndexedSeqLike → IterableLike → GenIterableLike

106. #### def last : Char

     Selects the last element.

     Selects the last element.

     returns

       The last element of this string.

     Definition Classes
       IndexedSeqOptimized → TraversableLike

107. #### def lastIndexOf (elem: Char, end: Int): Int

     [use case] Finds index of last occurrence of some value in this string before or at a given end index.

     [use case]

     Finds index of last occurrence of some value in this string before or at a given end index.

     elem

       the element value to search for.

     end

       the end index.

     returns

       the index `<= end` of the last element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

     Attributes
       abstract
     Definition Classes
       GenSeqLike

108. #### def lastIndexOf [B >: Char] (elem: B, end: Int): Int

     Finds index of last occurrence of some value in this string before or at a given end index.

     Finds index of last occurrence of some value in this string before or at a given end index.

     B

       the type of the element `elem`.

     elem

       the element value to search for.

     end

       the end index.

     returns

       the index `<= end` of the last element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

     Definition Classes
       GenSeqLike

109. #### def lastIndexOf (elem: Char): Int

     [use case] Finds index of last occurrence of some value in this string.

     [use case]

     Finds index of last occurrence of some value in this string.

     elem

       the element value to search for.

     returns

       the index of the last element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

     Attributes
       abstract
     Definition Classes
       GenSeqLike

110. #### def lastIndexOf [B >: Char] (elem: B): Int

     Finds index of last occurrence of some value in this string.

     Finds index of last occurrence of some value in this string.

     B

       the type of the element `elem`.

     elem

       the element value to search for.

     returns

       the index of the last element of this string that is equal (wrt `==`) to `elem`, or `-1`, if none exists.

     Definition Classes
       GenSeqLike

111. #### def lastIndexOfSlice [B >: Char] (that: Seq[B], end: Int): Int

     Definition Classes
       SeqLike
     Annotations
       @bridge()

112. #### def lastIndexOfSlice [B >: Char] (that: GenSeq[B], end: Int): Int

     Finds last index before or at a given end index where this string contains a given sequence as a slice.

     Finds last index before or at a given end index where this string contains a given sequence as a slice.

     that

       the sequence to test

     end

       the end index

     returns

       the last index `<= end` such that the elements of this string starting at this index match the elements of sequence `that`, or `-1` of no such subsequence exists.

     Definition Classes
       SeqLike

113. #### def lastIndexOfSlice [B >: Char] (that: Seq[B]): Int

     Definition Classes
       SeqLike
     Annotations
       @bridge()

114. #### def lastIndexOfSlice [B >: Char] (that: GenSeq[B]): Int

     Finds last index where this string contains a given sequence as a slice.

     Finds last index where this string contains a given sequence as a slice.

     that

       the sequence to test

     returns

       the last index such that the elements of this string starting a this index match the elements of sequence `that`, or `-1` of no such subsequence exists.

     Definition Classes
       SeqLike

115. #### def lastIndexWhere (p: (Char) ⇒ Boolean, end: Int): Int

     Finds index of last element satisfying some predicate before or at given end index.

     Finds index of last element satisfying some predicate before or at given end index.

     p

       the predicate used to test elements.

     returns

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

     Definition Classes
       IndexedSeqOptimized → SeqLike → GenSeqLike

116. #### def lastIndexWhere (p: (Char) ⇒ Boolean): Int

     Finds index of last element satisfying some predicate.

     Finds index of last element satisfying some predicate.

     p

       the predicate used to test elements.

     returns

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

     Definition Classes
       GenSeqLike

117. #### def lastOption : Option[Char]

     Optionally selects the last element.

     Optionally selects the last element.

     returns

       the last element of this string$ if it is nonempty, `None` if it is empty.

     Definition Classes
       TraversableLike

118. #### def length : Int

     The length of the string.

     The length of the string.

     Note: `xs.length` and `xs.size` yield the same result.

     returns

       the number of elements in this string.

     Definition Classes
       StringLike → SeqLike → GenSeqLike

119. #### def lengthCompare (len: Int): Int

     Compares the length of this string to a test value.

     Compares the length of this string to a test value.

     len

       the test value that gets compared with the length.

     returns

       A value `x` where

                  x <  0       if this.length <  len
                  x == 0       if this.length == len
                  x >  0       if this.length >  len

       The method as implemented here does not call `length` directly; its running time is `O(length min len)` instead of `O(length)`. The method should be overwritten if computing `length` is cheap.

     Definition Classes
       IndexedSeqOptimized → SeqLike

120. #### def lines : Iterator[String]

     Return all lines in this string in an iterator, excluding trailing line end characters, i.

     Return all lines in this string in an iterator, excluding trailing line end characters, i.e. apply `.stripLineEnd` to all lines returned by `linesWithSeparators`.

121. #### def linesIterator : Iterator[String]

     Return all lines in this string in an iterator, excluding trailing line end characters, i.

     Return all lines in this string in an iterator, excluding trailing line end characters, i.e. apply `.stripLineEnd` to all lines returned by `linesWithSeparators`.

122. #### def linesWithSeparators : Iterator[String]

     Return all lines in this string in an iterator, including trailing line end characters.

     Return all lines in this string in an iterator, including trailing line end characters.

     The number of strings returned is one greater than the number of line end characters in this string. For an empty string, a single empty line is returned. A line end character is one of

     - LF - line feed (0x0A hex)
     - FF - form feed (0x0C hex)

123. #### def map [B] (f: (Char) ⇒ B): String[B]

     [use case] Builds a new collection by applying a function to all elements of this string.

     [use case]

     Builds a new collection by applying a function to all elements of this string.

     B

       the element type of the returned collection.

     f

       the function to apply to each element.

     returns

       a new collection of type `That` resulting from applying the given function `f` to each element of this string and collecting the results.

     Attributes
       abstract
     Definition Classes
       GenTraversableLike

124. #### def map [B, That] (f: (Char) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Builds a new collection by applying a function to all elements of this string.

     Builds a new collection by applying a function to all elements of this string.

     B

       the element type of the returned collection.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     f

       the function to apply to each element.

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       a new collection of type `That` resulting from applying the given function `f` to each element of this string and collecting the results.

     Definition Classes
       TraversableLike → GenTraversableLike → FilterMonadic

125. #### def max : Char

     [use case] Finds the largest element.

     [use case]

     Finds the largest element.

     returns

       the largest element of this string with respect to the ordering `cmp`.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

126. #### def max [B >: Char] (implicit cmp: Ordering[B]): Char

     Finds the largest element.

     Finds the largest element.

     B

       The type over which the ordering is defined.

     cmp

       An ordering to be used for comparing elements.

     returns

       the largest element of this string with respect to the ordering `cmp`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

127. #### def maxBy [B] (f: (Char) ⇒ B)(implicit cmp: Ordering[B]): Char

     Definition Classes
       TraversableOnce → GenTraversableOnce

128. #### def min : Char

     [use case] Finds the smallest element.

     [use case]

     Finds the smallest element.

     returns

       the smallest element of this string with respect to the ordering `cmp`.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

129. #### def min [B >: Char] (implicit cmp: Ordering[B]): Char

     Finds the smallest element.

     Finds the smallest element.

     B

       The type over which the ordering is defined.

     cmp

       An ordering to be used for comparing elements.

     returns

       the smallest element of this string with respect to the ordering `cmp`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

130. #### def minBy [B] (f: (Char) ⇒ B)(implicit cmp: Ordering[B]): Char

     Definition Classes
       TraversableOnce → GenTraversableOnce

131. #### def mkString : String

     Displays all elements of this string in a string.

     Displays all elements of this string in a string.

     returns

       a string representation of this string. In the resulting string the string representations (w.r.t. the method `toString`) of all elements of this string follow each other without any separator string.

     Definition Classes
       StringLike → TraversableOnce → GenTraversableOnce

132. #### 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

       a string representation of this string. In the resulting string the string representations (w.r.t. the method `toString`) of all elements of this string are separated by the string `sep`.

     Definition Classes
       TraversableOnce → GenTraversableOnce
     Example:

     1. `List(1, 2, 3).mkString("|") = "1|2|3"`

133. #### 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

       a string representation of this string. The resulting string begins with the string `start` and ends with the string `end`. Inside, the string representations (w.r.t. the method `toString`) of all elements of this string are separated by the string `sep`.

     Definition Classes
       TraversableOnce → GenTraversableOnce
     Example:

     1. `List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"`

134. #### def ne (arg0: AnyRef): Boolean

     Equivalent to `!(this eq that)`.

     Equivalent to `!(this eq that)`.

     returns

       `true` if the argument is not a reference to the receiver object; `false` otherwise.

     Attributes
       final
     Definition Classes
       AnyRef

135. #### def nonEmpty : Boolean

     Tests whether the string is not empty.

     Tests whether the string is not empty.

     returns

       `true` if the string contains at least one element, `false` otherwise.

     Definition Classes
       TraversableOnce → GenTraversableOnce

136. #### def notify (): Unit

     Wakes up a single thread that is waiting on the receiver object's monitor.

     Wakes up a single thread that is waiting on the receiver object's monitor.

     Attributes
       final
     Definition Classes
       AnyRef

137. #### def notifyAll (): Unit

     Wakes up all threads that are waiting on the receiver object's monitor.

     Wakes up all threads that are waiting on the receiver object's monitor.

     Attributes
       final
     Definition Classes
       AnyRef

138. #### def padTo (len: Int, elem: Char): String[Char]

     [use case] Appends an element value to this string until a given target length is reached.

     [use case]

     Appends an element value to this string until a given target length is reached.

     len

       the target length

     elem

       the padding value

     returns

       a new collection of type `That` consisting of all elements of this string followed by the minimal number of occurrences of `elem` so that the resulting collection has a length of at least `len`.

     Attributes
       abstract
     Definition Classes
       GenSeqLike

139. #### def padTo [B >: Char, That] (len: Int, elem: B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Appends an element value to this string until a given target length is reached.

     Appends an element value to this string until a given target length is reached.

     B

       the element type of the returned string.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     len

       the target length

     elem

       the padding value

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       a new collection of type `That` consisting of all elements of this string followed by the minimal number of occurrences of `elem` so that the resulting collection has a length of at least `len`.

     Definition Classes
       SeqLike → GenSeqLike

140. #### def par : ParSeq[Char]

     Returns a parallel implementation of this collection.

     Returns a parallel implementation of this collection.

     For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, `par` takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

     Specific collections (e.g. `ParArray` or `mutable.ParHashMap`) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, `par` takes constant or sublinear time.

     All parallel collections return a reference to themselves.

     returns

       a parallel implementation of this collection

     Definition Classes
       Parallelizable

141. #### def parCombiner : Combiner[Char, ParSeq[Char]]

     The default `par` implementation uses the combiner provided by this method to create a new parallel collection.

     The default `par` implementation uses the combiner provided by this method to create a new parallel collection.

     returns

       a combiner for the parallel collection of type `ParRepr`

     Attributes
       protected[this]
     Definition Classes
       SeqLike → TraversableLike → Parallelizable

142. #### def partition (p: (Char) ⇒ Boolean): (Repr, Repr)

     Partitions this string in two strings according to a predicate.

     Partitions this string in two strings according to a predicate.

     p

       the predicate on which to partition.

     returns

       a pair of strings: the first string consists of all elements that satisfy the predicate `p` and the second string consists of all elements that don't. The relative order of the elements in the resulting strings is the same as in the original string.

     Definition Classes
       TraversableLike → GenTraversableLike

143. #### def patch [B >: Char, That] (from: Int, patch: Seq[B], replaced: Int)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Definition Classes
       SeqLike
     Annotations
       @bridge()

144. #### def patch (from: Int, that: GenSeq[Char], replaced: Int): String[Char]

     [use case] Produces a new string where a slice of elements in this string is replaced by another sequence.

     [use case]

     Produces a new string where a slice of elements in this string is replaced by another sequence.

     from

       the index of the first replaced element

     replaced

       the number of elements to drop in the original string

     returns

       a new string consisting of all elements of this string except that `replaced` elements starting from `from` are replaced by `patch`.

     Attributes
       abstract
     Definition Classes
       GenSeqLike

145. #### def patch [B >: Char, That] (from: Int, patch: GenSeq[B], replaced: Int)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Produces a new string where a slice of elements in this string is replaced by another sequence.

     Produces a new string where a slice of elements in this string is replaced by another sequence.

     B

       the element type of the returned string.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     from

       the index of the first replaced element

     patch

       the replacement sequence

     replaced

       the number of elements to drop in the original string

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       a new string consisting of all elements of this string except that `replaced` elements starting from `from` are replaced by `patch`.

     Definition Classes
       SeqLike → GenSeqLike

146. #### def permutations : Iterator[Repr]

     Iterates over distinct permutations.

     Iterates over distinct permutations.

     returns

       An Iterator which traverses the distinct permutations of this string.

     Definition Classes
       SeqLike
     Example:

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

147. #### def prefixLength (p: (Char) ⇒ Boolean): Int

     Returns the length of the longest prefix whose elements all satisfy some predicate.

     Returns the length of the longest prefix whose elements all satisfy some predicate.

     p

       the predicate used to test elements.

     returns

       the length of the longest prefix of this string such that every element of the segment satisfies the predicate `p`.

     Definition Classes
       GenSeqLike

148. #### def product : Char

     [use case] Multiplies up the elements of this collection.

     [use case]

     Multiplies up the elements of this collection.

     returns

       the product of all elements of this string with respect to the `*` operator in `num`.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

149. #### def product [B >: Char] (implicit num: Numeric[B]): B

     Multiplies up the elements of this collection.

     Multiplies up the elements of this collection.

     B

       the result type of the `*` operator.

     num

       an implicit parameter defining a set of numeric operations which includes the `*` operator to be used in forming the product.

     returns

       the product of all elements of this string with respect to the `*` operator in `num`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

150. #### def r : 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'.

151. #### def reduce [A1 >: Char] (op: (A1, A1) ⇒ A1): A1

     Reduces the elements of this sequence using the specified associative binary operator.

     Reduces the elements of this sequence using the specified associative binary operator.

     The order in which operations are performed on elements is unspecified and may be nondeterministic.

     Note this method has a different signature than the `reduceLeft` and `reduceRight` methods of the trait `Traversable`. The result of reducing may only be a supertype of this parallel collection's type parameter `T`.

     op

       A binary operator that must be associative.

     returns

       The result of applying reduce operator `op` between all the elements if the collection is nonempty.

     Definition Classes
       TraversableOnce → GenTraversableOnce

152. #### def reduceLeft [B >: Char] (op: (B, Char) ⇒ B): B

     Definition Classes
       IndexedSeqOptimized → TraversableOnce

153. #### def reduceLeftOption [B >: Char] (op: (B, Char) ⇒ B): Option[B]

     Optionally applies a binary operator to all elements of this string, going left to right.

     Optionally applies a binary operator to all elements of this string, going left to right.

     B

       the result type of the binary operator.

     op

       the binary operator.

     returns

       an option value containing the result of `reduceLeft(op)` is this string is nonempty, `None` otherwise.

     Definition Classes
       TraversableOnce → GenTraversableOnce

154. #### def reduceOption [A1 >: Char] (op: (A1, A1) ⇒ A1): Option[A1]

     Optionally reduces the elements of this sequence using the specified associative binary operator.

     Optionally reduces the elements of this sequence using the specified associative binary operator.

     The order in which operations are performed on elements is unspecified and may be nondeterministic.

     Note this method has a different signature than the `reduceLeftOption` and `reduceRightOption` methods of the trait `Traversable`. The result of reducing may only be a supertype of this parallel collection's type parameter `T`.

     op

       A binary operator that must be associative.

     returns

       An option value containing result of applying reduce operator `op` between all the elements if the collection is nonempty, and `None` otherwise.

     Definition Classes
       TraversableOnce → GenTraversableOnce

155. #### def reduceRight [B >: Char] (op: (Char, B) ⇒ B): B

     Applies a binary operator to all elements of this string, going right to left.

     Applies a binary operator to all elements of this string, going right to left.

     B

       the result type of the binary operator.

     op

       the binary operator.

     returns

       the result of inserting `op` between consecutive elements of this string, going right to left:

                       op(x,,1,,, op(x,,2,,, ..., op(x,,n-1,,, x,,n,,)...))

       where `x,,1,,, ..., x,,n,,` are the elements of this string.

     Definition Classes
       IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce

156. #### def reduceRightOption [B >: Char] (op: (Char, B) ⇒ B): Option[B]

     Optionally applies a binary operator to all elements of this string, going right to left.

     Optionally applies a binary operator to all elements of this string, going right to left.

     B

       the result type of the binary operator.

     op

       the binary operator.

     returns

       an option value containing the result of `reduceRight(op)` is this string is nonempty, `None` otherwise.

     Definition Classes
       TraversableOnce → GenTraversableOnce

157. #### def replaceAllLiterally (literal: String, replacement: String): String

     Replace all literal occurrences of `literal` with the string `replacement`.

     Replace all literal occurrences of `literal` with the string `replacement`. This is equivalent to java.lang.String#replaceAll except that both arguments are appropriately quoted to avoid being interpreted as metacharacters.

     literal

       the string which should be replaced everywhere it occurs

     replacement

       the replacement string

     returns

       the resulting string

158. #### def repr : Repr

     The collection of type string underlying this `TraversableLike` object.

     The collection of type string underlying this `TraversableLike` object. By default this is implemented as the `TraversableLike` object itself, but this can be overridden.

     Definition Classes
       TraversableLike → GenTraversableLike

159. #### def reverse : Repr

     Returns new string wih elements in reversed order.

     Returns new string wih elements in reversed order.

     returns

       A new string with all elements of this string in reversed order.

     Definition Classes
       IndexedSeqOptimized → SeqLike → GenSeqLike

160. #### def reverseIterator : Iterator[Char]

     An iterator yielding elements in reversed order.

     An iterator yielding elements in reversed order.

     Note: `xs.reverseIterator` is the same as `xs.reverse.iterator` but might be more efficient.

     returns

       an iterator yielding the elements of this string in reversed order

     Definition Classes
       IndexedSeqOptimized → SeqLike

161. #### def reverseMap [B] (f: (Char) ⇒ B): String[B]

     [use case] Builds a new collection by applying a function to all elements of this string and collecting the results in reversed order.

     [use case]

     Builds a new collection by applying a function to all elements of this string and collecting the results in reversed order.

     B

       the element type of the returned collection.

     f

       the function to apply to each element.

     returns

       a new collection of type `That` resulting from applying the given function `f` to each element of this string and collecting the results in reversed order.

       Note: `xs.reverseMap(f)` is the same as `xs.reverse.map(f)` but might be more efficient.

     Attributes
       abstract
     Definition Classes
       GenSeqLike

162. #### def reverseMap [B, That] (f: (Char) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Builds a new collection by applying a function to all elements of this string and collecting the results in reversed order.

     Builds a new collection by applying a function to all elements of this string and collecting the results in reversed order.

     Note: `xs.reverseMap(f)` is the same as `xs.reverse.map(f)` but might be more efficient.

     B

       the element type of the returned collection.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     f

       the function to apply to each element.

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       a new collection of type `That` resulting from applying the given function `f` to each element of this string and collecting the results in reversed order.

     Definition Classes
       SeqLike → GenSeqLike

163. #### def reversed : List[Char]

     Attributes
       protected[this]
     Definition Classes
       TraversableOnce

164. #### def sameElements (that: GenIterable[Char]): Boolean

     [use case] Checks if the other iterable collection contains the same elements in the same order as this string.

     [use case]

     Checks if the other iterable collection contains the same elements in the same order as this string.

     that

       the collection to compare with.

     returns

       `true`, if both collections contain the same elements in the same order, `false` otherwise.

     Attributes
       abstract
     Definition Classes
       GenIterableLike

165. #### def sameElements [B >: Char] (that: GenIterable[B]): Boolean

     Checks if the other iterable collection contains the same elements in the same order as this string.

     Checks if the other iterable collection contains the same elements in the same order as this string.

     B

       the type of the elements of collection `that`.

     that

       the collection to compare with.

     returns

       `true`, if both collections contain the same elements in the same order, `false` otherwise.

     Definition Classes
       IndexedSeqOptimized → IterableLike → GenIterableLike

166. #### def sameElements [B >: Char] (that: Iterable[B]): Boolean

     Definition Classes
       IterableLike
     Annotations
       @bridge()

167. #### def scan [B >: Char, That] (z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Repr, B, That]): That

     Computes a prefix scan of the elements of the collection.

     Computes a prefix scan of the elements of the collection.

     Note: The neutral element `z` may be applied more than once.

     B

       element type of the resulting collection

     That

       type of the resulting collection

     z

       neutral element for the operator `op`

     op

       the associative operator for the scan

     cbf

       combiner factory which provides a combiner

     returns

       a new string containing the prefix scan of the elements in this string

     Definition Classes
       TraversableLike → GenTraversableLike

168. #### def scanLeft [B, That] (z: B)(op: (B, Char) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Produces a collection containing cummulative results of applying the operator going left to right.

     Produces a collection containing cummulative results of applying the operator going left to right.

     B

       the type of the elements in the resulting collection

     That

       the actual type of the resulting collection

     z

       the initial value

     op

       the binary operator applied to the intermediate result and the element

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       collection with intermediate results

     Definition Classes
       TraversableLike → GenTraversableLike

169. #### def scanRight [B, That] (z: B)(op: (Char, B) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     Produces a collection containing cummulative results of applying the operator going right to left.

     Produces a collection containing cummulative results of applying the operator going right to left. The head of the collection is the last cummulative result.

     Example:

            List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)

     B

       the type of the elements in the resulting collection

     That

       the actual type of the resulting collection

     z

       the initial value

     op

       the binary operator applied to the intermediate result and the element

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       collection with intermediate results

     Definition Classes
       TraversableLike → GenTraversableLike
     Annotations
       @migration
     Migration

       "This scanRight definition has changed in 2.9.\n" + "The previous behavior can be reproduced with scanRight.reverse."

170. #### def segmentLength (p: (Char) ⇒ Boolean, from: Int): Int

     Computes length of longest segment whose elements all satisfy some predicate.

     Computes length of longest segment whose elements all satisfy some predicate.

     p

       the predicate used to test elements.

     from

       the index where the search starts.

     returns

       the length of the longest segment of this string starting from index `from` such that every element of the segment satisfies the predicate `p`.

     Definition Classes
       IndexedSeqOptimized → SeqLike → GenSeqLike

171. #### def size : Int

     The size of this string, equivalent to `length`.

     The size of this string, equivalent to `length`.

     returns

       the number of elements in this string.

     Definition Classes
       SeqLike → GenTraversableLike → TraversableOnce → GenTraversableOnce

172. #### def slice (from: Int, until: Int): Repr

     Selects an interval of elements.

     Selects an interval of elements. The returned collection 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 highest 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.

     Definition Classes
       StringLike → IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

173. #### def sliding [B >: Char] (size: Int, step: Int): Iterator[Repr]

     Definition Classes
       IterableLike

174. #### def sliding [B >: Char] (size: Int): Iterator[Repr]

     Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.

     Groups elements 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 elements per group

     returns

       An iterator producing strings of size `size`, except the last and the only element will be truncated if there are fewer elements than size.

     Definition Classes
       IterableLike
     See also

       Iterator#sliding

175. #### def sortBy [B] (f: (Char) ⇒ B)(implicit ord: Ordering[B]): Repr

     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.

     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 elements of this string sorted according to the ordering where `x < y` if `ord.lt(f(x), f(y))`.

     Definition Classes
       SeqLike
     Example:

     1.        val words = "The quick brown fox jumped over the lazy dog".split(' ')
               // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
               words.sortBy(x => (x.length, x.head))
               res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)

     See also

       scala.math.Ordering

176. #### def sortWith (lt: (Char, Char) ⇒ Boolean): Repr

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

     Definition Classes
       SeqLike
     Example:

     1.        List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
               List("Bob", "John", "Steve", "Tom")

177. #### def sorted [B >: Char] (implicit ord: Ordering[B]): Repr

     Sorts this string according to an Ordering.

     Sorts this string according to an Ordering.

     The sort is stable. That is, elements that are equal wrt `lt` 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 elements of this string sorted according to the ordering `ord`.

     Definition Classes
       SeqLike
     See also

       scala.math.Ordering

178. #### def span (p: (Char) ⇒ Boolean): (Repr, Repr)

     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 possibly 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 elements all satisfy `p`, and the rest of this string.

     Definition Classes
       IndexedSeqOptimized → TraversableLike → GenTraversableLike

179. #### def split (separators: Array[Char]): Array[String]

     Annotations
       @throws( clazz = ... )

180. #### def split (separator: Char): Array[String]

     Annotations
       @throws( clazz = ... )

181. #### def splitAt (n: Int): (Repr, Repr)

     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 (but possibly more efficient than) `(c take n, c drop n)`.

     n

       the position at which to split.

     returns

       a pair of strings consisting of the first `n` elements of this string, and the other elements.

     Definition Classes
       IndexedSeqOptimized → TraversableLike → GenTraversableLike

182. #### def startsWith [B] (that: GenSeq[B], offset: Int): Boolean

     Tests whether this string contains the given sequence at a given index.

     Tests whether this string contains the given sequence at a given index.

     If the both the receiver object, `this` and the argument, `that` are infinite sequences this method may not terminate.

     that

       the sequence to test

     offset

       the index where the sequence is searched.

     returns

       `true` if the sequence `that` is contained in this string at index `offset`, otherwise `false`.

     Definition Classes
       IndexedSeqOptimized → SeqLike → GenSeqLike

183. #### def startsWith [B] (that: Seq[B], offset: Int): Boolean

     Definition Classes
       SeqLike
     Annotations
       @bridge()

184. #### def startsWith [B] (that: Seq[B]): Boolean

     Definition Classes
       GenSeqLike
     Annotations
       @bridge()

185. #### def startsWith [B] (that: GenSeq[B]): Boolean

     Tests whether this string starts with the given sequence.

     Tests whether this string starts with the given sequence.

     that

       the sequence to test

     returns

       `true` if this collection has `that` as a prefix, `false` otherwise.

     Definition Classes
       GenSeqLike

186. #### def stringPrefix : String

     Defines the prefix of this object's `toString` representation.

     Defines the prefix of this object's `toString` representation.

     returns

       a string representation which starts the result of `toString` applied to this string. By default the string prefix is the simple name of the collection class string.

     Definition Classes
       TraversableLike → GenTraversableLike

187. #### def stripLineEnd : String

     Strip trailing line end character from this string if it has one.

     Strip trailing line end character from this string if it has one.

     A line end character is one of

     - LF - line feed (0x0A hex)
     - FF - form feed (0x0C hex)

     If a line feed character LF is preceded by a carriage return CR (0x0D hex), the CR character is also stripped (Windows convention).

188. #### 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.

189. #### 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.

190. #### def stripPrefix (prefix: String): String

     Returns this string with the given `prefix` stripped.

191. #### 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.

192. #### def sum : Char

     [use case] Sums up the elements of this collection.

     [use case]

     Sums up the elements of this collection.

     returns

       the sum of all elements of this string with respect to the `+` operator in `num`.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

193. #### def sum [B >: Char] (implicit num: Numeric[B]): B

     Sums up the elements of this collection.

     Sums up the elements of this collection.

     B

       the result type of the `+` operator.

     num

       an implicit parameter defining a set of numeric operations which includes the `+` operator to be used in forming the sum.

     returns

       the sum of all elements of this string with respect to the `+` operator in `num`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

194. #### def synchronized [T0] (arg0: ⇒ T0): T0

     Attributes
       final
     Definition Classes
       AnyRef

195. #### def tail : Repr

     Selects all elements except the first.

     Selects all elements except the first.

     returns

       a string consisting of all elements of this string except the first one.

     Definition Classes
       IndexedSeqOptimized → TraversableLike → GenTraversableLike

196. #### def tails : Iterator[Repr]

     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

     Definition Classes
       TraversableLike
     Example:

     1. `List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)`

197. #### def take (n: Int): Repr

     Selects first n elements.

     Selects first n elements.

     n

       Tt number of elements to take from this string.

     returns

       a string consisting only of the first `n` elements of this string, or else the whole string, if it has less than `n` elements.

     Definition Classes
       IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

198. #### def takeRight (n: Int): Repr

     Selects last n elements.

     Selects last n elements.

     n

       the number of elements to take

     returns

       a string consisting only of the last `n` elements of this string, or else the whole string, if it has less than `n` elements.

     Definition Classes
       IndexedSeqOptimized → IterableLike

199. #### def takeWhile (p: (Char) ⇒ Boolean): Repr

     Takes longest prefix of elements that satisfy a predicate.

     Takes longest prefix of elements that satisfy a predicate.

     p

       The predicate used to test elements.

     returns

       the longest prefix of this string whose elements all satisfy the predicate `p`.

     Definition Classes
       IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

200. #### def thisCollection : IndexedSeq[Char]

     The underlying collection seen as an instance of `String`.

     The underlying collection seen as an instance of `String`. By default this is implemented as the current collection object itself, but this can be overridden.

     Attributes
       protected[this]
     Definition Classes
       IndexedSeqLike → SeqLike → IterableLike → TraversableLike

201. #### def toArray : Array[Char]

     [use case] Converts this string to an array.

     [use case]

     Converts this string to an array.

     returns

       an array containing all elements of this string.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

202. #### def toArray [B >: Char] (implicit arg0: ClassManifest[B]): Array[B]

     Converts this string to an array.

     Converts this string to an array.

     B

       the type of the elements of the array. A `ClassManifest` for this type must be available.

     returns

       an array containing all elements of this string.

     Definition Classes
       StringLike → TraversableOnce → GenTraversableOnce

203. #### def toBoolean : Boolean

204. #### def toBuffer [A1 >: Char] : Buffer[A1]

     Overridden for efficiency

     Overridden for efficiency

     returns

       a buffer containing all elements of this string.

     Definition Classes
       IndexedSeqLike → TraversableOnce → GenTraversableOnce

205. #### def toByte : Byte

206. #### def toCollection (repr: Repr): IndexedSeq[Char]

     A conversion from collections of type `Repr` to `String` objects.

     A conversion from collections of type `Repr` to `String` objects. By default this is implemented as just a cast, but this can be overridden.

     Attributes
       protected[this]
     Definition Classes
       IndexedSeqLike → SeqLike → IterableLike → TraversableLike

207. #### def toDouble : Double

208. #### def toFloat : Float

209. #### def toIndexedSeq [B >: Char] : IndexedSeq[B]

     Converts this string to an indexed sequence.

     Converts this string to an indexed sequence.

     returns

       an indexed sequence containing all elements of this string.

     Definition Classes
       TraversableOnce → GenTraversableOnce

210. #### def toInt : Int

211. #### def toIterable : Iterable[Char]

     Converts this string to an iterable collection.

     Converts this string to an iterable collection. Note that the choice of target `Iterable` is lazy in this default implementation as this `TraversableOnce` may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

     returns

       an `Iterable` containing all elements of this string.

     Definition Classes
       IterableLike → TraversableOnce → GenTraversableOnce

212. #### def toIterator : Iterator[Char]

     Returns an Iterator over the elements in this string.

     Returns an Iterator over the elements in this string. Will return the same Iterator if this instance is already an Iterator.

     returns

       an Iterator containing all elements of this string.

     Definition Classes
       TraversableLike → GenTraversableOnce

213. #### def toList : List[Char]

     Converts this string to a list.

     Converts this string to a list.

     returns

       a list containing all elements of this string.

     Definition Classes
       TraversableOnce → GenTraversableOnce

214. #### def toLong : Long

215. #### def toMap [T, U] : Map[T, U]

     [use case] Converts this string to a map.

     [use case]

     Converts this string to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

     returns

       a map containing all elements of this string.

     Attributes
       abstract
     Definition Classes
       GenTraversableOnce

216. #### def toMap [T, U] (implicit ev: <:<[Char, (T, U)]): Map[T, U]

     Converts this string to a map.

     Converts this string to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

     returns

       a map containing all elements of this string.

     Definition Classes
       TraversableOnce → GenTraversableOnce

217. #### def toSeq : Seq[Char]

     Converts this string to a sequence.

     Converts this string to a sequence.

     Overridden for efficiency.

     returns

       a sequence containing all elements of this string.

     Definition Classes
       SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce

218. #### def toSet [B >: Char] : Set[B]

     Converts this string to a set.

     Converts this string to a set.

     returns

       a set containing all elements of this string.

     Definition Classes
       TraversableOnce → GenTraversableOnce

219. #### def toShort : Short

220. #### def toStream : Stream[Char]

     Converts this string to a stream.

     Converts this string to a stream.

     returns

       a stream containing all elements of this string.

     Definition Classes
       IterableLike → TraversableLike → GenTraversableOnce

221. #### def toString (): String

     Converts this string to a string.

     Converts this string to a string.

     returns

       a string representation of this collection. By default this string consists of the `stringPrefix` of this string, followed by all elements separated by commas and enclosed in parentheses.

     Definition Classes
       SeqLike → TraversableLike → AnyRef → Any

222. #### def toTraversable : Traversable[Char]

     Converts this string to an unspecified Traversable.

     Converts this string to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

     returns

       a Traversable containing all elements of this string.

     Definition Classes
       TraversableLike → TraversableOnce → GenTraversableOnce

223. #### def union (that: Seq[Char]): String[Char]

     [use case] Produces a new sequence which contains all elements of this string and also all elements of a given sequence.

     [use case]

     Produces a new sequence which contains all elements of this string and also all elements of a given sequence. `xs union ys` is equivalent to `xs ++ ys`.

     that

       the sequence to add.

     returns

       a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

     Attributes
       abstract
     Definition Classes
       SeqLike

224. #### def union [B >: Char, That] (that: GenSeq[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

     Produces a new sequence which contains all elements of this string and also all elements of a given sequence.

     Produces a new sequence which contains all elements of this string and also all elements of a given sequence. `xs union ys` is equivalent to `xs ++ ys`.

     Another way to express this is that `xs union ys` computes the order-presevring multi-set union of `xs` and `ys`. `union` is hence a counter-part of `diff` and `intersect` which also work on multi-sets.

     B

       the element type of the returned string.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     that

       the sequence to add.

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

       a new collection of type `That` which contains all elements of this string followed by all elements of `that`.

     Definition Classes
       SeqLike → GenSeqLike

225. #### def union [B >: Char, That] (that: Seq[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

     Definition Classes
       GenSeqLike
     Annotations
       @bridge()

226. #### def updated (index: Int, elem: Char): String[Char]

     [use case] A copy of this string with one single replaced element.

     [use case]

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

     Attributes
       abstract
     Definition Classes
       GenSeqLike

227. #### def updated [B >: Char, That] (index: Int, elem: B)(implicit bf: CanBuildFrom[Repr, B, That]): That

     A copy of this string with one single replaced element.

     A copy of this string with one single replaced element.

     B

       the element type of the returned string.

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `B` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, B, That]` is found.

     index

       the position of the replacement

     elem

       the replacing element

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `B`.

     returns

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

     Definition Classes
       SeqLike → GenSeqLike

228. #### def view (from: Int, until: Int): SeqView[Char, Repr]

     Creates a non-strict view of a slice of this string.

     Creates a non-strict view of a slice of this string.

     Note: the difference between `view` and `slice` is that `view` produces a view of the current string, whereas `slice` produces a new string.

     Note: `view(from, to)` is equivalent to `view.slice(from, to)`

     from

       the index of the first element of the view

     until

       the index of the element following the view

     returns

       a non-strict view of a slice of this string, starting at index `from` and extending up to (but not including) index `until`.

     Definition Classes
       SeqLike → IterableLike → TraversableLike

229. #### def view : SeqView[Char, Repr]

     Creates a non-strict view of this string.

     Creates a non-strict view of this string.

     returns

       a non-strict view of this string.

     Definition Classes
       SeqLike → IterableLike → TraversableLike

230. #### def wait (): Unit

     Attributes
       final
     Definition Classes
       AnyRef
     Annotations
       @throws()

231. #### def wait (arg0: Long, arg1: Int): Unit

     Attributes
       final
     Definition Classes
       AnyRef
     Annotations
       @throws()

232. #### def wait (arg0: Long): Unit

     Attributes
       final
     Definition Classes
       AnyRef
     Annotations
       @throws()

233. #### def withFilter (p: (Char) ⇒ Boolean): FilterMonadic[Char, Repr]

     Creates a non-strict filter of this string.

     Creates a non-strict filter of this string.

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

     p

       the predicate used to test elements.

     returns

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

     Definition Classes
       TraversableLike → FilterMonadic

234. #### def zip [B] (that: GenIterable[B]): String[(Char, B)]

     [use case] Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs.

     [use case]

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

     B

       the type of the second half of the returned pairs

     that

       The iterable providing the second half of each result pair

     returns

       a new collection of type `That` containing pairs consisting of corresponding elements of this string and `that`. The length of the returned collection is the minimum of the lengths of this string and `that`.

     Attributes
       abstract
     Definition Classes
       GenIterableLike

235. #### def zip [A1 >: Char, B, That] (that: GenIterable[B])(implicit bf: CanBuildFrom[Repr, (A1, B), That]): That

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs.

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

     A1

       the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

     B

       the type of the second half of the returned pairs

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `(A1, B)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, B), That]`. is found.

     that

       The iterable providing the second half of each result pair

     bf

       an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and the new element type `(A1, B)`.

     returns

       a new collection of type `That` containing pairs consisting of corresponding elements of this string and `that`. The length of the returned collection is the minimum of the lengths of this string and `that`.

     Definition Classes
       IndexedSeqOptimized → IterableLike → GenIterableLike

236. #### def zip [A1 >: Char, B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[Repr, (A1, B), That]): That

     Definition Classes
       IterableLike
     Annotations
       @bridge()

237. #### def zipAll [B, A1 >: Char, That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Repr, (A1, B), That]): That

     Definition Classes
       IterableLike
     Annotations
       @bridge()

238. #### def zipAll [B] (that: Iterable[B], thisElem: Char, thatElem: B): String[(Char, B)]

     [use case] Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs.

     [use case]

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

     that

       the iterable providing the second half of each result pair

     thisElem

       the element to be used to fill up the result if this string is shorter than `that`.

     thatElem

       the element to be used to fill up the result if `that` is shorter than this string.

     returns

       a new collection of type `That` containing pairs consisting of corresponding elements of this string and `that`. The length of the returned collection is the maximum of the lengths of this string and `that`. If this string is shorter than `that`, `thisElem` values are used to pad the result. If `that` is shorter than this string, `thatElem` values are used to pad the result.

     Attributes
       abstract
     Definition Classes
       GenIterableLike

239. #### def zipAll [B, A1 >: Char, That] (that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Repr, (A1, B), That]): That

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs.

     Returns a string formed from this string and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

     that

       the iterable providing the second half of each result pair

     thisElem

       the element to be used to fill up the result if this string is shorter than `that`.

     thatElem

       the element to be used to fill up the result if `that` is shorter than this string.

     returns

       a new collection of type `That` containing pairs consisting of corresponding elements of this string and `that`. The length of the returned collection is the maximum of the lengths of this string and `that`. If this string is shorter than `that`, `thisElem` values are used to pad the result. If `that` is shorter than this string, `thatElem` values are used to pad the result.

     Definition Classes
       IterableLike → GenIterableLike

240. #### def zipWithIndex : String[(Char, Int)]

     [use case] Zips this string with its indices.

     [use case]

     Zips this string with its indices.

     returns

       A new collection of type `That` containing pairs consisting of all elements of this string paired with their index. Indices start at `0`.

     Attributes
       abstract
     Definition Classes
       GenIterableLike

241. #### def zipWithIndex [A1 >: Char, That] (implicit bf: CanBuildFrom[Repr, (A1, Int), That]): That

     Zips this string with its indices.

     Zips this string with its indices.

     A1

       the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

     That

       the class of the returned collection. Where possible, `That` is the same class as the current collection class `Repr`, but this depends on the element type `(A1, Int)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, Int), That]`. is found.

     returns

       A new collection of type `That` containing pairs consisting of all elements of this string paired with their index. Indices start at `0`.

     Definition Classes
       IndexedSeqOptimized → IterableLike → GenIterableLike

### Deprecated Value Members

1. #### def elements : Iterator[Char]

   Definition Classes
     IterableLike
   Annotations
     @deprecated
   Deprecated

     use `iterator' instead`

2. #### def equalsWith [B] (that: Seq[B])(f: (Char, B) ⇒ Boolean): Boolean

   Tests whether every element of this string relates to the corresponding element of another sequence by satisfying a test predicate.

   Tests whether every element of this string relates to the corresponding element of another sequence by satisfying a test predicate.

   B

     the type of the elements of `that`

   that

     the other sequence

   returns

     `true` if both sequences have the same length and `p(x, y)` is `true` for all corresponding elements `x` of this string and `y` of `that`, otherwise `false`.

   Definition Classes
     SeqLike
   Annotations
     @deprecated
   Deprecated

     use `corresponds` instead

3. #### def findIndexOf (p: (Char) ⇒ Boolean): Int

   Returns index of the first element satisfying a predicate, or `-1`.

   Returns index of the first element satisfying a predicate, or `-1`.

   Definition Classes
     SeqLike
   Annotations
     @deprecated
   Deprecated

     Use indexWhere(p) instead.

4. #### def findLastIndexOf (p: (Char) ⇒ Boolean): Int

   Returns index of the last element satisfying a predicate, or -1.

   Returns index of the last element satisfying a predicate, or -1.

   Definition Classes
     SeqLike
   Annotations
     @deprecated
   Deprecated

     use `lastIndexWhere` instead

5. #### def first : Char

   Definition Classes
     IterableLike
   Annotations
     @deprecated
   Deprecated

     use `head' instead`

6. #### def firstOption : Option[Char]

   `None` if iterable is empty.

   `None` if iterable is empty.

   Definition Classes
     IterableLike
   Annotations
     @deprecated
   Deprecated

     use `headOption' instead`

7. #### def projection : SeqView[Char, Repr]

   returns a projection that can be used to call non-strict `filter`, `map`, and `flatMap` methods that build projections of the collection.

   returns a projection that can be used to call non-strict `filter`, `map`, and `flatMap` methods that build projections of the collection.

   Definition Classes
     SeqLike → IterableLike
   Annotations
     @deprecated
   Deprecated

     use `view' instead`

8. #### def reversedElements : Iterator[Char]

   Definition Classes
     SeqLike
   Annotations
     @deprecated
   Deprecated

     use `reverseIterator' instead`

### Inherited from Ordered[String]

### Inherited from Comparable[String]

### Inherited from IndexedSeqOptimized[Char, Repr]

### Inherited from IndexedSeqLike[Char, Repr]

### Inherited from SeqLike[Char, Repr]

### Inherited from GenSeqLike[Char, Repr]

### Inherited from IterableLike[Char, Repr]

### Inherited from GenIterableLike[Char, Repr]

### Inherited from TraversableLike[Char, Repr]

### Inherited from GenTraversableLike[Char, Repr]

### Inherited from Parallelizable[Char, ParSeq[Char]]

### Inherited from TraversableOnce[Char]

### Inherited from GenTraversableOnce[Char]

### Inherited from FilterMonadic[Char, Repr]

### Inherited from HasNewBuilder[Char, Repr]

### Inherited from Equals

### Inherited from AnyRef

### Inherited from Any