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 AbstractIterator[A] with 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. #### abstract 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]
   Definition Classes
     StringLike → TraversableLike → HasNewBuilder

2. #### abstract def seq: IndexedSeq[Char]

   A version of this collection with all of the operations implemented sequentially (i.

   A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).

   This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

   returns

     a sequential view of the collection.

   Definition Classes
     IndexedSeqLike → GenSeqLike → Parallelizable → TraversableOnce → GenTraversableOnce

### Concrete Value Members

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

   Definition Classes
     AnyRef

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

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Definition Classes
     Any

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

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

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

   returns

     a hash value consistent with ==

   Definition Classes
     AnyRef → Any

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

   Return the current string concatenated `n` times.

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

   [use case]

   [use case]
   B

     the element type of the returned collection.

   that

     the traversable to append.

   returns

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

   Definition Classes
     TraversableLike → GenTraversableLike

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

   As with `++`, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

   As with `++`, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

   It differs from `++` in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

   Example:

           scala> val x = List(1)
           x: List[Int] = List(1)

           scala> val y = LinkedList(2)
           y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

           scala> val z = x ++: y
           z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

   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.

   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

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

   [use case]

   [use case]
   B

     the element type of the returned collection.

   that

     the traversable to append.

   returns

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

   Definition Classes
     TraversableLike

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

   [use case]

   [use case]
   elem

     the prepended element

   returns

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

   Definition Classes
     SeqLike → GenSeqLike

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

   Examples:

   Note that the folding function used to compute b is equivalent to that used to compute c.

            scala> val a = LinkedList(1,2,3,4)
            a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

            scala> val b = (5 /: a)(_+_)
            b: Int = 15

            scala> val c = (5 /: a)((x,y) => x + y)
            c: Int = 15

   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, x1), x2), ..., xn)

     where `x1, ..., xn` are the elements of this string.

   Definition Classes
     TraversableOnce → GenTraversableOnce

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

    Example:

             scala> val a = LinkedList(1,2,3,4)
             a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

             scala> val b = (a /:\ 5)(_+_)
             b: Int = 15

    Definition Classes
      GenTraversableOnce

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

    [use case]

    [use case]
    elem

      the appended element

    returns

      a new string consisting of all elements of this string followed by `elem`. @example

                scala> import scala.collection.mutable.LinkedList
                import scala.collection.mutable.LinkedList

                scala> val a = LinkedList(1)
                a: scala.collection.mutable.LinkedList[Int] = LinkedList(1)

                scala> val b = a :+ 2
                b: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

                scala> println(a)
                LinkedList(1)

    Definition Classes
      SeqLike → GenSeqLike

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

    Examples:

    Note that the folding function used to compute b is equivalent to that used to compute c.

             scala> val a = LinkedList(1,2,3,4)
             a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

             scala> val b = (a :\ 5)(_+_)
             b: Int = 15

             scala> val c = (a :\ 5)((x,y) => x + y)
             c: Int = 15

    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(x1, op(x2, ... op(xn, z)...))

      where `x1, ..., xn` are the elements of this string.

    Definition Classes
      TraversableOnce → GenTraversableOnce

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

    Returns true if `this` is less than `that`

    Returns true if `this` is less than `that`

    Definition Classes
      Ordered

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

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

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

    Definition Classes
      Ordered

15. #### final def ==(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

16. #### final def ==(arg0: Any): Boolean

    Test two objects for equality.

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

    returns

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

    Definition Classes
      Any

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

    Returns true if `this` is greater than `that`.

    Returns true if `this` is greater than `that`.

    Definition Classes
      Ordered

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

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

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

    Definition Classes
      Ordered

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

    Example:

             scala> val a = LinkedList(1,2,3,4)
             a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

             scala> val b = new StringBuilder()
             b: StringBuilder =

             scala> val h = a.addString(b)
             b: StringBuilder = 1234

    b

      the string builder to which elements are appended.

    returns

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

    Definition Classes
      TraversableOnce

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

    Example:

             scala> val a = LinkedList(1,2,3,4)
             a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

             scala> val b = new StringBuilder()
             b: StringBuilder =

             scala> a.addString(b, ", ")
             res0: StringBuilder = 1, 2, 3, 4

    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

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

    Example:

             scala> val a = LinkedList(1,2,3,4)
             a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

             scala> val b = new StringBuilder()
             b: StringBuilder =

             scala> a.addString(b, "LinkedList(", ", ", ")")
             res1: StringBuilder = LinkedList(1, 2, 3, 4)

    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

22. #### 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 an 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).

    B

      the type of accumulated results

    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

23. #### 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
    Exceptions thrown
      IndexOutOfBoundsException

      if the index is not valid

24. #### final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type `T0`.

    Cast the receiver object to be of type `T0`.

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

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown
      ClassCastException

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

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

26. #### def capitalize: String

    Returns this string with first character converted to upper case

27. #### 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()
    Note

      not specified by SLS as a member of AnyRef

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

    [use case]

    [use case]
    B

      the element type of the returned collection.

    pf

      the partial function which filters and maps the string.

    returns

      a new string resulting from applying the given 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

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

30. #### 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)`

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

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

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

    Implement this method to determine how instances of A will be sorted.

    Returns `x` where:

    - `x < 0` when `this < that`
    - `x == 0` when `this == that`
    - `x > 0` when `this > that`
    Definition Classes
      StringLike → Ordered

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

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

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

    Definition Classes
      Ordered → Comparable

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

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

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

    [use case]

    [use case]
    xs

      the array to fill.

    start

      the starting index.

    len

      the maximal number of elements to copy.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

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

    [use case]

    [use case]
    xs

      the array to fill.

    Definition Classes
      TraversableOnce → GenTraversableOnce

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

    [use case]

    [use case]
    xs

      the array to fill.

    start

      the starting index.

    Definition Classes
      TraversableOnce → GenTraversableOnce

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

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

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

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

    [use case]

    [use case]
    that

      the sequence of elements to remove

    returns

      a new string 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

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

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

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

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

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

47. #### final 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.

    Definition Classes
      AnyRef

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

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

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

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

52. #### 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()
    Note

      not specified by SLS as a member of AnyRef

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

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

    [use case]

    [use case]
    B

      the element type of the returned collection.

    f

      the function to apply to each element.

    returns

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

    Definition Classes
      TraversableLike → GenTraversableLike → FilterMonadic

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

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

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

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

    A1

      a type parameter for the binary operator, a supertype of `A`.

    z

      a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., `Nil` for list concatenation, 0 for addition, or 1 for multiplication.)

    op

      a binary operator that must be associative

    returns

      the result of applying fold operator `op` between all the elements and `z`

    Definition Classes
      TraversableOnce → GenTraversableOnce

56. #### 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, x1), x2, ..., xn)

      where `x1, ..., xn` are the elements of this string.

    Definition Classes
      IndexedSeqOptimized → TraversableOnce → GenTraversableOnce

57. #### 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(x1, op(x2, ... op(xn, z)...))

      where `x1, ..., xn` are the elements of this string.

    Definition Classes
      IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce

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

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

    [use case]

    [use case]
    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

60. #### def format(args: Any*): String

    Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.

    Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.

    The interpretation of the formatting patterns is described in `java.util.Formatter`, with the addition that classes deriving from `ScalaNumber` (such as scala.BigInt and scala.BigDecimal) are unwrapped to pass a type which `Formatter` understands.

    args

      the arguments used to instantiating the pattern.

    Exceptions thrown
      `java.lang.IllegalArgumentException`

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

    Exceptions thrown
      `java.lang.IllegalArgumentException`

62. #### final def getClass(): 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.

    Definition Classes
      AnyRef → Any
    Note

      not specified by SLS as a member of AnyRef

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

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

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

66. #### 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
      IndexedSeqLike → GenSeqLike → AnyRef → Any

67. #### 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
    Exceptions thrown
      `NoSuchElementException`

      if the string is empty.

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

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

    [use case]

    [use case]
    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

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

    [use case]

    [use case]
    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

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

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

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

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

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

76. #### 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
    Exceptions thrown
      `UnsupportedOperationException`

      if the string is empty.

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

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

    [use case]

    [use case]
    that

      the sequence of elements to intersect with.

    returns

      a new string 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

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

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

81. #### final def isInstanceOf[T0]: Boolean

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

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

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

    returns

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

    Definition Classes
      Any

82. #### final def isTraversableAgain: Boolean

    Tests whether this string can be repeatedly traversed.

    Tests whether this string can be repeatedly traversed.

    returns

      `true`

    Definition Classes
      GenTraversableLike → GenTraversableOnce

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

84. #### def last: Char

    Selects the last element.

    Selects the last element.

    returns

      The last element of this string.

    Definition Classes
      IndexedSeqOptimized → TraversableLike
    Exceptions thrown
      NoSuchElementException

      If the string is empty.

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

    [use case]

    [use case]
    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

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

    [use case]

    [use case]
    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

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

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

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

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

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

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

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

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

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

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

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

    [use case]

    [use case]
    B

      the element type of the returned collection.

    f

      the function to apply to each element.

    returns

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

    Definition Classes
      TraversableLike → GenTraversableLike → FilterMonadic

98. #### def max: A

    [use case]

    [use case]
    returns

      the largest element of this string.

    Definition Classes
      TraversableOnce → GenTraversableOnce

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

    Definition Classes
      TraversableOnce → GenTraversableOnce

100. #### def min: A

     [use case]

     [use case]
     returns

       the smallest element of this string

     Definition Classes
       TraversableOnce → GenTraversableOnce

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

     Definition Classes
       TraversableOnce → GenTraversableOnce

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

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

104. #### 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)"`

105. #### final 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.

     Definition Classes
       AnyRef

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

107. #### final 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.

     Definition Classes
       AnyRef
     Note

       not specified by SLS as a member of AnyRef

108. #### final 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.

     Definition Classes
       AnyRef
     Note

       not specified by SLS as a member of AnyRef

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

     [use case]

     [use case]
     len

       the target length

     elem

       the padding value

     returns

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

     Definition Classes
       SeqLike → GenSeqLike

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

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

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

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

     [use case]

     [use case]
     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`.

     Definition Classes
       SeqLike → GenSeqLike

114. #### 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)`

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

116. #### def product: A

     [use case]

     [use case]
     returns

       the product of all elements in this string of numbers of type `Int`. Instead of `Int`, any other type `T` with an implicit `Numeric[T]` implementation can be used as element type of the string and as result type of `product`. Examples of such types are: `Long`, `Float`, `Double`, `BigInt`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

117. #### def r: Regex

     You can follow a string with `.r`, turning it into a `Regex`.

     You can follow a string with `.r`, turning it into a `Regex`. E.g.

     """A\w*""".r is the regular expression for identifiers starting with `A`.

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

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

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

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

     A1

       A type parameter for the binary operator, a supertype of `A`.

     op

       A binary operator that must be associative.

     returns

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

     Definition Classes
       TraversableOnce → GenTraversableOnce
     Exceptions thrown
       UnsupportedOperationException

       if this string is empty.

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

     Definition Classes
       IndexedSeqOptimized → TraversableOnce

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

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

     Reduces the elements of this string, if any, using the specified associative binary operator.

     Reduces the elements of this string, if any, using the specified associative binary operator.

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

     A1

       A type parameter for the binary operator, a supertype of `A`.

     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

122. #### 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 `x1, ..., xn` are the elements of this string.

     Definition Classes
       IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
     Exceptions thrown
       `UnsupportedOperationException`

       if this string is empty.

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

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

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

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

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

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

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

     [use case]

     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.

     f

       the function to apply to each element.

     returns

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

     Definition Classes
       SeqLike → GenSeqLike

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

     Attributes
       protected[this]
     Definition Classes
       TraversableOnce

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

     [use case]

     [use case]
     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

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

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

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

       (Changed in version 2.9.0) The behavior of `scanRight` has changed. The previous behavior can be reproduced with scanRight.reverse.

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

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

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

137. #### def sliding(size: Int, step: Int): Iterator[Repr]

     Definition Classes
       IterableLike

138. #### def sliding(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

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

140. #### 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")

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

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

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

     Annotations
       @throws( clazz = ... )

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

     Annotations
       @throws( clazz = ... )

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

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

     Note: 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

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

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

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

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

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

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

     Returns this string with the given `prefix` stripped.

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

154. #### def sum: A

     [use case]

     [use case]
     returns

       the sum of all elements in this string of numbers of type `Int`. Instead of `Int`, any other type `T` with an implicit `Numeric[T]` implementation can be used as element type of the string and as result type of `sum`. Examples of such types are: `Long`, `Float`, `Double`, `BigInt`.

     Definition Classes
       TraversableOnce → GenTraversableOnce

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

     Definition Classes
       AnyRef

156. #### 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
     Exceptions thrown
       `UnsupportedOperationException`

       if the string is empty.

157. #### 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)`

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

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

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

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

162. #### def toArray: Array[A]

     [use case]

     [use case]
     returns

       an array containing all elements of this string. A `ClassManifest` must be available for the element type of this string.

     Definition Classes
       StringLike → TraversableOnce → GenTraversableOnce

163. #### def toBoolean: Boolean

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

165. #### def toByte: Byte

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

167. #### def toDouble: Double

168. #### def toFloat: Float

169. #### def toIndexedSeq: IndexedSeq[Char]

     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

170. #### def toInt: Int

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

172. #### 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
       IterableLike → TraversableLike → GenTraversableOnce

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

174. #### def toLong: Long

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

     [use case]

     [use case]
     returns

       a map of type `immutable.Map[T, U]` containing all key/value pairs of type `(T, U)` of this string.

     Definition Classes
       TraversableOnce → GenTraversableOnce

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

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

178. #### def toShort: Short

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

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

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

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

     [use case]

     [use case]
     that

       the sequence to add.

     returns

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

     Definition Classes
       SeqLike → GenSeqLike

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

     [use case]

     [use case]
     index

       the position of the replacement

     elem

       the replacing element

     returns

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

     Definition Classes
       SeqLike → GenSeqLike

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

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

186. #### final def wait(): Unit

     Definition Classes
       AnyRef
     Annotations
       @throws()

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

     Definition Classes
       AnyRef
     Annotations
       @throws()

188. #### final def wait(arg0: Long): Unit

     Definition Classes
       AnyRef
     Annotations
       @throws()

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

190. #### def zip[B](that: GenIterable[B]): String[(A, B)]

     [use case]

     [use case]
     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 string 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

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

     [use case]

     [use case]
     B

       the type of the second half of the returned pairs

     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 string 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

192. #### def zipWithIndex: String[(A, Int)]

     [use case]

     [use case]
     returns

       A new string containing pairs consisting of all elements of this string paired with their index. Indices start at `0`. @example `List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))`

     Definition Classes
       IndexedSeqOptimized → IterableLike → GenIterableLike

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