Scala 3/scala.collection.mutable/StringBuilder

StringBuilder

@SerialVersionUID(3L)
final class StringBuilder(val underlying: StringBuilder) extends AbstractSeq[Char] with ReusableBuilder[Char, String] with IndexedSeq[Char] with IndexedSeqOps[Char, IndexedSeq, StringBuilder] with IterableFactoryDefaults[Char, IndexedSeq] with CharSequence with Serializable

A builder for mutable sequence of characters. This class provides an API mostly compatible with java.lang.StringBuilder, except where there are conflicts with the Scala collections API (such as the reverse method.)

This Builder can be reused after calling result() without an intermediate call to clear() in order to build multiple related results.

Companion:
object
Source:
StringBuilder.scala
trait Growable[Char]
trait Clearable
trait Seq[Char]
trait Cloneable
trait Iterable[Char]
trait Seq[Char]
trait Equals
trait Int => Char
trait Iterable[Char]
class Object
trait Matchable
class Any

Value members

Constructors

def this(capacity: Int)

Constructs a string builder with no characters in it and an initial capacity specified by the capacity argument.

Constructs a string builder with no characters in it and an initial capacity specified by the capacity argument.

Value parameters:
capacity

the initial capacity.

Throws:
java.lang.NegativeArraySizeException

if capacity < 0.

Source:
StringBuilder.scala
def this(str: String)

Constructs a string builder with initial characters equal to characters of str.

Constructs a string builder with initial characters equal to characters of str.

Source:
StringBuilder.scala
def this(initCapacity: Int, initValue: String)

Constructs a string builder initialized with string value initValue and with additional character capacity initCapacity.

Constructs a string builder initialized with string value initValue and with additional character capacity initCapacity.

Source:
StringBuilder.scala

Concrete methods

def ++=(s: String): StringBuilder

Alias for addAll

Alias for addAll

Source:
StringBuilder.scala
def addAll(s: String): StringBuilder

Overloaded version of addAll that takes a string

Overloaded version of addAll that takes a string

Source:
StringBuilder.scala
def append(x: Any): StringBuilder

Appends the string representation of the given argument, which is converted to a String with String.valueOf.

Appends the string representation of the given argument, which is converted to a String with String.valueOf.

Value parameters:
x

an Any object.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def append(s: String): StringBuilder

Appends the given String to this sequence.

Appends the given String to this sequence.

Value parameters:
s

a String.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def append(cs: CharSequence): StringBuilder

Appends the given CharSequence to this sequence.

Appends the given CharSequence to this sequence.

Value parameters:
cs

a CharSequence.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def append(s: StringBuilder): StringBuilder

Appends the specified string builder to this sequence.

Appends the specified string builder to this sequence.

Returns:
Source:
StringBuilder.scala
def append(x: Boolean): StringBuilder

Append the String representation of the given primitive type to this sequence.

Append the String representation of the given primitive type to this sequence. The argument is converted to a String with String.valueOf.

Value parameters:
x

a primitive value

Returns:

This StringBuilder.

Source:
StringBuilder.scala
def appendAll(xs: IterableOnce[Char]): StringBuilder

Appends all the Chars in the given IterableOnce[Char] to this sequence.

Appends all the Chars in the given IterableOnce[Char] to this sequence.

Value parameters:
xs

the characters to be appended.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def appendAll(xs: Array[Char]): StringBuilder

Appends all the Chars in the given Array[Char] to this sequence.

Appends all the Chars in the given Array[Char] to this sequence.

Value parameters:
xs

the characters to be appended.

Returns:

a reference to this object.

Source:
StringBuilder.scala
def appendAll(xs: Array[Char], offset: Int, len: Int): StringBuilder

Appends a portion of the given Array[Char] to this sequence.

Appends a portion of the given Array[Char] to this sequence.

Value parameters:
len

the numbers of Chars to append.

offset

the index of the first Char to append.

xs

the Array containing Chars to be appended.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def capacity: Int

Returns the current capacity, which is the size of the underlying array.

Returns the current capacity, which is the size of the underlying array. A new array will be allocated if the current capacity is exceeded.

Returns:

the capacity

Source:
StringBuilder.scala
def charAt(index: Int): Char

Returns the Char at the specified index, counting from 0 as in Arrays.

Returns the Char at the specified index, counting from 0 as in Arrays.

Value parameters:
index

the index to look up

Returns:

the Char at the given index.

Throws:
IndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def delete(start: Int, end: Int): StringBuilder

Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.

Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.

Value parameters:
end

The ending index, exclusive.

start

The beginning index, inclusive.

Returns:

This StringBuilder.

Throws:
StringIndexOutOfBoundsException

if start < 0 || start > end

Source:
StringBuilder.scala
def deleteCharAt(index: Int): StringBuilder

Removes the Char at the specified index.

Removes the Char at the specified index. The sequence is shortened by one.

Value parameters:
index

The index to remove.

Returns:

This StringBuilder.

Throws:
IndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def ensureCapacity(newCapacity: Int): Unit

Ensure that the capacity is at least the given argument.

Ensure that the capacity is at least the given argument. If the argument is greater than the current capacity, new storage will be allocated with size equal to the given argument or to (2 * capacity + 2), whichever is larger.

Value parameters:
newCapacity

the minimum desired capacity.

Source:
StringBuilder.scala
def indexOf(str: String): Int

Finds the index of the first occurrence of the specified substring.

Finds the index of the first occurrence of the specified substring.

Value parameters:
str

the target string to search for

Returns:

the first applicable index where target occurs, or -1 if not found.

Source:
StringBuilder.scala
def indexOf(str: String, fromIndex: Int): Int

Finds the index of the first occurrence of the specified substring.

Finds the index of the first occurrence of the specified substring.

Value parameters:
fromIndex

the smallest index in the source string to consider

str

the target string to search for

Returns:

the first applicable index where target occurs, or -1 if not found.

Source:
StringBuilder.scala
def insert(index: Int, x: Any): StringBuilder

Inserts the String representation (via String.valueOf) of the given argument into this sequence at the given index.

Inserts the String representation (via String.valueOf) of the given argument into this sequence at the given index.

Value parameters:
index

the index at which to insert.

x

a value.

Returns:

this StringBuilder.

Throws:
StringIndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def insert(index: Int, x: String): StringBuilder

Inserts the String into this character sequence.

Inserts the String into this character sequence.

Value parameters:
index

the index at which to insert.

x

a String.

Returns:

this StringBuilder.

Throws:
StringIndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def insert(index: Int, x: Boolean): StringBuilder

Calls String.valueOf on the given primitive value, and inserts the String at the given index.

Calls String.valueOf on the given primitive value, and inserts the String at the given index.

Value parameters:
index

the offset position.

x

a primitive value.

Returns:

this StringBuilder.

Source:
StringBuilder.scala
def insertAll(index: Int, str: Array[Char], offset: Int, len: Int): StringBuilder

Inserts a subarray of the given Array[Char] at the given index of this sequence.

Inserts a subarray of the given Array[Char] at the given index of this sequence.

Value parameters:
index

index at which to insert the subarray.

len

the number of Chars from 'str' to insert.

offset

the index of the first Char to insert.

str

the Array from which Chars will be taken.

Returns:

This StringBuilder.

Throws:
StringIndexOutOfBoundsException

if index < 0, index > length, offset < 0, len < 0, or (offset + len) > str.length.

Source:
StringBuilder.scala
def insertAll(index: Int, xs: IterableOnce[Char]): StringBuilder

Inserts the given Seq[Char] into this sequence at the given index.

Inserts the given Seq[Char] into this sequence at the given index.

Value parameters:
index

the index at which to insert.

xs

the Seq[Char].

Returns:

this StringBuilder.

Throws:
StringIndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def insertAll(index: Int, xs: Array[Char]): StringBuilder

Inserts the given Array[Char] into this sequence at the given index.

Inserts the given Array[Char] into this sequence at the given index.

Value parameters:
index

the index at which to insert.

xs

the Array[Char].

Returns:

this StringBuilder.

Throws:
StringIndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
override def isEmpty: Boolean

Tests whether this builder is empty.

Tests whether this builder is empty.

This method is required for JDK15+ compatibility

Returns:

true if this builder contains nothing, false otherwise.

Definition Classes
Source:
StringBuilder.scala
override def knownSize: Int
def lastIndexOf(str: String): Int

Finds the index of the last occurrence of the specified substring.

Finds the index of the last occurrence of the specified substring.

Value parameters:
str

the target string to search for

Returns:

the last applicable index where target occurs, or -1 if not found.

Source:
StringBuilder.scala
def lastIndexOf(str: String, fromIndex: Int): Int

Finds the index of the last occurrence of the specified substring.

Finds the index of the last occurrence of the specified substring.

Value parameters:
fromIndex

the smallest index in the source string to consider

str

the target string to search for

Returns:

the last applicable index where target occurs, or -1 if not found.

Source:
StringBuilder.scala
def replace(start: Int, end: Int, str: String): StringBuilder

Replaces a subsequence of Chars with the given String.

Replaces a subsequence of Chars with the given String. The semantics are as in delete, with the String argument then inserted at index 'start'.

Value parameters:
end

The ending index, exclusive.

start

The beginning index, inclusive.

str

The String to be inserted at the start index.

Returns:

This StringBuilder.

Throws:
StringIndexOutOfBoundsException

if start < 0, start > length, or start > end

Source:
StringBuilder.scala
def reverseInPlace(): StringBuilder

Like reverse, but destructively updates the target StringBuilder.

Like reverse, but destructively updates the target StringBuilder.

Returns:

the reversed StringBuilder (same as the target StringBuilder)

Source:
StringBuilder.scala
def setCharAt(index: Int, ch: Char): StringBuilder

Update the sequence at the given index to hold the specified Char.

Update the sequence at the given index to hold the specified Char.

Value parameters:
ch

the new Char.

index

the index to modify.

Throws:
IndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def setLength(len: Int): Unit

Sets the length of the character sequence.

Sets the length of the character sequence. If the current sequence is shorter than the given length, it is padded with nulls; if it is longer, it is truncated.

Value parameters:
len

the new length

Throws:
IndexOutOfBoundsException

if the argument is negative.

Source:
StringBuilder.scala
def subSequence(start: Int, end: Int): CharSequence

For implementing CharSequence.

For implementing CharSequence.

Source:
StringBuilder.scala
def substring(start: Int): String

Returns a new String made up of a subsequence of this sequence, beginning at the given index and extending to the end of the sequence.

Returns a new String made up of a subsequence of this sequence, beginning at the given index and extending to the end of the sequence.

target.substring(start) is equivalent to target.drop(start)

Value parameters:
start

The starting index, inclusive.

Returns:

The new String.

Throws:
IndexOutOfBoundsException

if the index is out of bounds.

Source:
StringBuilder.scala
def substring(start: Int, end: Int): String

Returns a new String made up of a subsequence of this sequence, beginning at the start index (inclusive) and extending to the end index (exclusive).

Returns a new String made up of a subsequence of this sequence, beginning at the start index (inclusive) and extending to the end index (exclusive).

target.substring(start, end) is equivalent to target.slice(start, end).mkString

Value parameters:
end

The ending index, exclusive.

start

The beginning index, inclusive.

Returns:

The new String.

Throws:
StringIndexOutOfBoundsException

If either index is out of bounds, or if start > end.

Source:
StringBuilder.scala
override def toArray[B >: Char](implicit ct: ClassTag[B]): Array[B]
Definition Classes
Source:
StringBuilder.scala
def toCharArray: Array[Char]

Returns the contents of this StringBuilder as an Array[Char].

Returns the contents of this StringBuilder as an Array[Char].

Returns:

An array with the characters from this builder.

Source:
StringBuilder.scala
override def toString: String
Definition Classes
Source:
StringBuilder.scala
def update(idx: Int, elem: Char): Unit

Deprecated methods

@deprecated("Use reverseInPlace instead", "2.13.0")
final def reverseContents(): StringBuilder

Like reverse, but destructively updates the target StringBuilder.

Like reverse, but destructively updates the target StringBuilder.

Returns:

the reversed StringBuilder (same as the target StringBuilder)

Deprecated
Source:
StringBuilder.scala

Inherited methods

final def ++[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]

Alias for concat

Alias for concat

Inherited from:
IterableOps
Source:
Iterable.scala
final override def ++:[B >: Char](prefix: IterableOnce[B]): IndexedSeq[B]

Alias for prependedAll

Alias for prependedAll

Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
final def ++=(xs: IterableOnce[Char]): StringBuilder

Alias for addAll

Alias for addAll

Inherited from:
Growable
Source:
Growable.scala
final def +:[B >: Char](elem: B): IndexedSeq[B]

Alias for prepended.

Alias for prepended.

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

Inherited from:
SeqOps
Source:
Seq.scala
final def +=(elem: Char): StringBuilder

Alias for addOne

Alias for addOne

Inherited from:
Growable
Source:
Growable.scala
final def :+[B >: Char](elem: B): IndexedSeq[B]

Alias for appended

Alias for appended

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

Inherited from:
SeqOps
Source:
Seq.scala
final def :++[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]

Alias for appendedAll

Alias for appendedAll

Inherited from:
SeqOps
Source:
Seq.scala
def addAll(xs: IterableOnce[Char]): StringBuilder

Adds all elements produced by an IterableOnce to this growable collection.

Adds all elements produced by an IterableOnce to this growable collection.

Value parameters:
xs

the IterableOnce producing the elements to add.

Returns:

the growable collection itself.

Inherited from:
Growable
Source:
Growable.scala
final def addString(b: StringBuilder): StringBuilder

Appends all elements of this collection to a string builder.

Appends all elements of this collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this collection 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
Value parameters:
b

the string builder to which elements are appended.

Returns:

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def addString(b: StringBuilder, sep: String): StringBuilder

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

Appends all elements of this collection 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 collection, 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
Value parameters:
b

the string builder to which elements are appended.

sep

the separator string.

Returns:

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

Appends all elements of this collection 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 collection 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)
Value parameters:
b

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.

Returns:

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def andThen[C](k: PartialFunction[Char, C]): PartialFunction[Int, C]

Composes this partial function with another partial function that gets applied to results of this partial function.

Composes this partial function with another partial function that gets applied to results of this partial function.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters:
C

the result type of the transformation function.

Value parameters:
k

the transformation function

Returns:

a partial function with the domain of this partial function narrowed by other partial function, which maps arguments x to k(this(x)).

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def andThen[C](k: Char => C): PartialFunction[Int, C]

Composes this partial function with a transformation function that gets applied to results of this partial function.

Composes this partial function with a transformation function that gets applied to results of this partial function.

If the runtime type of the function is a PartialFunction then the other andThen method is used (note its cautions).

Type parameters:
C

the result type of the transformation function.

Value parameters:
k

the transformation function

Returns:

a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments x to k(this(x)).

Definition Classes
Inherited from:
PartialFunction
Source:
PartialFunction.scala
def appended[B >: Char](elem: B): IndexedSeq[B]

A copy of this sequence with an element appended.

A copy of this sequence with an element appended.

Note: will not terminate for infinite-sized collections.

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)
Type parameters:
B

the element type of the returned sequence.

Value parameters:
elem

the appended element

Returns:

a new sequence consisting of all elements of this sequence followed by value.

Inherited from:
SeqOps
Source:
Seq.scala
def appendedAll[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]

Returns a new sequence containing the elements from the left hand operand followed by the elements from the right hand operand.

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

Type parameters:
B

the element type of the returned collection.

Value parameters:
suffix

the iterable to append.

Returns:

a new collection of type CC[B] which contains all elements of this sequence followed by all elements of suffix.

Inherited from:
SeqOps
Source:
Seq.scala
def applyOrElse[A1 <: Int, B1 >: Char](x: A1, default: A1 => B1): B1

Applies this partial function to the given argument when it is contained in the function domain.

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Note that expression pf.applyOrElse(x, default) is equivalent to

if(pf isDefinedAt x) pf(x) else default(x)

except that applyOrElse method can be implemented more efficiently. For all partial function literals the compiler generates an applyOrElse implementation which avoids double evaluation of pattern matchers and guards. This makes applyOrElse the basis for the efficient implementation for many operations and scenarios, such as:

- combining partial functions into orElse/andThen chains does not lead to excessive apply/isDefinedAt evaluation - lift and unlift do not evaluate source functions twice on each invocation - runWith allows efficient imperative-style combining of partial functions with conditionally applied actions

For non-literal partial function classes with nontrivial isDefinedAt method it is recommended to override applyOrElse with custom implementation that avoids double isDefinedAt evaluation. This may result in better performance and more predictable behavior w.r.t. side effects.

Value parameters:
default

the fallback function

x

the function argument

Returns:

the result of this function or fallback function application.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def canEqual(that: Any): Boolean
Inherited from:
Seq
Source:
Seq.scala
def chars(): IntStream
Inherited from:
CharSequence
override def clone(): StringBuilder
Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
def codePoints(): IntStream
Inherited from:
CharSequence
def collect[B](pf: PartialFunction[Char, B]): IndexedSeq[B]
Inherited from:
IterableOps
Source:
Iterable.scala
def collectFirst[B](pf: PartialFunction[Char, B]): Option[B]

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

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

Value parameters:
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.

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def combinations(n: Int): Iterator[StringBuilder]

Iterates over combinations.

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.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Returns:

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

Example:

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

Inherited from:
SeqOps
Source:
Seq.scala
def compose[R](k: PartialFunction[R, Int]): PartialFunction[R, Char]

Composes another partial function k with this partial function so that this partial function gets applied to results of k.

Composes another partial function k with this partial function so that this partial function gets applied to results of k.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters:
R

the parameter type of the transformation function.

Value parameters:
k

the transformation function

Returns:

a partial function with the domain of other partial function narrowed by this partial function, which maps arguments x to this(k(x)).

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def compose[A](g: A => Int): A => Char

Composes two instances of Function1 in a new Function1, with this function applied last.

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters:
A

the type to which function g can be applied

Value parameters:
g

a function A => T1

Returns:

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
Source:
Function1.scala
final override def concat[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]
Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
def contains[A1 >: Char](elem: A1): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
elem

the element to test.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def containsSlice[B >: Char](that: Seq[B]): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
that

the sequence to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def copyToArray[B >: Char](xs: Array[B], start: Int, len: Int): Int

Copy elements to an array, returning the number of elements written.

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with at most len elements of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached, or len elements have been copied.

Type parameters:
B

the type of the elements of the array.

Value parameters:
len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: Char](xs: Array[B], start: Int): Int

Copy elements to an array, returning the number of elements written.

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters:
B

the type of the elements of the array.

Value parameters:
start

the starting index of xs.

xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: Char](xs: Array[B]): Int

Copy elements to an array, returning the number of elements written.

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters:
B

the type of the elements of the array.

Value parameters:
xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def corresponds[B](that: IterableOnce[B])(p: (Char, B) => Boolean): Boolean

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the type of the elements of that

Value parameters:
p

the test predicate, which relates elements from both collections

that

the other collection

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def corresponds[B](that: Seq[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.

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

Type parameters:
B

the type of the elements of that

Value parameters:
p

the test predicate, which relates elements from both sequences

that

the other sequence

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def count(p: Char => Boolean): Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

the number of elements satisfying the predicate p.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def diff[B >: Char](that: Seq[B]): StringBuilder

Computes the multiset difference between this sequence and another sequence.

Computes the multiset difference between this sequence and another sequence.

Value parameters:
that

the sequence of elements to remove

Returns:

a new sequence which contains all elements of this sequence 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.

Inherited from:
SeqOps
Source:
Seq.scala
def distinct: StringBuilder

Selects all the elements of this sequence ignoring the duplicates.

Selects all the elements of this sequence ignoring the duplicates.

Returns:

a new sequence consisting of all the elements of this sequence without duplicates.

Inherited from:
SeqOps
Source:
Seq.scala
def distinctBy[B](f: Char => B): StringBuilder

Selects all the elements of this sequence ignoring the duplicates as determined by == after applying the transforming function f.

Selects all the elements of this sequence ignoring the duplicates as determined by == after applying the transforming function f.

Type parameters:
B

the type of the elements after being transformed by f

Value parameters:
f

The transforming function whose result is used to determine the uniqueness of each element

Returns:

a new sequence consisting of all the elements of this sequence without duplicates.

Inherited from:
SeqOps
Source:
Seq.scala
override def drop(n: Int): StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override def dropRight(n: Int): StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def elementWise: ElementWiseExtractor[Int, Char]

Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

Example:

val firstChar: String => Option[Char] = _.headOption
Seq("foo", "bar", "baz") match {
  case firstChar.unlift.elementWise(c0, c1, c2) =>
    println(s"$c0, $c1, $c2") // Output: f, b, b
}
Inherited from:
PartialFunction
Source:
PartialFunction.scala
def endsWith[B >: Char](that: Iterable[B]): Boolean

Tests whether this sequence ends with the given sequence.

Tests whether this sequence ends with the given sequence.

Note: will not terminate for infinite-sized collections.

Value parameters:
that

the sequence to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
override def equals(o: Any): Boolean
Definition Classes
Seq -> Equals -> Any
Inherited from:
Seq
Source:
Seq.scala
def exists(p: Char => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

true if the given predicate p is satisfied by at least one element of this collection, otherwise false

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def filter(pred: Char => Boolean): StringBuilder
Inherited from:
IterableOps
Source:
Iterable.scala
def filterNot(pred: Char => Boolean): StringBuilder
Inherited from:
IterableOps
Source:
Iterable.scala
def find(p: Char => Boolean): Option[Char]

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

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

Note: may not terminate for infinite-sized collections.

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

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def findLast(p: Char => Boolean): Option[Char]

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

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

Note: will not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def flatMap[B](f: Char => IterableOnce[B]): IndexedSeq[B]
Inherited from:
IterableOps
Source:
Iterable.scala
def flatten[B](implicit asIterable: Char => IterableOnce[B]): IndexedSeq[B]
Inherited from:
IterableOps
Source:
Iterable.scala
def fold[A1 >: Char](z: A1)(op: (A1, A1) => A1): A1

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

Folds the elements of this collection using the specified associative binary operator. The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

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

Note: will not terminate for infinite-sized collections.

Type parameters:
A1

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

Value parameters:
op

a binary operator that must be associative.

z

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

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def foldLeft[B](z: B)(op: (B, Char) => B): B

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

Applies a binary operator to a start value and all elements of this collection, 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.

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

z

the start value.

Returns:

the result of inserting op between consecutive elements of this collection, 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 collection. Returns z if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def foldRight[B](z: B)(op: (Char, B) => B): B
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def forall(p: Char => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def foreach[U](f: Char => U): Unit

Apply f to each element for its side effects Note: [U] parameter needed to help scalac's type inference.

Apply f to each element for its side effects Note: [U] parameter needed to help scalac's type inference.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def groupBy[K](f: Char => K): Map[K, StringBuilder]

Partitions this iterable collection into a map of iterable collections according to some discriminator function.

Partitions this iterable collection into a map of iterable collections according to some discriminator function.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters:
K

the type of keys returned by the discriminator function.

Value parameters:
f

the discriminator function.

Returns:

A map from keys to iterable 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 iterable collection of those elements x for which f(x) equals k.

Inherited from:
IterableOps
Source:
Iterable.scala
def groupMap[K, B](key: Char => K)(f: Char => B): Map[K, IndexedSeq[B]]

Partitions this iterable collection into a map of iterable collections according to a discriminator function key.

Partitions this iterable collection into a map of iterable collections according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters:
B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value parameters:
f

the element transformation function

key

the discriminator function

Inherited from:
IterableOps
Source:
Iterable.scala
def groupMapReduce[K, B](key: Char => K)(f: Char => B)(reduce: (B, B) => B): Map[K, B]

Partitions this iterable collection into a map according to a discriminator function key.

Partitions this iterable collection into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Inherited from:
IterableOps
Source:
Iterable.scala
def grouped(size: Int): Iterator[StringBuilder]

Partitions elements in fixed size iterable collections.

Partitions elements in fixed size iterable collections.

Value parameters:
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.

See also:
Inherited from:
IterableOps
Source:
Iterable.scala
override def hashCode(): Int
Definition Classes
Seq -> Any
Inherited from:
Seq
Source:
Seq.scala
override def head: Char
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override def headOption: Option[Char]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
@deprecatedOverriding("Override indexOf(elem, from) instead - indexOf(elem) calls indexOf(elem, 0)", "2.13.0")
def indexOf[B >: Char](elem: B): Int

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

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

Type parameters:
B

the type of the element elem.

Value parameters:
elem

the element value to search for.

Returns:

the index >= 0 of the first element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source:
Seq.scala
def indexOf[B >: Char](elem: B, from: Int): Int

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

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

Type parameters:
B

the type of the element elem.

Value parameters:
elem

the element value to search for.

from

the start index

Returns:

the index >= from of the first element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source:
Seq.scala
@deprecatedOverriding("Override indexOfSlice(that, from) instead - indexOfSlice(that) calls indexOfSlice(that, 0)", "2.13.0")
def indexOfSlice[B >: Char](that: Seq[B]): Int

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
that

the sequence to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def indexOfSlice[B >: Char](that: Seq[B], from: Int): Int

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

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.

Value parameters:
from

the start index

that

the sequence to test

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.

Inherited from:
SeqOps
Source:
Seq.scala
@deprecatedOverriding("Override indexWhere(p, from) instead - indexWhere(p) calls indexWhere(p, 0)", "2.13.0")
def indexWhere(p: Char => Boolean): Int

Finds index of the first element satisfying some predicate.

Finds index of the first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
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.

Note: may not terminate for infinite-sized collections.

Value parameters:
from

the start index

p

the predicate used to test elements.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def indices: Range

Produces the range of all indices of this sequence.

Produces the range of all indices of this sequence.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def init: StringBuilder

The initial part of the collection without its last element.

The initial part of the collection without its last element.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Inherited from:
IterableOps
Source:
Iterable.scala
def inits: Iterator[StringBuilder]

Iterates over the inits of this iterable collection.

Iterates over the inits of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of init.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Returns:

an iterator over all the inits of this iterable collection

Example:

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

Inherited from:
IterableOps
Source:
Iterable.scala
def intersect[B >: Char](that: Seq[B]): StringBuilder

Computes the multiset intersection between this sequence and another sequence.

Computes the multiset intersection between this sequence and another sequence.

Value parameters:
that

the sequence of elements to intersect with.

Returns:

a new sequence which contains all elements of this sequence 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.

Inherited from:
SeqOps
Source:
Seq.scala
def isDefinedAt(idx: Int): Boolean

Tests whether this sequence contains given index.

Tests whether this sequence contains given index.

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

Value parameters:
idx

the index to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
override def isTraversableAgain: Boolean
Definition Classes
Inherited from:
IterableOps
Source:
Iterable.scala
override def iterableFactory: SeqFactory[IndexedSeq]
Definition Classes
Inherited from:
IndexedSeq
Source:
IndexedSeq.scala
override def last: Char
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def lastIndexOf[B >: Char](elem: B, end: Int): Int

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the type of the element elem.

Value parameters:
elem

the element value to search for.

end

the end index.

Returns:

the index <= end of the last element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source:
Seq.scala
@deprecatedOverriding("Override lastIndexOfSlice(that, end) instead - lastIndexOfSlice(that) calls lastIndexOfSlice(that, Int.MaxValue)", "2.13.0")
def lastIndexOfSlice[B >: Char](that: Seq[B]): Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters:
that

the sequence to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def lastIndexOfSlice[B >: Char](that: Seq[B], end: Int): Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters:
end

the end index

that

the sequence to test

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.

Inherited from:
SeqOps
Source:
Seq.scala
@deprecatedOverriding("Override lastIndexWhere(p, end) instead - lastIndexWhere(p) calls lastIndexWhere(p, Int.MaxValue)", "2.13.0")
def lastIndexWhere(p: Char => Boolean): Int

Finds index of last element satisfying some predicate.

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
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.

Note: will not terminate for infinite-sized collections.

Value parameters:
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.

Inherited from:
SeqOps
Source:
Seq.scala
def lastOption: Option[Char]

Optionally selects the last element.

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 iterable collection$ if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source:
Iterable.scala
def lazyZip[B](that: Iterable[B]): LazyZip2[Char, B, StringBuilder]

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
Type parameters:
B

the type of the second element in each eventual pair

Value parameters:
that

the iterable providing the second element of each eventual pair

Returns:

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

Inherited from:
Iterable
Source:
Iterable.scala
final override def lengthCompare(that: Iterable[_]): Int
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
final override def lengthCompare(len: Int): Int
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
final def lengthIs: SizeCompareOps

Returns a value class containing operations for comparing the length of this sequence to a test value.

Returns a value class containing operations for comparing the length of this sequence to a test value.

These operations are implemented in terms of lengthCompare(Int), and allow the following more readable usages:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0
Inherited from:
SeqOps
Source:
Seq.scala
def lift: Int => Option[Char]

Turns this partial function into a plain function returning an Option result.

Turns this partial function into a plain function returning an Option result.

Returns:

a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

See also:

Function.unlift

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def map[B](f: Char => B): IndexedSeq[B]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def mapInPlace(f: Char => Char): StringBuilder

Modifies this mutable sequence by applying a function to all elements of this mutable sequence.

Modifies this mutable sequence by applying a function to all elements of this mutable sequence.

Value parameters:
f

the function to apply to each element.

Returns:

this mutable sequence modified by replacing all elements with the result of applying the given function f to each element of this mutable sequence.

Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def mapResult[NewTo](f: String => NewTo): Builder[Char, NewTo]

A builder resulting from this builder my mapping the result using f.

A builder resulting from this builder my mapping the result using f.

Inherited from:
Builder
Source:
Builder.scala
def max[B >: Char](implicit ord: Ordering[B]): Char

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

the largest element of this collection with respect to the ordering ord.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxBy[B](f: Char => B)(implicit cmp: Ordering[B]): Char

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

the first element of this collection with the largest value measured by function f with respect to the ordering cmp.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxByOption[B](f: Char => B)(implicit cmp: Ordering[B]): Option[Char]

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

an option value containing the first element of this collection with the largest value measured by function f with respect to the ordering cmp.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxOption[B >: Char](implicit ord: Ordering[B]): Option[Char]

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

an option value containing the largest element of this collection with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def min[B >: Char](implicit ord: Ordering[B]): Char

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

the smallest element of this collection with respect to the ordering ord.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minBy[B](f: Char => B)(implicit cmp: Ordering[B]): Char

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

the first element of this collection with the smallest value measured by function f with respect to the ordering cmp.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minByOption[B](f: Char => B)(implicit cmp: Ordering[B]): Option[Char]

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

an option value containing the first element of this collection with the smallest value measured by function f with respect to the ordering cmp.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minOption[B >: Char](implicit ord: Ordering[B]): Option[Char]

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

an option value containing the smallest element of this collection with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString: String

Displays all elements of this collection in a string.

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString(sep: String): String

Displays all elements of this collection in a string using a separator string.

Displays all elements of this collection in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters:
sep

the separator string.

Returns:

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

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString(start: String, sep: String, end: String): String

Displays all elements of this collection in a string using start, end, and separator strings.

Displays all elements of this collection in a string using start, end, and separator strings.

Delegates to addString, which can be overridden.

Value parameters:
end

the ending string.

sep

the separator string.

start

the starting string.

Returns:

a string representation of this collection. 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 collection are separated by the string sep.

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean

Tests whether the collection is not empty.

Tests whether the collection is not empty.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def orElse[A1 <: Int, B1 >: Char](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

Type parameters:
A1

the argument type of the fallback function

B1

the result type of the fallback function

Value parameters:
that

the fallback function

Returns:

a partial function which has as domain the union of the domains of this partial function and that. The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def padTo[B >: Char](len: Int, elem: B): IndexedSeq[B]

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

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

Type parameters:
B

the element type of the returned sequence.

Value parameters:
elem

the padding value

len

the target length

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
def partition(p: Char => Boolean): (StringBuilder, StringBuilder)

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

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not. Interesting because it splits a collection in two.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Inherited from:
IterableOps
Source:
Iterable.scala
def partitionMap[A1, A2](f: Char => Either[A1, A2]): (IndexedSeq[A1], IndexedSeq[A2])

Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Type parameters:
A1

the element type of the first resulting collection

A2

the element type of the second resulting collection

Value parameters:
f

the 'split function' mapping the elements of this iterable collection to an scala.util.Either

Returns:

a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Inherited from:
IterableOps
Source:
Iterable.scala
def patch[B >: Char](from: Int, other: IterableOnce[B], replaced: Int): IndexedSeq[B]

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

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

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original sequence appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.

Type parameters:
B

the element type of the returned sequence.

Value parameters:
from

the index of the first replaced element

other

the replacement sequence

replaced

the number of elements to drop in the original sequence

Returns:

a new sequence consisting of all elements of this sequence except that replaced elements starting from from are replaced by all the elements of other.

Inherited from:
SeqOps
Source:
Seq.scala
def permutations: Iterator[StringBuilder]

Iterates over distinct permutations.

Iterates over distinct permutations.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Returns:

An Iterator which traverses the distinct permutations of this sequence.

Example:

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

Inherited from:
SeqOps
Source:
Seq.scala
override def prepended[B >: Char](elem: B): IndexedSeq[B]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def prependedAll[B >: Char](prefix: IterableOnce[B]): IndexedSeq[B]

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.

Type parameters:
B

the element type of the returned collection.

Value parameters:
prefix

the iterable to prepend.

Returns:

a new sequence which contains all elements of prefix followed by all the elements of this sequence.

Inherited from:
SeqOps
Source:
Seq.scala
def product[B >: Char](implicit num: Numeric[B]): B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the result type of the * operator.

Value parameters:
num

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

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduce[B >: Char](op: (B, B) => B): B

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

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

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

Type parameters:
B

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

Value parameters:
op

A binary operator that must be associative.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceLeft[B >: Char](op: (B, Char) => B): B

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

Applies a binary operator to all elements of this collection, 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.

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

the result of inserting op between consecutive elements of this collection, going left to right: op( op( ... op(x1, x2) ..., xn-1), xn) where x1, ..., xn are the elements of this collection.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceLeftOption[B >: Char](op: (B, Char) => B): Option[B]

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

Optionally applies a binary operator to all elements of this collection, 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.

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceOption[B >: Char](op: (B, B) => B): Option[B]

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

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

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

Type parameters:
B

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

Value parameters:
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.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceRight[B >: Char](op: (Char, B) => B): B

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

Applies a binary operator to all elements of this collection, 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.

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

the result of inserting op between consecutive elements of this collection, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where x1, ..., xn are the elements of this collection.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceRightOption[B >: Char](op: (Char, B) => B): Option[B]

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

Optionally applies a binary operator to all elements of this collection, 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.

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def reverse: StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override def reverseIterator: Iterator[Char]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override protected def reversed: Iterable[Char]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def runWith[U](action: Char => U): Int => Boolean

Composes this partial function with an action function which gets applied to results of this partial function.

Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

Note that expression pf.runWith(action)(x) is equivalent to

if(pf isDefinedAt x) { action(pf(x)); true } else false

except that runWith is implemented via applyOrElse and thus potentially more efficient. Using runWith avoids double evaluation of pattern matchers and guards for partial function literals.

Value parameters:
action

the action function

Returns:

a function which maps arguments x to isDefinedAt(x). The resulting function runs action(this(x)) where this is defined.

See also:

applyOrElse.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def sameElements[B >: Char](that: IterableOnce[B]): Boolean

Are the elements of this collection the same (and in the same order) as those of that?

Are the elements of this collection the same (and in the same order) as those of that?

Inherited from:
SeqOps
Source:
Seq.scala
def scan[B >: Char](z: B)(op: (B, B) => B): IndexedSeq[B]

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.

Type parameters:
B

element type of the resulting collection

Value parameters:
op

the associative operator for the scan

z

neutral element for the operator op

Returns:

a new iterable collection containing the prefix scan of the elements in this iterable collection

Inherited from:
IterableOps
Source:
Iterable.scala
def scanLeft[B](z: B)(op: (B, Char) => B): IndexedSeq[B]
Inherited from:
IterableOps
Source:
Iterable.scala
def scanRight[B](z: B)(op: (Char, B) => B): IndexedSeq[B]

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

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.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Example:

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

the type of the elements in the resulting collection

Value parameters:
op

the binary operator applied to the intermediate result and the element

z

the initial value

Returns:

collection with intermediate results

Inherited from:
IterableOps
Source:
Iterable.scala
override def search[B >: Char](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override def search[B >: Char](elem: B)(implicit ord: Ordering[B]): SearchResult
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def segmentLength(p: Char => Boolean, from: Int): Int

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters:
from

the index where the search starts.

p

the predicate used to test elements.

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.

Inherited from:
SeqOps
Source:
Seq.scala
final def segmentLength(p: Char => Boolean): Int

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

the length of the longest segment of this sequence that starts from the first element such that every element of the segment satisfies the predicate p.

Inherited from:
SeqOps
Source:
Seq.scala
final override def size: Int
Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
final override def sizeCompare(that: Iterable[_]): Int
Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
final override def sizeCompare(otherSize: Int): Int
Definition Classes
Inherited from:
SeqOps
Source:
Seq.scala
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection has a known size Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value parameters:
coll

the collection which serves as a hint for the result's size.

delta

a correction to add to the coll.size to produce the size hint.

Inherited from:
Builder
Source:
Builder.scala
def sizeHint(size: Int): Unit

Gives a hint how many elements are expected to be added when the next result is called.

Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value parameters:
size

the hint how many elements will be added.

Inherited from:
Builder
Source:
Builder.scala
final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value parameters:
boundingColl

the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

size

the hint how many elements will be added.

Inherited from:
Builder
Source:
Builder.scala
final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

These operations are implemented in terms of sizeCompare(Int), and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Inherited from:
IterableOps
Source:
Iterable.scala
override def slice(from: Int, until: Int): StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def sliding(size: Int, step: Int): Iterator[StringBuilder]

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

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters:
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 element (which may be the only element) will be smaller if there are fewer than size elements remaining to be grouped.

See also:
Example:

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Inherited from:
IterableOps
Source:
Iterable.scala
def sliding(size: Int): Iterator[StringBuilder]

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

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters:
size

the number of elements per group

Returns:

An iterator producing iterable collections of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.

See also:
Example:

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Inherited from:
IterableOps
Source:
Iterable.scala
def sortBy[B](f: Char => B)(implicit ord: Ordering[B]): StringBuilder

Sorts this sequence according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

Sorts this sequence according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

Note: will not terminate for infinite-sized collections.

Note: Even when applied to a view or a lazy collection it will always force the elements.

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

Type parameters:
B

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

Value parameters:
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)).

See also:
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)
Inherited from:
SeqOps
Source:
Seq.scala
def sortInPlace[B >: Char]()(implicit ord: Ordering[B]): StringBuilder

Sorts this mutable sequence in place according to an Ordering.

Sorts this mutable sequence in place according to an Ordering.

Value parameters:
ord

the ordering to be used to compare elements.

Returns:

modified input mutable sequence sorted according to the ordering ord.

See also:
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def sortInPlaceBy[B](f: Char => B)(implicit ord: Ordering[B]): StringBuilder

Sorts this mutable sequence in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

Sorts this mutable sequence in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

See also:
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def sortInPlaceWith(lt: (Char, Char) => Boolean): StringBuilder

Sorts this mutable sequence in place according to a comparison function.

Sorts this mutable sequence in place according to a comparison function.

See also:
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def sortWith(lt: (Char, Char) => Boolean): StringBuilder

Sorts this sequence according to a comparison function.

Sorts this sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

Note: Even when applied to a view or a lazy collection it will always force the elements.

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

Value parameters:
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.

Example:

List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
List("Bob", "John", "Steve", "Tom")
Inherited from:
SeqOps
Source:
Seq.scala
def sorted[B >: Char](implicit ord: Ordering[B]): StringBuilder

Sorts this sequence according to an Ordering.

Sorts this sequence according to an Ordering.

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

Value parameters:
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.

See also:

scala.math.Ordering Note: Even when applied to a view or a lazy collection it will always force the elements.

Inherited from:
SeqOps
Source:
Seq.scala
override def splitAt(n: Int): (StringBuilder, StringBuilder)
Definition Classes
Inherited from:
IterableOps
Source:
Iterable.scala
def startsWith[B >: Char](that: IterableOnce[B], offset: Int): Boolean

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

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.

Value parameters:
offset

the index where the sequence is searched.

that

the sequence to test

Returns:

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

Inherited from:
SeqOps
Source:
Seq.scala
override def stepper[S <: Stepper[_]](implicit shape: StepperShape[Char, S]): S & EfficientSplit
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def sum[B >: Char](implicit num: Numeric[B]): B

Sums up the elements of this collection.

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the result type of the + operator.

Value parameters:
num

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

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def tail: StringBuilder

The rest of the collection without its first element.

The rest of the collection without its first element.

Inherited from:
IterableOps
Source:
Iterable.scala
def tails: Iterator[StringBuilder]

Iterates over the tails of this iterable collection.

Iterates over the tails of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of tail.

Returns:

an iterator over all the tails of this iterable collection

Example:

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

Inherited from:
IterableOps
Source:
Iterable.scala
override def take(n: Int): StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
override def takeRight(n: Int): StringBuilder
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def takeWhile(p: Char => Boolean): StringBuilder

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

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

Value parameters:
p

The predicate used to test elements.

Returns:

the longest prefix of this iterable collection whose elements all satisfy the predicate p.

Inherited from:
IterableOps
Source:
Iterable.scala
override def tapEach[U](f: Char => U): StringBuilder
Definition Classes
Inherited from:
IterableOps
Source:
Iterable.scala
def to[C1](factory: Factory[Char, C1]): C1

Given a collection factory factory, convert this collection to the appropriate representation for the current element type A.

Given a collection factory factory, convert this collection to the appropriate representation for the current element type A. Example uses:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def toBuffer[B >: Char]: Buffer[B]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toMap[K, V](implicit ev: Char <:< (K, V)): Map[K, V]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toSeq: Seq[Char]
Returns:

This collection as a Seq[A]. This is equivalent to to(Seq) but might be faster.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toSet[B >: Char]: Set[B]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def transpose[B](implicit asIterable: Char => Iterable[B]): IndexedSeq[IndexedSeq[B]]

Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.

Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.

The resulting collection's type will be guided by the static type of iterable collection. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters:
B

the type of the elements of each iterable collection.

Value parameters:
asIterable

an implicit conversion which asserts that the element type of this iterable collection is an Iterable.

Returns:

a two-dimensional iterable collection of iterable collections which has as nth row the nth column of this iterable collection.

Throws:
IllegalArgumentException

if all collections in this iterable collection are not of the same size.

Inherited from:
IterableOps
Source:
Iterable.scala
def unapply(a: Int): Option[Char]

Tries to extract a B from an A in a pattern matching expression.

Tries to extract a B from an A in a pattern matching expression.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def unzip[A1, A2](implicit asPair: Char => (A1, A2)): (IndexedSeq[A1], IndexedSeq[A2])

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Type parameters:
A1

the type of the first half of the element pairs

A2

the type of the second half of the element pairs

Value parameters:
asPair

an implicit conversion which asserts that the element type of this iterable collection is a pair.

Returns:

a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.

Inherited from:
IterableOps
Source:
Iterable.scala
def unzip3[A1, A2, A3](implicit asTriple: Char => (A1, A2, A3)): (IndexedSeq[A1], IndexedSeq[A2], IndexedSeq[A3])

Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.

Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
Type parameters:
A1

the type of the first member of the element triples

A2

the type of the second member of the element triples

A3

the type of the third member of the element triples

Value parameters:
asTriple

an implicit conversion which asserts that the element type of this iterable collection is a triple.

Returns:

a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.

Inherited from:
IterableOps
Source:
Iterable.scala
def updated[B >: Char](index: Int, elem: B): IndexedSeq[B]

A copy of this sequence with one single replaced element.

A copy of this sequence with one single replaced element.

Type parameters:
B

the element type of the returned sequence.

Value parameters:
elem

the replacing element

index

the position of the replacement

Returns:

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

Throws:
IndexOutOfBoundsException

if index does not satisfy 0 <= index < length. In case of a lazy collection this exception may be thrown at a later time or not at all (if the end of the collection is never evaluated).

Inherited from:
SeqOps
Source:
Seq.scala
override def view: IndexedSeqView[Char]
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala
def withFilter(p: Char => Boolean): WithFilter[Char, IndexedSeq]

Creates a non-strict filter of this iterable collection.

Creates a non-strict filter of this iterable 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.

Value parameters:
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 iterable collection which satisfy the predicate p.

Inherited from:
IterableOps
Source:
Iterable.scala
def zip[B](that: IterableOnce[B]): IndexedSeq[(Char, B)]

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

Returns a iterable collection formed from this iterable collection 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.

Type parameters:
B

the type of the second half of the returned pairs

Value parameters:
that

The iterable providing the second half of each result pair

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala
def zipAll[A1 >: Char, B](that: Iterable[B], thisElem: A1, thatElem: B): IndexedSeq[(A1, B)]

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

Returns a iterable collection formed from this iterable collection 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.

Value parameters:
that

the iterable providing the second half of each result pair

thatElem

the element to be used to fill up the result if that is shorter than this iterable collection.

thisElem

the element to be used to fill up the result if this iterable collection is shorter than that.

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala

Deprecated and Inherited methods

@deprecated("Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated", "2.13.0") @inline
final def +=(elem1: Char, elem2: Char, elems: Char*): StringBuilder

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

Value parameters:
elem1

the first element to add.

elem2

the second element to add.

elems

the remaining elements to add.

Returns:

the growable collection itself

Deprecated
Inherited from:
Growable
Source:
Growable.scala
@deprecated("Use foldLeft instead of /:", "2.13.0") @inline
final def /:[B](z: B)(op: (B, Char) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use foldRight instead of :\\", "2.13.0") @inline
final def :\[B](z: B)(op: (Char, B) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("`aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.", "2.13.0")
def aggregate[B](z: => B)(seqop: (B, Char) => B, combop: (B, B) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use iterableFactory instead", "2.13.0") @deprecatedOverriding("Use iterableFactory instead", "2.13.0") @inline
def companion: IterableFactory[IndexedSeq]
Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use `dest ++= coll` instead", "2.13.0") @inline
final def copyToBuffer[B >: Char](dest: Buffer[B]): Unit
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)", "2.13.0")
def hasDefiniteSize: Boolean

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

Tests whether this collection 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. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Returns:

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

See also:

method knownSize for a more useful alternative

Deprecated

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though hasDefiniteSize returns false.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use segmentLength instead of prefixLength", "2.13.0") @inline
final 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.

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Deprecated
Inherited from:
SeqOps
Source:
Seq.scala
@deprecated("Use coll instead of repr in a collection implementation, use the collection value itself from the outside", "2.13.0")
final def repr: StringBuilder
Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use .reverseIterator.map(f).to(...) instead of .reverseMap(f)", "2.13.0")
def reverseMap[B](f: Char => B): IndexedSeq[B]
Deprecated
Inherited from:
SeqOps
Source:
Seq.scala
@deprecated("Iterable.seq always returns the iterable itself", "2.13.0")
def seq: StringBuilder
Deprecated
Inherited from:
Iterable
Source:
Iterable.scala
@deprecated("toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections", "2.13.7")
final def toIterable: StringBuilder
Deprecated
Inherited from:
Iterable
Source:
Iterable.scala
@deprecated("Use .iterator instead of .toIterator", "2.13.0") @inline
final def toIterator: Iterator[Char]
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use .to(LazyList) instead of .toStream", "2.13.0") @inline
final def toStream: Stream[Char]
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections", "2.13.0")
final def toTraversable: Iterable[Char]

Converts this iterable collection to an unspecified Iterable.

Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Returns:

An Iterable containing all elements of this iterable collection.

Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use `mapInPlace` on an `IndexedSeq` instead", "2.13.0") @inline
final def transform(f: Char => Char): StringBuilder
Deprecated
Inherited from:
SeqOps
Source:
Seq.scala
@deprecated("Use `concat` instead", "2.13.0") @inline
final def union[B >: Char](that: Seq[B]): IndexedSeq[B]

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

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

Type parameters:
B

the element type of the returned sequence.

Value parameters:
that

the sequence to add.

Returns:

a new collection which contains all elements of this sequence followed by all elements of that.

Deprecated
Inherited from:
SeqOps
Source:
Seq.scala
@deprecated("Use .view.slice(from, until) instead of .view(from, until)", "2.13.0")
override def view(from: Int, until: Int): IndexedSeqView[Char]
Deprecated
Definition Classes
Inherited from:
IndexedSeqOps
Source:
IndexedSeq.scala

Concrete fields