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 - Blame
  • StringLike.scala - History
• Since
  • 2.8

Type Members

class Elements extends AbstractIterator[A] with BufferedIterator[A] with Serializable

The class of the iterator returned by the iterator method. multiple take , drop , and slice operations on this iterator are bunched together for better efficiency.

• Attributes
  • protected
• Definition Classes
  • IndexedSeqLike
• Annotations
  • @ SerialVersionUID ()

type Self = Repr

The type implementing this traversable

• Attributes
  • protected[this]
• Definition Classes
  • TraversableLike

class WithFilter extends FilterMonadic[A, Repr]

A class supporting filtered operations. Instances of this class are returned by method withFilter .

• Definition Classes
  • TraversableLike

Concrete Value Members From scala.collection.GenSeqLike

def equals(that: Any): Boolean

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 → Any

(defined at scala.collection.GenSeqLike)

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

[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 (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

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

[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 (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def indexWhere(p: (Char) ⇒ Boolean): Int

Finds index of first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the index of the first element of this general sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def isDefinedAt(idx: Int): Boolean

Tests whether this general sequence 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 general sequence contains an element at position idx , false otherwise.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

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

[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 (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

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

[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 (as determined by == ) to elem , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def lastIndexWhere(p: (Char) ⇒ Boolean): Int

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the index of the last element of this general sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def prefixLength(p: (Char) ⇒ Boolean): Int

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

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • the length of the longest prefix of this general sequence such that every element of the segment satisfies the predicate p .
• Definition Classes
  • GenSeqLike

(defined at scala.collection.GenSeqLike)

def startsWith[B](that: GenSeq[B]): Boolean

Tests whether this general sequence 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

(defined at scala.collection.GenSeqLike)

Abstract Value Members From scala.collection.IndexedSeqLike

abstract def seq: collection.IndexedSeq[Char]

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

(defined at scala.collection.IndexedSeqLike)

Concrete Value Members From scala.collection.IndexedSeqLike

def iterator: Iterator[Char]

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

• returns
  • the new iterator
• Definition Classes
  • IndexedSeqLike → IterableLike → GenIterableLike

(defined at scala.collection.IndexedSeqLike)

def thisCollection: collection.IndexedSeq[Char]

The underlying collection seen as an instance of IndexedSeq . 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

(defined at scala.collection.IndexedSeqLike)

def toBuffer[A1 >: Char]: Buffer[A1]

Uses the contents of this sequence to create a new mutable buffer.

• returns
  • a buffer containing all elements of this sequence.
• Definition Classes
  • IndexedSeqLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqLike)

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

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

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

(defined at scala.collection.IndexedSeqLike)

Concrete Value Members From scala.collection.IndexedSeqOptimized

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

[use case]

Copies the 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 target 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.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

def drop(n: Int): Repr

Selects all elements except first n ones.

• n
  • the number of elements to drop from this sequence.
• returns
  • a sequence consisting of all elements of this sequence except the first n ones, or else the empty sequence, if this sequence has less than n elements.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

def dropRight(n: Int): Repr

Selects all elements except last n ones.

• n
  • The number of elements to take
• returns
  • a sequence consisting of all elements of this sequence except the last n ones, or else the empty sequence, if this sequence has less than n elements.
• Definition Classes
  • IndexedSeqOptimized → IterableLike

(defined at scala.collection.IndexedSeqOptimized)

def dropWhile(p: (Char) ⇒ Boolean): Repr

Drops longest prefix of elements that satisfy a predicate.

• returns
  • the longest suffix of this sequence whose first element does not satisfy the predicate p .
• Definition Classes
  • IndexedSeqOptimized → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

def endsWith[B](that: GenSeq[B]): Boolean

Tests whether this sequence ends with the given sequence.

• that
  • the sequence to test
• returns
  • true if this sequence has that as a suffix, false otherwise.
• Definition Classes
  • IndexedSeqOptimized → SeqLike → GenSeqLike

(defined at scala.collection.IndexedSeqOptimized)

def exists(p: (Char) ⇒ Boolean): Boolean

Tests whether a predicate holds for at least one element of this sequence.

• p
  • the predicate used to test elements.
• returns
  • false if this sequence is empty, otherwise true if the given predicate p holds for some of the elements of this sequence, otherwise false
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

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

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

• p
  • the predicate used to test elements.
• returns
  • an option value containing the first element in the sequence that satisfies p , or None if none exists.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

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

Applies a binary operator to a start value and all elements of this sequence, 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 sequence, going left to right with the start value z on the left:

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

where `x1, ..., xn` are the elements of this sequence. Returns `z` if this
sequence is empty.

• Definition Classes
  • IndexedSeqOptimized → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

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

Applies a binary operator to all elements of this sequence 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 sequence, going right to left with the start value z on the right:

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

where `x1, ..., xn` are the elements of this sequence. Returns `z` if this
sequence is empty.

• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

def forall(p: (Char) ⇒ Boolean): Boolean

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

• p
  • the predicate used to test elements.
• returns
  • true if this sequence is empty or the given predicate p holds for all elements of this sequence, otherwise false .
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IndexedSeqOptimized)

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

[use case]

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.

• 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

(defined at scala.collection.IndexedSeqOptimized)

def head: Char

Selects the first element of this sequence.

• returns
  • the first element of this sequence.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
• Exceptions thrown
  • NoSuchElementException if the sequence is empty.

(defined at scala.collection.IndexedSeqOptimized)

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

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 sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • IndexedSeqOptimized → SeqLike → GenSeqLike

(defined at scala.collection.IndexedSeqOptimized)

def last: Char

Selects the last element.

• returns
  • The last element of this sequence.
• Definition Classes
  • IndexedSeqOptimized → TraversableLike → GenTraversableLike
• Exceptions thrown
  • NoSuchElementException If the sequence is empty.

(defined at scala.collection.IndexedSeqOptimized)

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

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 sequence that satisfies the predicate p , or -1 , if none exists.
• Definition Classes
  • IndexedSeqOptimized → SeqLike → GenSeqLike

(defined at scala.collection.IndexedSeqOptimized)

def lengthCompare(len: Int): Int

Compares the length of this sequence 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

(defined at scala.collection.IndexedSeqOptimized)

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

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

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this sequence, going left to right:

    op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
    

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

• Definition Classes
  • IndexedSeqOptimized → TraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this sequence is empty.

(defined at scala.collection.IndexedSeqOptimized)

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

Applies a binary operator to all elements of this sequence, 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 sequence, going right to left:

    op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
    

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

• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this sequence is empty.

(defined at scala.collection.IndexedSeqOptimized)

def reverseIterator: Iterator[Char]

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 sequence in reversed order
• Definition Classes
  • IndexedSeqOptimized → SeqLike

(defined at scala.collection.IndexedSeqOptimized)

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

[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.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → GenIterableLike

(defined at scala.collection.IndexedSeqOptimized)

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

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 sequence starting from index from such that every element of the segment satisfies the predicate p .
• Definition Classes
  • IndexedSeqOptimized → SeqLike → GenSeqLike

(defined at scala.collection.IndexedSeqOptimized)

def span(p: (Char) ⇒ Boolean): (Repr, Repr)

Splits this sequence 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.

• returns
  • a pair consisting of the longest prefix of this sequence whose elements all satisfy p , and the rest of this sequence.
• Definition Classes
  • IndexedSeqOptimized → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

def splitAt(n: Int): (Repr, Repr)

Splits this sequence 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 sequences consisting of the first n elements of this sequence, and the other elements.
• Definition Classes
  • IndexedSeqOptimized → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

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

Tests whether this sequence 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 sequence at index offset , otherwise false .
• Definition Classes
  • IndexedSeqOptimized → SeqLike → GenSeqLike

(defined at scala.collection.IndexedSeqOptimized)

def take(n: Int): Repr

Selects first n elements.

• n
  • the number of elements to take from this sequence.
• returns
  • a sequence consisting only of the first n elements of this sequence, or else the whole sequence, if it has less than n elements.
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

def takeRight(n: Int): Repr

Selects last n elements.

• n
  • the number of elements to take
• returns
  • a sequence consisting only of the last n elements of this sequence, or else the whole sequence, if it has less than n elements.
• Definition Classes
  • IndexedSeqOptimized → IterableLike

(defined at scala.collection.IndexedSeqOptimized)

def takeWhile(p: (Char) ⇒ Boolean): Repr

Takes longest prefix of elements that satisfy a predicate.

• returns
  • the longest prefix of this sequence whose elements all satisfy the predicate p .
• Definition Classes
  • IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IndexedSeqOptimized)

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

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

(defined at scala.collection.IndexedSeqOptimized)

Concrete Value Members From scala.collection.IterableLike

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.

• that
  • The object with which this iterable collection should be compared
• returns
  • true , if this iterable collection 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

(defined at scala.collection.IterableLike)

def grouped(size: Int): Iterator[Repr]

Partitions elements in fixed size iterable collections.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections of size size , except the last will be less than size size if the elements don’t divide evenly.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method grouped

(defined at scala.collection.IterableLike)

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.) “Sliding window” step is 1 by default.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections 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
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def sliding(size: Int, step: 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.)

• size
  • the number of elements per group
• step
  • the distance between the first elements of successive groups
• returns
  • An iterator producing iterable collections 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
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def toIterable: collection.Iterable[Char]

Returns this iterable collection as an iterable collection.

A new collection will not be built; lazy collections will stay lazy.

Note: will not terminate for infinite-sized collections.

• returns
  • an Iterable containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def toIterator: Iterator[Char]

Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator .

Note: will not terminate for infinite-sized collections.

• returns
  • an Iterator containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.IterableLike)

def toStream: Stream[Char]

Converts this iterable collection to a stream.

• returns
  • a stream containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce

(defined at scala.collection.IterableLike)

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

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

• 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

(defined at scala.collection.IterableLike)

Concrete Value Members From scala.collection.Parallelizable

def par: ParSeq[Char]

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

(defined at scala.collection.Parallelizable)

Concrete Value Members From scala.collection.SeqLike

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

[use case]

A copy of the string with an element prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Also, the original string is not modified, so you will want to capture the result.

Example:

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

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)

• elem
  • the prepended element
• returns
  • a new string consisting of elem followed by all elements of this string.
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

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

[use case]

A copy of this string with an element appended.

A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Example:

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

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)

• elem
  • the appended element
• returns
  • a new string consisting of all elements of this string followed by elem .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

def combinations(n: Int): Iterator[Repr]

Iterates over combinations. A combination of length n is a subsequence of the original sequence, with the elements taken in order. Thus, "xy" and "yy" are both length-2 combinations of "xyy" , but "yx" is not. If there is more than one way to generate the same subsequence, only one will be returned.

For example, "xyyy" has three different ways to generate "xy" depending on whether the first, second, or third "y" is selected. However, since all are identical, only one will be chosen. Which of the three will be taken is an implementation detail that is not defined.

• returns
  • An Iterator which traverses the possible n-element combinations of this sequence.
• Definition Classes
  • SeqLike

Example:

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

(defined at scala.collection.SeqLike)

def containsSlice[B](that: GenSeq[B]): Boolean

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

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • true if this sequence contains a slice with the same elements as that , otherwise false .
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def contains[A1 >: Char](elem: A1): Boolean

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

Note: may not terminate for infinite-sized collections.

• elem
  • the element to test.
• returns
  • true if this sequence has an element that is equal (as determined by == ) to elem , false otherwise.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

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

Tests whether every element of this sequence 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 sequence and y of that , otherwise false .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

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

[use case]

Computes the multiset difference between this string and another sequence.

• 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

(defined at scala.collection.SeqLike)

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

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

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • the first index such that the elements of this sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

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

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

Note: may not terminate for infinite-sized collections.

• that
  • the sequence to test
• from
  • the start index
• returns
  • the first index >= from such that the elements of this sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

def indices: Range

Produces the range of all indices of this sequence.

• returns
  • a Range value from 0 to one less than the length of this sequence.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

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

[use case]

Computes the multiset intersection between this string and another sequence.

• 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

(defined at scala.collection.SeqLike)

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

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

Note: will not terminate for infinite-sized collections.

• that
  • the sequence to test
• returns
  • the last index such that the elements of this sequence starting a this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

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

Finds last index before or at a given end index where this sequence 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 sequence starting at this index match the elements of sequence that , or -1 of no such subsequence exists.
• Definition Classes
  • SeqLike

(defined at scala.collection.SeqLike)

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

[use case]

A copy of this string with an element value appended until a given target length is reached.

• 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

(defined at scala.collection.SeqLike)

def parCombiner: Combiner[Char, ParSeq[Char]]

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

(defined at scala.collection.SeqLike)

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

[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 .
• Definition Classes
  • SeqLike → GenSeqLike

(defined at scala.collection.SeqLike)

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

[use case]

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

(defined at scala.collection.SeqLike)

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

Sorts this Seq 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 sequence consisting of the elements of this sequence sorted according to the ordering where x < y if ord.lt(f(x), f(y)) .
• Definition Classes
  • SeqLike
• See also
  • scala.math.Ordering Note: will not terminate for infinite-sized collections.

Example:

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)

(defined at scala.collection.SeqLike)

def sortWith(lt: (Char, Char) ⇒ Boolean): Repr

Sorts this sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

The sort is stable. That is, elements that are equal (as determined by lt ) appear in the same order in the sorted sequence as in the original.

• lt
  • the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
• returns
  • a sequence consisting of the elements of this sequence sorted according to the comparison function lt .
• Definition Classes
  • SeqLike

Example:

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

(defined at scala.collection.SeqLike)

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

Sorts this sequence according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by lt ) appear in the same order in the sorted sequence as in the original.

• ord
  • the ordering to be used to compare elements.
• returns
  • a sequence consisting of the elements of this sequence sorted according to the ordering ord .
• Definition Classes
  • SeqLike
• See also
  • scala.math.Ordering

(defined at scala.collection.SeqLike)

def toSeq: collection.Seq[Char]

Converts this sequence to a sequence.

Note: will not terminate for infinite-sized collections.

A new collection will not be built; in particular, lazy sequences will stay lazy.

• returns
  • a sequence containing all elements of this sequence.
• Definition Classes
  • SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.SeqLike)

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

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

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

• 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

(defined at scala.collection.SeqLike)

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

[use case]

A copy of this string with one single replaced element.

• 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

(defined at scala.collection.SeqLike)

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

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

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

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 sequence, starting at index from and extending up to (but not including) index until .
• Definition Classes
  • SeqLike → IterableLike → TraversableLike

(defined at scala.collection.SeqLike)

def view: SeqView[Char, Repr]

Creates a non-strict view of this sequence.

• returns
  • a non-strict view of this sequence.
• Definition Classes
  • SeqLike → IterableLike → TraversableLike

(defined at scala.collection.SeqLike)

Concrete Value Members From scala.collection.TraversableLike

def ++:[B >: Char, That](that: collection.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.

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 and the new element type B .
• returns
  • a new collection of type That which contains all elements of this traversable collection followed by all elements of that .
• Definition Classes
  • TraversableLike

(defined at scala.collection.TraversableLike)

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

[use case]

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)

• 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

(defined at scala.collection.TraversableLike)

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

[use case]

Returns a new string containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the string is the most specific superclass encompassing the element types of the two operands.

Example:

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

scala> val b = List(2)
b: List[Int] = List(2)

scala> val c = a ++ b
c: List[Int] = List(1, 2)

scala> val d = List('a')
d: List[Char] = List(a)

scala> val e = c ++ d
e: List[AnyVal] = List(1, 2, a)

• 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

(defined at scala.collection.TraversableLike)

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

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

(defined at scala.collection.TraversableLike)

def filter(p: (Char) ⇒ Boolean): Repr

Selects all elements of this traversable collection which satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • a new traversable collection consisting of all elements of this traversable collection that satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def filterNot(p: (Char) ⇒ Boolean): Repr

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

• p
  • the predicate used to test elements.
• returns
  • a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

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

[use case]

Builds a new collection by applying a function to all elements of this string and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of string. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

• 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

(defined at scala.collection.TraversableLike)

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

Partitions this traversable collection into a map of traversable collections 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 traversable collection.

• K
  • the type of keys returned by the discriminator function.
• f
  • the discriminator function.
• returns
  • A map from keys to traversable collections such that the following invariant holds:

    (xs groupBy f)(k) = xs filter (x => f(x) == k)
    

That is, every key `k` is bound to a traversable collection of those
elements `x` for which `f(x)` equals `k` .

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def headOption: Option[Char]

Optionally selects the first element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• returns
  • the first element of this traversable collection if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def lastOption: Option[Char]

Optionally selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• returns
  • the last element of this traversable collection$ if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

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

[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 string resulting from applying the given function f to each element of this string and collecting the results.
• Definition Classes
  • TraversableLike → GenTraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

def partition(p: (Char) ⇒ Boolean): (Repr, Repr)

Partitions this traversable collection in two traversable collections according to a predicate.

• p
  • the predicate on which to partition.
• returns
  • a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate p and the second traversable collection consists of all elements that don’t. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

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

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

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• 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 and the new element type B .
• returns
  • collection with intermediate results
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

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

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

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

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

(defined at scala.collection.TraversableLike)

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.

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 traversable collection containing the prefix scan of the elements in this traversable collection
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def toTraversable: collection.Traversable[Char]

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

Note: will not terminate for infinite-sized collections.

• returns
  • a Traversable containing all elements of this traversable collection.
• Definition Classes
  • TraversableLike → TraversableOnce → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.TraversableLike)

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

Creates a non-strict filter of this traversable collection.

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.

Note: might return different results for different runs, unless the underlying collection type is ordered.

• 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 traversable collection which satisfy the predicate p .
• Definition Classes
  • TraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

Concrete Value Members From scala.collection.TraversableOnce

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

Applies a binary operator to a start value and all elements of this traversable or iterator, 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 = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

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

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• 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 traversable or iterator, going left to right with the start value z on the left:

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

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

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

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

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Examples:

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

scala> val a = List(1,2,3,4)
a: List[Int] = List(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 traversable or iterator, going right to left with the start value z on the right:

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

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder): StringBuilder

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

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

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

• b
  • the string builder to which elements are appended.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this traversable or iterator 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 traversable or iterator, separated by the string sep .

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(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

(defined at scala.collection.TraversableOnce)

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

Appends all elements of this traversable or iterator 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 traversable or iterator are separated by the string sep .

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(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

(defined at scala.collection.TraversableOnce)

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

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce . It is similar to foldLeft in that it doesn’t require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop , starting with z (like foldLeft ). Those intermediate results are then combined by using combop (like fold ). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

• 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) and may be evaluated more than once
• 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

(defined at scala.collection.TraversableOnce)

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

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

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

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

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

(defined at scala.collection.TraversableOnce)

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

[use case]

Copies the elements 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 target array is reached.

• xs
  • the array to fill.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[use case]

Copies the elements 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 target array is reached.

• xs
  • the array to fill.
• start
  • the starting index.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

Copies all elements of this traversable or iterator to a buffer.

Note: will not terminate for infinite-sized collections.

• dest
  • The buffer to which elements are copied.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def count(p: (Char) ⇒ Boolean): Int

Counts the number of elements in the traversable or iterator which satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • the number of elements satisfying the predicate p .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

Folds the elements of this traversable or iterator using the specified associative binary operator.

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

Note: will not terminate for infinite-sized collections.

• 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 the fold operator op between all the elements and z , or z if this traversable or iterator is empty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[use case]

Finds the first element which yields the largest value measured by function f.

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this string with the largest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[use case]

Finds the first element which yields the smallest value measured by function f.

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this string with the smallest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def mkString(sep: String): String

Displays all elements of this traversable or iterator in a string using a separator string.

• sep
  • the separator string.
• returns
  • a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

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

(defined at scala.collection.TraversableOnce)

def mkString(start: String, sep: String, end: String): String

Displays all elements of this traversable or iterator 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 traversable or iterator. 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 traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

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

(defined at scala.collection.TraversableOnce)

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

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceLeft(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

Reduces the elements of this traversable or iterator, 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

(defined at scala.collection.TraversableOnce)

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

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceRight(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

Reduces the elements of this traversable or iterator 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 traversable or iterator is nonempty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this traversable or iterator is empty.

(defined at scala.collection.TraversableOnce)

def reversed: scala.List[Char]

• Attributes
  • protected[this]
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def toIndexedSeq: IndexedSeq[Char]

Converts this traversable or iterator to an indexed sequence.

Note: will not terminate for infinite-sized collections.

• returns
  • an indexed sequence containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toList: scala.List[Char]

Converts this traversable or iterator to a list.

Note: will not terminate for infinite-sized collections.

• returns
  • a list containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[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 of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this string.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toSet[B >: Char]: Set[B]

Converts this traversable or iterator to a set.

Note: will not terminate for infinite-sized collections.

• returns
  • a set containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toVector: scala.Vector[Char]

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

• returns
  • a vector containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

Abstract Value Members From scala.collection.immutable.StringLike

abstract def newBuilder: Builder[Char, Repr]

Creates a string builder buffer as builder for this class

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

(defined at scala.collection.immutable.StringLike)

Concrete Value Members From scala.collection.immutable.StringLike

def *(n: Int): String

Return the current string concatenated n times.

(defined at scala.collection.immutable.StringLike)

def apply(n: Int): Char

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

(defined at scala.collection.immutable.StringLike)

def compare(other: String): Int

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

(defined at scala.collection.immutable.StringLike)

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.

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 *

(defined at scala.collection.immutable.StringLike)

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.

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

• l
  • an instance of java.util.Locale
• args
  • the arguments used to instantiating the pattern.
• Exceptions thrown *

(defined at scala.collection.immutable.StringLike)

def r(groupNames: String*): Regex

You can follow a string with .r(g1, ... , gn) , turning it into a Regex , with group names g1 through gn.

"""(\d\d)-(\d\d)-(\d\d\d\d)""".r("month", "day", "year") matches dates and provides its subcomponents through groups named “month”, “day” and “year”.

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

(defined at scala.collection.immutable.StringLike)

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 .

(defined at scala.collection.immutable.StringLike)

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

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

(defined at scala.collection.immutable.StringLike)

def slice(from: Int, until: Int): Repr

Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

from <= indexOf(x) < until

• 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

(defined at scala.collection.immutable.StringLike)

def split(separators: Array[Char]): Array[String]

• Annotations
  • @ throws (clazz =…)

(defined at scala.collection.immutable.StringLike)

def split(separator: Char): Array[String]

Split this string around the separator character

If this string is the empty string, returns an array of strings that contains a single empty string.

If this string is not the empty string, returns an array containing the substrings terminated by the start of the string, the end of the string or the separator character, excluding empty trailing substrings

If the separator character is a surrogate character, only split on matching surrogate characters if they are not part of a surrogate pair

The behaviour follows, and is implemented in terms of String.split(re: String)

• separator
  • the character used as a delimiter

Example:

"a.b".split('.') //returns Array("a", "b")
//splitting the empty string always returns the array with a single
//empty string
"".split('.') //returns Array("")
//only trailing empty substrings are removed
"a.".split('.') //returns Array("a")
".a.".split('.') //returns Array("", "a")
"..a..".split('.') //returns Array("", "", "a")
//all parts are empty and trailing
".".split('.') //returns Array()
"..".split('.') //returns Array()
//surrogate pairs
val high = 0xD852.toChar
val low = 0xDF62.toChar
val highstring = high.toString
val lowstring = low.toString
//well-formed surrogate pairs are not split
val highlow = highstring + lowstring
highlow.split(high) //returns Array(highlow)
//bare surrogate characters are split
val bare = "_" + highstring + "_"
bare.split(high) //returns Array("_", "_")

(defined at scala.collection.immutable.StringLike)

def stripMargin(marginChar: Char): String

For every line in this string:

Strip a leading prefix consisting of blanks or control characters followed by marginChar from the line.

(defined at scala.collection.immutable.StringLike)

def stripPrefix(prefix: String): String

Returns this string with the given prefix stripped. If this string does not start with prefix , it is returned unchanged.

(defined at scala.collection.immutable.StringLike)

def stripSuffix(suffix: String): String

Returns this string with the given suffix stripped. If this string does not end with suffix , it is returned unchanged.

(defined at scala.collection.immutable.StringLike)

Concrete Value Members From scala.math.Ordered

def <(that: String): Boolean

Returns true if this is less than that

• Definition Classes
  • Ordered

(defined at scala.math.Ordered)

def <=(that: String): Boolean

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

• Definition Classes
  • Ordered

(defined at scala.math.Ordered)

def >(that: String): Boolean

Returns true if this is greater than that .

• Definition Classes
  • Ordered

(defined at scala.math.Ordered)

def >=(that: String): Boolean

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

• Definition Classes
  • Ordered

(defined at scala.math.Ordered)

def compareTo(that: String): Int

Result of comparing this with operand that .

• Definition Classes
  • Ordered → Comparable

(defined at scala.math.Ordered)

Concrete Value Members From Implicit scala.collection.parallel.CollectionsHaveToParArray ——————————————————————————–

def toParArray: ParArray[T]

• Implicit information
  • This member is added by an implicit conversion from StringLike [Repr] to CollectionsHaveToParArray [StringLike [Repr], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (StringLike [Repr]) ⇒ GenTraversableOnce [T] is in scope.
• Definition Classes
  • CollectionsHaveToParArray (added by implicit convertion: scala.collection.parallel.CollectionsHaveToParArray)

Full Source:

/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2002-2013, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */

package scala
package collection
package immutable

import mutable.Builder
import scala.util.matching.Regex
import scala.math.ScalaNumber
import scala.reflect.ClassTag

/** A companion object for the `StringLike` containing some constants.
 *  @since 2.8
 */
object StringLike {
  // just statics for companion class.
  private final val LF = 0x0A
  private final val FF = 0x0C
  private final val CR = 0x0D
  private final val SU = 0x1A
}

import StringLike._

/** A trait describing stringlike collections.
 *
 *  @tparam Repr   The type of the actual collection inheriting `StringLike`.
 *
 *  @since 2.8
 *  @define Coll `String`
 *  @define coll string
 *  @define orderDependent
 *  @define orderDependentFold
 *  @define mayNotTerminateInf
 *  @define willNotTerminateInf
 */
trait StringLike[+Repr] extends Any with scala.collection.IndexedSeqOptimized[Char, Repr] with Ordered[String] {
self =>

  /** Creates a string builder buffer as builder for this class */
  protected[this] def newBuilder: Builder[Char, Repr]

  /** Return element at index `n`
   *  @throws   IndexOutOfBoundsException if the index is not valid
   */
  def apply(n: Int): Char = toString charAt n

  def length: Int = toString.length

  override def mkString = toString

  override def slice(from: Int, until: Int): Repr = {
    val start = from max 0
    val end   = until min length

    if (start >= end) newBuilder.result()
    else (newBuilder ++= toString.substring(start, end)).result()
  }

  /** Return the current string concatenated `n` times.
   */
  def * (n: Int): String = {
    val buf = new StringBuilder
    for (i <- 0 until n) buf append toString
    buf.toString
  }

  override def compare(other: String) = toString compareTo other

  private def isLineBreak(c: Char) = c == LF || c == FF

  /**
   *  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).
   */
  def stripLineEnd: String = {
    val len = toString.length
    if (len == 0) toString
    else {
      val last = apply(len - 1)
      if (isLineBreak(last))
        toString.substring(0, if (last == LF && len >= 2 && apply(len - 2) == CR) len - 2 else len - 1)
      else
        toString
    }
  }

  /** 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)
   */
  def linesWithSeparators: Iterator[String] = new AbstractIterator[String] {
    val str = self.toString
    private val len = str.length
    private var index = 0
    def hasNext: Boolean = index < len
    def next(): String = {
      if (index >= len) throw new NoSuchElementException("next on empty iterator")
      val start = index
      while (index < len && !isLineBreak(apply(index))) index += 1
      index += 1
      str.substring(start, index min len)
    }
  }

  /** Return all lines in this string in an iterator, excluding trailing line
   *  end characters, i.e., apply `.stripLineEnd` to all lines
   *  returned by `linesWithSeparators`.
   */
  def lines: Iterator[String] =
    linesWithSeparators map (line => new WrappedString(line).stripLineEnd)

  /** Return all lines in this string in an iterator, excluding trailing line
   *  end characters, i.e., apply `.stripLineEnd` to all lines
   *  returned by `linesWithSeparators`.
   */
  @deprecated("Use `lines` instead.","2.11.0")
  def linesIterator: Iterator[String] =
    linesWithSeparators map (line => new WrappedString(line).stripLineEnd)

  /** Returns this string with first character converted to upper case.
   * If the first character of the string is capitalized, it is returned unchanged.
   */
  def capitalize: String =
    if (toString == null) null
    else if (toString.length == 0) ""
    else if (toString.charAt(0).isUpper) toString
    else {
      val chars = toString.toCharArray
      chars(0) = chars(0).toUpper
      new String(chars)
    }

  /** Returns this string with the given `prefix` stripped. If this string does not
   *  start with `prefix`, it is returned unchanged.
   */
  def stripPrefix(prefix: String) =
    if (toString.startsWith(prefix)) toString.substring(prefix.length)
    else toString

  /** Returns this string with the given `suffix` stripped. If this string does not
   *  end with `suffix`, it is returned unchanged.
   */
  def stripSuffix(suffix: String) =
    if (toString.endsWith(suffix)) toString.substring(0, toString.length() - suffix.length)
    else toString

  /** 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.
   *
   *  @param    literal     the string which should be replaced everywhere it occurs
   *  @param    replacement the replacement string
   *  @return               the resulting string
   */
  def replaceAllLiterally(literal: String, replacement: String): String = {
    val arg1 = Regex.quote(literal)
    val arg2 = Regex.quoteReplacement(replacement)

    toString.replaceAll(arg1, arg2)
  }

  /** For every line in this string:
   *
   *  Strip a leading prefix consisting of blanks or control characters
   *  followed by `marginChar` from the line.
   */
  def stripMargin(marginChar: Char): String = {
    val buf = new StringBuilder
    for (line <- linesWithSeparators) {
      val len = line.length
      var index = 0
      while (index < len && line.charAt(index) <= ' ') index += 1
      buf append
        (if (index < len && line.charAt(index) == marginChar) line.substring(index + 1) else line)
    }
    buf.toString
  }

  /** For every line in this string:
   *
   *  Strip a leading prefix consisting of blanks or control characters
   *  followed by `|` from the line.
   */
  def stripMargin: String = stripMargin('|')

  private def escape(ch: Char): String = if (
    (ch >= 'a') && (ch <= 'z') ||
    (ch >= 'A') && (ch <= 'Z') ||
    (ch >= '0' && ch <= '9')) ch.toString
    else "\\" + ch

  /** Split this string around the separator character
   *
   * If this string is the empty string, returns an array of strings
   * that contains a single empty string.
   *
   * If this string is not the empty string, returns an array containing
   * the substrings terminated by the start of the string, the end of the
   * string or the separator character, excluding empty trailing substrings
   *
   * If the separator character is a surrogate character, only split on
   * matching surrogate characters if they are not part of a surrogate pair
   *
   * The behaviour follows, and is implemented in terms of <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html#split%28java.lang.String%29">String.split(re: String)</a>
   *
   *
   * @example {{{
   * "a.b".split('.') //returns Array("a", "b")
   *
   * //splitting the empty string always returns the array with a single
   * //empty string
   * "".split('.') //returns Array("")
   *
   * //only trailing empty substrings are removed
   * "a.".split('.') //returns Array("a")
   * ".a.".split('.') //returns Array("", "a")
   * "..a..".split('.') //returns Array("", "", "a")
   *
   * //all parts are empty and trailing
   * ".".split('.') //returns Array()
   * "..".split('.') //returns Array()
   *
   * //surrogate pairs
   * val high = 0xD852.toChar
   * val low = 0xDF62.toChar
   * val highstring = high.toString
   * val lowstring = low.toString
   *
   * //well-formed surrogate pairs are not split
   * val highlow = highstring + lowstring
   * highlow.split(high) //returns Array(highlow)
   *
   * //bare surrogate characters are split
   * val bare = "_" + highstring + "_"
   * bare.split(high) //returns Array("_", "_")
   *
   *  }}}
   *
   * @param separator the character used as a delimiter
   */
  def split(separator: Char): Array[String] =
    toString.split(escape(separator))


  @throws(classOf[java.util.regex.PatternSyntaxException])
  def split(separators: Array[Char]): Array[String] = {
    val re = separators.foldLeft("[")(_+escape(_)) + "]"
    toString.split(re)
  }

  /** 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`.
   */
  def r: Regex = r()

  /** You can follow a string with `.r(g1, ... , gn)`, turning it into a `Regex`,
   *  with group names g1 through gn.
   *
   *  `"""(\d\d)-(\d\d)-(\d\d\d\d)""".r("month", "day", "year")` matches dates
   *  and provides its subcomponents through groups named "month", "day" and
   *  "year".
   *
   *  @param groupNames The names of the groups in the pattern, in the order they appear.
   */
  def r(groupNames: String*): Regex = new Regex(toString, groupNames: _*)

  /**
   * @throws java.lang.IllegalArgumentException - If the string does not contain a parsable boolean.
   */
  def toBoolean: Boolean = parseBoolean(toString)
  /**
   * @throws java.lang.NumberFormatException - If the string does not contain a parsable byte.
   */
  def toByte: Byte       = java.lang.Byte.parseByte(toString)
  /**
   * @throws java.lang.NumberFormatException - If the string does not contain a parsable short.
   */
  def toShort: Short     = java.lang.Short.parseShort(toString)
  /**
   * @throws java.lang.NumberFormatException  - If the string does not contain a parsable int.
   */
  def toInt: Int         = java.lang.Integer.parseInt(toString)
  /**
   * @throws java.lang.NumberFormatException  - If the string does not contain a parsable long.
   */
  def toLong: Long       = java.lang.Long.parseLong(toString)
  /**
   * @throws java.lang.NumberFormatException - If the string does not contain a parsable float.
   */
  def toFloat: Float     = java.lang.Float.parseFloat(toString)
  /**
   * @throws java.lang.NumberFormatException - If the string does not contain a parsable double.
   */
  def toDouble: Double   = java.lang.Double.parseDouble(toString)

  private def parseBoolean(s: String): Boolean =
    if (s != null) s.toLowerCase match {
      case "true" => true
      case "false" => false
      case _ => throw new IllegalArgumentException("For input string: \""+s+"\"")
    }
    else
      throw new IllegalArgumentException("For input string: \"null\"")

  override def toArray[B >: Char : ClassTag]: Array[B] =
    toString.toCharArray.asInstanceOf[Array[B]]

  private def unwrapArg(arg: Any): AnyRef = arg match {
    case x: ScalaNumber => x.underlying
    case x              => x.asInstanceOf[AnyRef]
  }

  /** 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
   *    <a href="" target="contentFrame" class="java/util/Formatter">
   *    `java.util.Formatter`</a>, with the addition that
   *    classes deriving from `ScalaNumber` (such as [[scala.BigInt]] and
   *    [[scala.BigDecimal]]) are unwrapped to pass a type which `Formatter`
   *    understands.
   *
   *  @param args the arguments used to instantiating the pattern.
   *  @throws java.lang.IllegalArgumentException
   */
  def format(args : Any*): String =
    java.lang.String.format(toString, args map unwrapArg: _*)

  /** 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
   *    <a href="" target="contentFrame" class="java/util/Formatter">
   *    `java.util.Formatter`</a>, with the addition that
   *    classes deriving from `ScalaNumber` (such as `scala.BigInt` and
   *    `scala.BigDecimal`) are unwrapped to pass a type which `Formatter`
   *    understands.
   *
   *  @param l    an instance of `java.util.Locale`
   *  @param args the arguments used to instantiating the pattern.
   *  @throws java.lang.IllegalArgumentException
   */
  def formatLocal(l: java.util.Locale, args: Any*): String =
    java.lang.String.format(l, toString, args map unwrapArg: _*)
}