StringBuilder

Companion object StringBuilder

final class 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 of String which is also a 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: reverse produces a new StringBuilder, and reverseInPlace mutates this builder.

Mutating operations return either this.type, i.e., the current builder, or Unit.

Other methods extract data or information from the builder without mutating it.

The distinction is also reflected in naming conventions used by collections, such as append, which mutates, and appended, which does not, or reverse, which does not mutate, and reverseInPlace, which does.

The String result may be obtained using either result() or toString.

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

Annotations: @SerialVersionUID()
Source: StringBuilder.scala
See also: "Scala's Collection Library overview" section on StringBuilders for more information.

Linear Supertypes

java.io.Serializable, CharSequence, IndexedSeq[Char], IndexedSeqOps[Char, IndexedSeq, StringBuilder], collection.IndexedSeq[Char], collection.IndexedSeqOps[Char, [_]IndexedSeq[_], StringBuilder], ReusableBuilder[Char, String], Builder[Char, String], Growable[Char], Clearable, AbstractSeq[Char], Seq[Char], SeqOps[Char, [_]IndexedSeq[_], StringBuilder], Cloneable[StringBuilder], java.lang.Cloneable, Iterable[Char], collection.AbstractSeq[Char], collection.Seq[Char], Equals, collection.SeqOps[Char, [_]IndexedSeq[_], StringBuilder], PartialFunction[Int, Char], (Int) => Char, collection.AbstractIterable[Char], collection.Iterable[Char], IterableFactoryDefaults[Char, [x]IndexedSeq[x]], IterableOps[Char, [_]IndexedSeq[_], StringBuilder], IterableOnceOps[Char, [_]IndexedSeq[_], StringBuilder], IterableOnce[Char], AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

StringBuilder
Serializable
CharSequence
IndexedSeq
IndexedSeqOps
IndexedSeq
IndexedSeqOps
ReusableBuilder
Builder
Growable
Clearable
AbstractSeq
Seq
SeqOps
Cloneable
Cloneable
Iterable
AbstractSeq
Seq
Equals
SeqOps
PartialFunction
Function1
AbstractIterable
Iterable
IterableFactoryDefaults
IterableOps
IterableOnceOps
IterableOnce
AnyRef
Any

Implicitly

by iterableOnceExtensionMethods
by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new StringBuilder(initCapacity: Int, initValue: String)
Constructs a string builder initialized with string value initValue and with additional character capacity initCapacity.
new StringBuilder(str: String)
Constructs a string builder with initial characters equal to characters of str.
new StringBuilder(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.
capacity
the initial capacity.
Exceptions thrown
java.lang.NegativeArraySizeException if capacity < 0.
new StringBuilder()
new StringBuilder(underlying: java.lang.StringBuilder)

Value Members

final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.
Definition Classes
AnyRef → Any
final def ##: Int
Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.
returns
a hash value consistent with ==
Definition Classes
AnyRef → Any
def +(other: String): String
Implicit
This member is added by an implicit conversion from StringBuilder toany2stringadd[StringBuilder] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
final def ++[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]
Alias for concat
Alias for concat
Definition Classes
IterableOps
Annotations
@inline()
final def ++:[B >: Char](prefix: IterableOnce[B]): IndexedSeq[B]
Alias for prependedAll
Alias for prependedAll
Definition Classes
SeqOps → IterableOps
Annotations
@inline()
def ++=(s: String): StringBuilder.this.type
Alias for addAll
final def ++=(xs: IterableOnce[Char]): StringBuilder.this.type
Alias for addAll
Alias for addAll
Definition Classes
Growable
Annotations
@inline()
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.
Definition Classes
SeqOps
Annotations
@inline()
final def +=(elem: Char): StringBuilder.this.type
Alias for addOne
Alias for addOne
Definition Classes
Growable
Annotations
@inline()
def ->[B](y: B): (StringBuilder, B)
Implicit
This member is added by an implicit conversion from StringBuilder toArrowAssoc[StringBuilder] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
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.
Definition Classes
SeqOps
Annotations
@inline()
final def :++[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]
Alias for appendedAll
Alias for appendedAll
Definition Classes
SeqOps
Annotations
@inline()
final def ==(arg0: Any): Boolean
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
returns
true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes
AnyRef → Any
def addAll(s: String): StringBuilder.this.type
Overloaded version of addAll that takes a string
def addAll(xs: IterableOnce[Char]): StringBuilder.this.type
Adds all elements produced by an IterableOnce to this string builder.
Adds all elements produced by an IterableOnce to this string builder.
xs
the IterableOnce producing the elements to add.
returns
the string builder itself.
Definition Classes
Growable
def addOne(x: Char): StringBuilder.this.type
Adds a single element to this string builder.
Adds a single element to this string builder.
returns
the string builder itself
Definition Classes
StringBuilder → Growable
final def addString(b: StringBuilder): b.type
Appends all elements of this string builder to a string builder.
Appends all elements of this string builder to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this string builder without any separator string.
Example:
```
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

scala> val h = a.addString(b)
h: StringBuilder = 1234
```
b
the string builder to which elements are appended.
returns
the string builder b to which elements were appended.
Definition Classes
IterableOnceOps
Annotations
@inline()
final def addString(b: StringBuilder, sep: String): b.type
Appends all elements of this string builder to a string builder using a separator string.
Appends all elements of this string builder to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this string builder, separated by the string sep.
Example:
```
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
```
b
the string builder to which elements are appended.
sep
the separator string.
returns
the string builder b to which elements were appended.
Definition Classes
IterableOnceOps
Annotations
@inline()
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type
Appends all elements of this string builder to a string builder using start, end, and separator strings.
Appends all elements of this string builder to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this string builder are separated by the string sep.
Example:
```
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

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

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
```
b
the string builder to which elements are appended.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
the string builder b to which elements were appended.
Definition Classes
IterableOnceOps
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.
C
the result type of the transformation function.
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)).
Definition Classes
PartialFunction
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).
C
the result type of the transformation function.
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
PartialFunction → Function1
def append(x: Char): StringBuilder.this.type
def append(x: Double): StringBuilder.this.type
def append(x: Float): StringBuilder.this.type
def append(x: Long): StringBuilder.this.type
def append(x: Int): StringBuilder.this.type
def append(x: Short): StringBuilder.this.type
def append(x: Byte): StringBuilder.this.type
def append(x: Boolean): StringBuilder.this.type
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.
x
a primitive value
returns
This StringBuilder.
def append(s: StringBuilder): StringBuilder.this.type
Appends the specified string builder to this sequence.
def append(cs: CharSequence): StringBuilder.this.type
Appends the given CharSequence to this sequence.
Appends the given CharSequence to this sequence.
cs
a CharSequence.
returns
this StringBuilder.
def append(s: String): StringBuilder.this.type
Appends the given String to this sequence.
Appends the given String to this sequence.
s
a String.
returns
this StringBuilder.
def append(x: Any): StringBuilder.this.type
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.
x
an Any object.
returns
this StringBuilder.
def appendAll(xs: Array[Char], offset: Int, len: Int): StringBuilder.this.type
Appends a portion of the given Array[Char] to this sequence.
Appends a portion of the given Array[Char] to this sequence.
xs
the Array containing Chars to be appended.
offset
the index of the first Char to append.
len
the numbers of Chars to append.
returns
this StringBuilder.
def appendAll(xs: Array[Char]): StringBuilder.this.type
Appends all the Chars in the given Array[Char] to this sequence.
Appends all the Chars in the given Array[Char] to this sequence.
xs
the characters to be appended.
returns
a reference to this object.
def appendAll(xs: IterableOnce[Char]): StringBuilder.this.type
Appends all the Chars in the given IterableOnce[Char] to this sequence.
Appends all the Chars in the given IterableOnce[Char] to this sequence.
xs
the characters to be appended.
returns
this StringBuilder.
def appendAll(xs: String): StringBuilder.this.type
def appended[B >: Char](elem: B): IndexedSeq[B]
A copy of this string builder with an element appended.
A copy of this string builder 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)
```
B
the element type of the returned string builder.
elem
the appended element
returns
a new string builder consisting of all elements of this string builder followed by value.
Definition Classes
SeqOps
def appendedAll[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]
Returns a new string builder containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new string builder containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the string builder is the most specific superclass encompassing the element types of the two operands.
B
the element type of the returned collection.
suffix
the iterable to append.
returns
a new collection of type CC[B] which contains all elements of this string builder followed by all elements of suffix.
Definition Classes
SeqOps
def apply(i: Int): Char
Get the element at the specified index.
Get the element at the specified index. This operation is provided for convenience in Seq. It should not be assumed to be efficient unless you have an IndexedSeq.
Definition Classes
StringBuilder → SeqOps → Function1
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.
x
the function argument
default
the fallback function
returns
the result of this function or fallback function application.
Definition Classes
PartialFunction
final def asInstanceOf[T0]: T0
Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.
Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver object is not an instance of the erasure of type T0.
def canEqual(that: Any): Boolean
A method that should be called from every well-designed equals method that is open to be overridden in a subclass.
A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.
that
the value being probed for possible equality
returns
true if this instance can possibly equal that, otherwise false
Definition Classes
Seq → Equals
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
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.
index
the index to look up
returns
the Char at the given index.
Definition Classes
StringBuilder → CharSequence
Exceptions thrown
IndexOutOfBoundsException if the index is out of bounds.
def chars(): IntStream
Definition Classes
CharSequence
def className: String
Defines the prefix of this object's toString representation.
Defines the prefix of this object's toString representation.
It is recommended to return the name of the concrete collection type, but not implementation subclasses. For example, for ListMap this method should return "ListMap", not "Map" (the supertype) or "Node" (an implementation subclass).
The default implementation returns "Iterable". It is overridden for the basic collection kinds "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" and "View".
returns
a string representation which starts the result of toString applied to this string builder. By default the string prefix is the simple name of the collection class string builder.
Attributes
protected[this]
Definition Classes
Iterable
def clear(): Unit
Clears the contents of this builder.
Clears the contents of this builder. After execution of this method, the builder will contain no elements.
If executed immediately after a call to result(), this allows a new instance of the same type of collection to be built.
Definition Classes
StringBuilder → ReusableBuilder → Builder → Clearable
def clone(): StringBuilder
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
Definition Classes
SeqOps → Cloneable → AnyRef
Note
not specified by SLS as a member of AnyRef
def codePoints(): IntStream
Definition Classes
CharSequence
final def coll: StringBuilder.this.type
returns
This collection as a C.
Attributes
protected
Definition Classes
Iterable → IterableOps
def collect[B](pf: PartialFunction[Char, B]): IndexedSeq[B]
Builds a new string builder by applying a partial function to all elements of this string builder on which the function is defined.
Builds a new string builder by applying a partial function to all elements of this string builder on which the function is defined.
B
the element type of the returned string builder.
pf
the partial function which filters and maps the string builder.
returns
a new string builder resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.
Definition Classes
IterableOps → IterableOnceOps
def collectFirst[B](pf: PartialFunction[Char, B]): Option[B]
Finds the first element of the string builder for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the string builder for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
pf
the partial function
returns
an option value containing pf applied to the first value for which it is defined, or None if none exists.
Definition Classes
IterableOnceOps
Example:
1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
def combinations(n: Int): Iterator[StringBuilder]
Iterates over combinations of elements.
Iterates over combinations of elements.
A combination of length n is a sequence of n elements selected in order of their first index in this sequence.
For example, "xyx" has two combinations of length 2. The x is selected first: "xx", "xy". The sequence "yx" is not returned as a combination because it is subsumed by "xy".
If there is more than one way to generate the same combination, only one will be returned.
For example, the result "xy" arbitrarily selected one of the x elements.
As a further illustration, "xyxx" has three different ways to generate "xy" because there are three elements x to choose from. Moreover, there are three unordered pairs "xx" but only one is returned.
It is not specified which of these equal combinations is returned. It is an implementation detail that should not be relied on. For example, the combination "xx" does not necessarily contain the first x in this sequence. This behavior is observable if the elements compare equal but are not identical.
As a consequence, "xyx".combinations(3).next() is "xxy": the combination does not reflect the order of the original sequence, but the order in which elements were selected, by "first index"; the order of each x element is also arbitrary.
Note: Even when applied to a view or a lazy collection it will always force the elements.
returns
An Iterator which traverses the n-element combinations of this string builder.
Definition Classes
SeqOps
Example:
1. Seq('a', 'b', 'b', 'b', 'c').combinations(2).foreach(println) // List(a, b) // List(a, c) // List(b, b) // List(b, c) Seq('b', 'a', 'b').combinations(2).foreach(println) // List(b, b) // List(b, a)
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.
R
the parameter type of the transformation function.
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)).
Definition Classes
PartialFunction
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.
A
the type to which function g can be applied
g
a function A => T1
returns
a new function f such that f(x) == apply(g(x))
Definition Classes
Function1
Annotations
@unspecialized()
final def concat[B >: Char](suffix: IterableOnce[B]): IndexedSeq[B]
Returns a new string builder containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new string builder containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the string builder is the most specific superclass encompassing the element types of the two operands.
B
the element type of the returned collection.
suffix
the iterable to append.
returns
a new string builder which contains all elements of this string builder followed by all elements of suffix.
Definition Classes
SeqOps → IterableOps
Annotations
@inline()
def contains[A1 >: Char](elem: A1): Boolean
Tests whether this string builder contains a given value as an element.
Tests whether this string builder contains a given value as an element.
Note: may not terminate for infinite-sized collections.
elem
the element to test.
returns
true if this string builder has an element that is equal (as determined by ==) to elem, false otherwise.
Definition Classes
SeqOps
def containsSlice[B >: Char](that: collection.Seq[B]): Boolean
Tests whether this string builder contains a given sequence as a slice.
Tests whether this string builder contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
that
the sequence to test
returns
true if this string builder contains a slice with the same elements as that, otherwise false.
Definition Classes
SeqOps
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 string builder.
Copying will stop once either all the elements of this string builder have been copied, or the end of the array is reached, or len elements have been copied.
B
the type of the elements of the array.
xs
the array to fill.
start
the starting index of xs.
len
the maximal number of elements to copy.
returns
the number of elements written to the array
Definition Classes
IterableOnceOps
Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
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 string builder.
Copying will stop once either all the elements of this string builder have been copied, or the end of the array is reached.
B
the type of the elements of the array.
xs
the array to fill.
start
the starting index of xs.
returns
the number of elements written to the array
Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding()
Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
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 string builder.
Copying will stop once either all the elements of this string builder have been copied, or the end of the array is reached.
B
the type of the elements of the array.
xs
the array to fill.
returns
the number of elements written to the array
Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding()
Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def corresponds[B](that: collection.Seq[B])(p: (Char, B) => Boolean): Boolean
Tests whether every element of this string builder relates to the corresponding element of another sequence by satisfying a test predicate.
Tests whether every element of this string builder relates to the corresponding element of another sequence by satisfying a test predicate.
B
the type of the elements of that
that
the other sequence
p
the test predicate, which relates elements from both sequences
returns
true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this string builder and y of that, otherwise false.
Definition Classes
SeqOps
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.
B
the type of the elements of that
that
the other collection
p
the test predicate, which relates elements from both collections
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
Definition Classes
IterableOnceOps
def count(p: (Char) => Boolean): Int
Counts the number of elements in the string builder which satisfy a predicate.
Counts the number of elements in the string builder which satisfy a predicate.
Note: will not terminate for infinite-sized collections.
p
the predicate used to test elements.
returns
the number of elements satisfying the predicate p.
Definition Classes
IterableOnceOps
def delete(start: Int, end: Int): StringBuilder.this.type
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.
start
The beginning index, inclusive.
end
The ending index, exclusive.
returns
This StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if start < 0 || start > end
def deleteCharAt(index: Int): StringBuilder.this.type
Removes the Char at the specified index.
Removes the Char at the specified index. The sequence is shortened by one.
index
The index to remove.
returns
This StringBuilder.
Exceptions thrown
IndexOutOfBoundsException if the index is out of bounds.
def diff[B >: Char](that: collection.Seq[B]): StringBuilder
Computes the multiset difference between this string builder and another sequence.
Computes the multiset difference between this string builder and another sequence.
that
the sequence of elements to remove
returns
a new string builder which contains all elements of this string builder except some of occurrences of elements that also appear in that. If an element value x appears n times in that, then the first n occurrences of x will not form part of the result, but any following occurrences will.
Definition Classes
SeqOps
def distinct: StringBuilder
Selects all the elements of this string builder ignoring the duplicates.
Selects all the elements of this string builder ignoring the duplicates.
returns
a new string builder consisting of all the elements of this string builder without duplicates.
Definition Classes
SeqOps
def distinctBy[B](f: (Char) => B): StringBuilder
Selects all the elements of this string builder ignoring the duplicates as determined by == after applying the transforming function f.
Selects all the elements of this string builder ignoring the duplicates as determined by == after applying the transforming function f.
B
the type of the elements after being transformed by f
f
The transforming function whose result is used to determine the uniqueness of each element
returns
a new string builder consisting of all the elements of this string builder without duplicates.
Definition Classes
SeqOps
def drop(n: Int): StringBuilder
Selects all elements except first n ones.
Selects all elements except first n ones.
n
the number of elements to drop from this string builder.
returns
a string builder consisting of all elements of this string builder except the first n ones, or else the empty string builder, if this string builder has less than n elements. If n is negative, don't drop any elements.
Definition Classes
IndexedSeqOps → IterableOps → IterableOnceOps
def dropRight(n: Int): StringBuilder
Selects all elements except last n ones.
Selects all elements except last n ones.
n
the number of elements to drop from this string builder.
returns
a string builder consisting of all elements of this string builder except the last n ones, or else the empty string builder, if this string builder has less than n elements. If n is negative, don't drop any elements.
Definition Classes
IndexedSeqOps → IterableOps
def dropWhile(p: (Char) => Boolean): StringBuilder
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
p
The predicate used to test elements.
returns
the longest suffix of this string builder whose first element does not satisfy the predicate p.
Definition Classes
IterableOps → IterableOnceOps
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.
Definition Classes
PartialFunction
Example:
1. 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 }
def empty: StringBuilder
The empty iterable of the same type as this iterable
The empty iterable of the same type as this iterable
returns
an empty iterable of type C.
Definition Classes
StringBuilder → IterableFactoryDefaults → IterableOps
def endsWith[B >: Char](that: collection.Iterable[B]): Boolean
Tests whether this string builder ends with the given sequence.
Tests whether this string builder ends with the given sequence.
Note: will not terminate for infinite-sized collections.
that
the sequence to test
returns
true if this string builder has that as a suffix, false otherwise.
Definition Classes
SeqOps
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.
newCapacity
the minimum desired capacity.
def ensuring(cond: (StringBuilder) => Boolean, msg: => Any): StringBuilder
Implicit
This member is added by an implicit conversion from StringBuilder toEnsuring[StringBuilder] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (StringBuilder) => Boolean): StringBuilder
Implicit
This member is added by an implicit conversion from StringBuilder toEnsuring[StringBuilder] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): StringBuilder
Implicit
This member is added by an implicit conversion from StringBuilder toEnsuring[StringBuilder] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): StringBuilder
Implicit
This member is added by an implicit conversion from StringBuilder toEnsuring[StringBuilder] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that) is a reference to the receiver object (this).
Tests whether the argument (that) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.
Definition Classes
AnyRef
def equals(o: Any): Boolean
The universal equality method defined in AnyRef.
The universal equality method defined in AnyRef.
Definition Classes
Seq → Equals → AnyRef → Any
def exists(p: (Char) => Boolean): Boolean
Tests whether a predicate holds for at least one element of this string builder.
Tests whether a predicate holds for at least one element of this string builder.
Note: may not terminate for infinite-sized collections.
p
the predicate used to test elements.
returns
true if the given predicate p is satisfied by at least one element of this string builder, otherwise false
Definition Classes
IterableOnceOps
def filter(pred: (Char) => Boolean): StringBuilder
Selects all elements of this string builder which satisfy a predicate.
Selects all elements of this string builder which satisfy a predicate.
returns
a new string builder consisting of all elements of this string builder that satisfy the given predicate p. The order of the elements is preserved.
Definition Classes
IterableOps → IterableOnceOps
def filterNot(pred: (Char) => Boolean): StringBuilder
Selects all elements of this string builder which do not satisfy a predicate.
Selects all elements of this string builder which do not satisfy a predicate.
pred
the predicate used to test elements.
returns
a new string builder consisting of all elements of this string builder that do not satisfy the given predicate pred. Their order may not be preserved.
Definition Classes
IterableOps → IterableOnceOps
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note
not specified by SLS as a member of AnyRef
def find(p: (Char) => Boolean): Option[Char]
Finds the first element of the string builder satisfying a predicate, if any.
Finds the first element of the string builder satisfying a predicate, if any.
Note: may not terminate for infinite-sized collections.
p
the predicate used to test elements.
returns
an option value containing the first element in the string builder that satisfies p, or None if none exists.
Definition Classes
IterableOnceOps
def findLast(p: (Char) => Boolean): Option[Char]
Finds the last element of the string builder satisfying a predicate, if any.
Finds the last element of the string builder satisfying a predicate, if any.
Note: will not terminate for infinite-sized collections.
p
the predicate used to test elements.
returns
an option value containing the last element in the string builder that satisfies p, or None if none exists.
Definition Classes
SeqOps
def flatMap[B](f: (Char) => IterableOnce[B]): IndexedSeq[B]
Builds a new string builder by applying a function to all elements of this string builder and using the elements of the resulting collections.
Builds a new string builder by applying a function to all elements of this string builder and using the elements of the resulting collections.
For example:
```
def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")
```
The type of the resulting collection is guided by the static type of string builder. This might cause unexpected results sometimes. For example:
```
// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

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

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

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
```
B
the element type of the returned collection.
f
the function to apply to each element.
returns
a new string builder resulting from applying the given collection-valued function f to each element of this string builder and concatenating the results.
Definition Classes
IterableOps → IterableOnceOps
def flatten[B](implicit asIterable: (Char) => IterableOnce[B]): IndexedSeq[B]
Converts this string builder of iterable collections into a string builder formed by the elements of these iterable collections.
Converts this string builder of iterable collections into a string builder formed by the elements of these iterable collections.
The resulting collection's type will be guided by the type of string builder. For example:
```
val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)
```
B
the type of the elements of each iterable collection.
asIterable
an implicit conversion which asserts that the element type of this string builder is an Iterable.
returns
a new string builder resulting from concatenating all element string builders.
Definition Classes
IterableOps → IterableOnceOps
def fold[A1 >: Char](z: A1)(op: (A1, A1) => A1): A1
Folds the elements of this string builder using the specified associative binary operator.
Folds the elements of this string builder 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.
A1
a type parameter for the binary operator, a supertype of A.
z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication).
op
a binary operator that must be associative.
returns
the result of applying the fold operator op between all the elements and z, or z if this string builder is empty.
Definition Classes
IterableOnceOps
def foldLeft[B](z: B)(op: (B, Char) => B): B
Applies a binary operator to a start value and all elements of this string builder, going left to right.
Applies a binary operator to a start value and all elements of this string builder, going left to right.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this string builder, going left to right with the start value z on the left: op(...op(z, x₁), x₂, ..., x_n) where x₁, ..., x_n are the elements of this string builder. Returns z if this string builder is empty.
Definition Classes
IterableOnceOps
def foldRight[B](z: B)(op: (Char, B) => B): B
Applies a binary operator to all elements of this string builder and a start value, going right to left.
Applies a binary operator to all elements of this string builder and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this string builder, going right to left with the start value z on the right: op(x₁, op(x₂, ... op(x_n, z)...)) where x₁, ..., x_n are the elements of this string builder. Returns z if this string builder is empty.
Definition Classes
IndexedSeqOps → IterableOnceOps
def forall(p: (Char) => Boolean): Boolean
Tests whether a predicate holds for all elements of this string builder.
Tests whether a predicate holds for all elements of this string builder.
Note: may not terminate for infinite-sized collections.
p
the predicate used to test elements.
returns
true if this string builder is empty or the given predicate p holds for all elements of this string builder, otherwise false.
Definition Classes
IterableOnceOps
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.
Definition Classes
IterableOnceOps
def fromSpecific(coll: IterableOnce[Char]): StringBuilder
Defines how to turn a given Iterable[A] into a collection of type C.
Defines how to turn a given Iterable[A] into a collection of type C.
This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.
Attributes
protected
Definition Classes
StringBuilder → IterableFactoryDefaults → IterableOps
Note
When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.
,
As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as it is called with an Iterable[A] obtained from this collection (as it is the case in the implementations of operations where we use a View[A]), it is safe.
final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
returns
a class object corresponding to the runtime type of the receiver.
Definition Classes
AnyRef → Any
Annotations
@native()
def groupBy[K](f: (Char) => K): immutable.Map[K, StringBuilder]
Partitions this string builder into a map of string builders according to some discriminator function.
Partitions this string builder into a map of string builders according to some discriminator function.
Note: Even when applied to a view or a lazy collection it will always force the elements.
K
the type of keys returned by the discriminator function.
f
the discriminator function.
returns
A map from keys to string builders such that the following invariant holds:
```
(xs groupBy f)(k) = xs filter (x => f(x) == k)
```
That is, every key k is bound to a string builder of those elements x for which f(x) equals k.
Definition Classes
IterableOps
def groupMap[K, B](key: (Char) => K)(f: (Char) => B): immutable.Map[K, IndexedSeq[B]]
Partitions this string builder into a map of string builders according to a discriminator function key.
Partitions this string builder into a map of string builders 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.
K
the type of keys returned by the discriminator function
B
the type of values returned by the transformation function
key
the discriminator function
f
the element transformation function
Definition Classes
IterableOps
def groupMapReduce[K, B](key: (Char) => K)(f: (Char) => B)(reduce: (B, B) => B): immutable.Map[K, B]
Partitions this string builder into a map according to a discriminator function key.
Partitions this string builder 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.
Definition Classes
IterableOps
def grouped(size: Int): Iterator[StringBuilder]
Partitions elements in fixed size string builders.
Partitions elements in fixed size string builders.
size
the number of elements per group
returns
An iterator producing string builders of size size, except the last will be less than size size if the elements don't divide evenly.
Definition Classes
IterableOps
See also
scala.collection.Iterator, method grouped
def hashCode(): Int
The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.
Definition Classes
Seq → AnyRef → Any
def head: Char
Selects the first element of this string builder.
Selects the first element of this string builder.
returns
the first element of this string builder.
Definition Classes
IndexedSeqOps → IterableOps
Exceptions thrown
NoSuchElementException if the string builder is empty.
def headOption: Option[Char]
Optionally selects the first element.
Optionally selects the first element.
returns
the first element of this string builder if it is nonempty, None if it is empty.
Definition Classes
IndexedSeqOps → IterableOps
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.
str
the target string to search for
fromIndex
the smallest index in the source string to consider
returns
the first applicable index where target occurs, or -1 if not found.
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.
str
the target string to search for
returns
the first applicable index where target occurs, or -1 if not found.
def indexOf[B >: Char](elem: B): Int
Finds index of first occurrence of some value in this string builder.
Finds index of first occurrence of some value in this string builder.
B
the type of the element elem.
elem
the element value to search for.
returns
the index >= 0 of the first element of this string builder that is equal (as determined by ==) to elem, or -1, if none exists.
Definition Classes
SeqOps
Annotations
@deprecatedOverriding()
def indexOf[B >: Char](elem: B, from: Int): Int
Finds index of first occurrence of some value in this string builder after or at some start index.
Finds index of first occurrence of some value in this string builder after or at some start index.
B
the type of the element elem.
elem
the element value to search for.
from
the start index
returns
the index >= from of the first element of this string builder that is equal (as determined by ==) to elem, or -1, if none exists.
Definition Classes
SeqOps
def indexOfSlice[B >: Char](that: collection.Seq[B]): Int
Finds first index where this string builder contains a given sequence as a slice.
Finds first index where this string builder contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
that
the sequence to test
returns
the first index >= 0 such that the elements of this string builder starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Definition Classes
SeqOps
Annotations
@deprecatedOverriding()
def indexOfSlice[B >: Char](that: collection.Seq[B], from: Int): Int
Finds first index after or at a start index where this string builder contains a given sequence as a slice.
Finds first index after or at a start index where this string builder contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
that
the sequence to test
from
the start index
returns
the first index >= from such that the elements of this string builder starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Definition Classes
SeqOps
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.
p
the predicate used to test elements.
returns
the index >= 0 of the first element of this string builder that satisfies the predicate p, or -1, if none exists.
Definition Classes
SeqOps
Annotations
@deprecatedOverriding()
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.
p
the predicate used to test elements.
from
the start index
returns
the index >= from of the first element of this string builder that satisfies the predicate p, or -1, if none exists.
Definition Classes
SeqOps
def indices: immutable.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 string builder.
Definition Classes
SeqOps
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.
Definition Classes
IterableOps
def inits: Iterator[StringBuilder]
Iterates over the inits of this string builder.
Iterates over the inits of this string builder. The first value will be this string builder and the final one will be an empty string builder, 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 string builder
Definition Classes
IterableOps
Example:
1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
def insert(index: Int, x: Char): StringBuilder.this.type
def insert(index: Int, x: Double): StringBuilder.this.type
def insert(index: Int, x: Float): StringBuilder.this.type
def insert(index: Int, x: Long): StringBuilder.this.type
def insert(index: Int, x: Int): StringBuilder.this.type
def insert(index: Int, x: Short): StringBuilder.this.type
def insert(index: Int, x: Byte): StringBuilder.this.type
def insert(index: Int, x: Boolean): StringBuilder.this.type
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.
index
the offset position.
x
a primitive value.
returns
this StringBuilder.
def insert(index: Int, x: String): StringBuilder.this.type
Inserts the String into this character sequence.
Inserts the String into this character sequence.
index
the index at which to insert.
x
a String.
returns
this StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if the index is out of bounds.
def insert(index: Int, x: Any): StringBuilder.this.type
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.
index
the index at which to insert.
x
a value.
returns
this StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if the index is out of bounds.
def insertAll(index: Int, xs: Array[Char]): StringBuilder.this.type
Inserts the given Array[Char] into this sequence at the given index.
Inserts the given Array[Char] into this sequence at the given index.
index
the index at which to insert.
xs
the Array[Char].
returns
this StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if the index is out of bounds.
def insertAll(index: Int, xs: IterableOnce[Char]): StringBuilder.this.type
Inserts the given Seq[Char] into this sequence at the given index.
Inserts the given Seq[Char] into this sequence at the given index.
index
the index at which to insert.
xs
the Seq[Char].
returns
this StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if the index is out of bounds.
def insertAll(index: Int, str: Array[Char], offset: Int, len: Int): StringBuilder.this.type
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.
index
index at which to insert the subarray.
str
the Array from which Chars will be taken.
offset
the index of the first Char to insert.
len
the number of Chars from 'str' to insert.
returns
This StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if index < 0, index > length, offset < 0, len < 0, or (offset + len) > str.length.
def intersect[B >: Char](that: collection.Seq[B]): StringBuilder
Computes the multiset intersection between this string builder and another sequence.
Computes the multiset intersection between this string builder and another sequence.
that
the sequence of elements to intersect with.
returns
a new string builder which contains all elements of this string builder which also appear in that. If an element value x appears n times in that, then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.
Definition Classes
SeqOps
def isDefinedAt(idx: Int): Boolean
Tests whether this string builder contains given index.
Tests whether this string builder contains given index.
The implementations of methods apply and isDefinedAt turn a Seq[A] into a PartialFunction[Int, A].
idx
the index to test
returns
true if this string builder contains an element at position idx, false otherwise.
Definition Classes
SeqOps
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
StringBuilder → SeqOps → IterableOnceOps
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object has the same erasure as T0.
Test whether the dynamic type of the receiver object has the same erasure as T0.
Depending on what T0 is, the test is done in one of the below ways:
- T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
- T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
- T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
- T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
- T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
- T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.
This is exactly equivalent to the type pattern _: T0
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
Definition Classes
Any
Note
due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.
def isTraversableAgain: Boolean
Tests whether this string builder can be repeatedly traversed.
Tests whether this string builder can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
returns
true if it is repeatedly traversable, false otherwise.
Definition Classes
IterableOps → IterableOnceOps
def iterableFactory: SeqFactory[IndexedSeq]
The companion object of this string builder, providing various factory methods.
The companion object of this string builder, providing various factory methods.
Definition Classes
IndexedSeq → IndexedSeq → Seq → Seq → Iterable → Iterable → IterableOps
Note
When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).
def iterator: Iterator[Char]
Iterator can be used only once
Iterator can be used only once
Definition Classes
IndexedSeqOps → IterableOnce
def knownSize: Int
returns
The number of elements in this string builder, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
Definition Classes
StringBuilder → IndexedSeqOps → Growable → IterableOnce
def last: Char
Selects the last element.
Selects the last element.
returns
The last element of this string builder.
Definition Classes
IndexedSeqOps → IterableOps
Exceptions thrown
NoSuchElementException If the string builder is empty.
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.
str
the target string to search for
fromIndex
the smallest index in the source string to consider
returns
the last applicable index where target occurs, or -1 if not found.
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.
str
the target string to search for
returns
the last applicable index where target occurs, or -1 if not found.
def lastIndexOf[B >: Char](elem: B, end: Int = length - 1): Int
Finds index of last occurrence of some value in this string builder before or at a given end index.
Finds index of last occurrence of some value in this string builder before or at a given end index.
Note: will not terminate for infinite-sized collections.
B
the type of the element elem.
elem
the element value to search for.
end
the end index.
returns
the index <= end of the last element of this string builder that is equal (as determined by ==) to elem, or -1, if none exists.
Definition Classes
SeqOps
def lastIndexOfSlice[B >: Char](that: collection.Seq[B]): Int
Finds last index where this string builder contains a given sequence as a slice.
Finds last index where this string builder contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
that
the sequence to test
returns
the last index such that the elements of this string builder starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Definition Classes
SeqOps
Annotations
@deprecatedOverriding()
def lastIndexOfSlice[B >: Char](that: collection.Seq[B], end: Int): Int
Finds last index before or at a given end index where this string builder contains a given sequence as a slice.
Finds last index before or at a given end index where this string builder contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
that
the sequence to test
end
the end index
returns
the last index <= end such that the elements of this string builder starting at this index match the elements of sequence that, or -1 if no such subsequence exists.
Definition Classes
SeqOps
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.
p
the predicate used to test elements.
returns
the index of the last element of this string builder that satisfies the predicate p, or -1, if none exists.
Definition Classes
SeqOps
Annotations
@deprecatedOverriding()
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.
p
the predicate used to test elements.
returns
the index <= end of the last element of this string builder that satisfies the predicate p, or -1, if none exists.
Definition Classes
SeqOps
def lastOption: Option[Char]
Optionally selects the last element.
Optionally selects the last element.
returns
the last element of this string builder$ if it is nonempty, None if it is empty.
Definition Classes
IterableOps
def lazyZip[B](that: collection.Iterable[B]): LazyZip2[Char, B, StringBuilder.this.type]
Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.
Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.
Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.
```
val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
```
B
the type of the second element in each eventual pair
that
the iterable providing the second element of each eventual pair
returns
a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.
Definition Classes
Iterable
def length(): Int
The length (number of elements) of the string builder.
The length (number of elements) of the string builder. size is an alias for length in Seq collections.
Definition Classes
StringBuilder → CharSequence → SeqOps
Annotations
@inline()
final def lengthCompare(that: collection.Iterable[_]): Int
Compares the length of this string builder to the size of another Iterable.
Compares the length of this string builder to the size of another Iterable.
that
the Iterable whose size is compared with this string builder's length.
returns
A value x where
```
x <  0       if this.length <  that.size
x == 0       if this.length == that.size
x >  0       if this.length >  that.size
```
The method as implemented here does not call length or size directly; its running time is O(this.length min that.size) instead of O(this.length + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.
Definition Classes
IndexedSeqOps → SeqOps
final def lengthCompare(len: Int): Int
Compares the length of this string builder to a test value.
Compares the length of this string builder to a test value.
len
the test value that gets compared with the length.
returns
A value x where
```
x <  0       if this.length <  len
x == 0       if this.length == len
x >  0       if this.length >  len
```
The method as implemented here does not call length directly; its running time is O(length min len) instead of O(length). The method should be overridden if computing length is cheap and knownSize returns -1.
Definition Classes
IndexedSeqOps → SeqOps
See also
lengthIs
final def lengthIs: SizeCompareOps
Returns a value class containing operations for comparing the length of this string builder to a test value.
Returns a value class containing operations for comparing the length of this string builder 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
```
Definition Classes
SeqOps
Annotations
@inline()
def length_=(n: Int): Unit
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.
Definition Classes
PartialFunction
See also
Function.unlift
def map[B](f: (Char) => B): IndexedSeq[B]
Builds a new string builder by applying a function to all elements of this string builder.
Builds a new string builder by applying a function to all elements of this string builder.
B
the element type of the returned string builder.
f
the function to apply to each element.
returns
a new string builder resulting from applying the given function f to each element of this string builder and collecting the results.
Definition Classes
IndexedSeqOps → IterableOps → IterableOnceOps
def mapInPlace(f: (Char) => Char): StringBuilder.this.type
Modifies this string builder by applying a function to all elements of this string builder.
Modifies this string builder by applying a function to all elements of this string builder.
f
the function to apply to each element.
returns
this string builder modified by replacing all elements with the result of applying the given function f to each element of this string builder.
Definition Classes
IndexedSeqOps
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.
Definition Classes
Builder
def max[B >: Char](implicit ord: math.Ordering[B]): Char
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
B
The type over which the ordering is defined.
ord
An ordering to be used for comparing elements.
returns
the largest element of this string builder with respect to the ordering ord.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def maxBy[B](f: (Char) => B)(implicit ord: math.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.
B
The result type of the function f.
f
The measuring function.
returns
the first element of this string builder with the largest value measured by function f with respect to the ordering cmp.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def maxByOption[B](f: (Char) => B)(implicit ord: math.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.
B
The result type of the function f.
f
The measuring function.
returns
an option value containing the first element of this string builder with the largest value measured by function f with respect to the ordering cmp.
Definition Classes
IterableOnceOps
def maxOption[B >: Char](implicit ord: math.Ordering[B]): Option[Char]
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
B
The type over which the ordering is defined.
ord
An ordering to be used for comparing elements.
returns
an option value containing the largest element of this string builder with respect to the ordering ord.
Definition Classes
IterableOnceOps
def min[B >: Char](implicit ord: math.Ordering[B]): Char
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
B
The type over which the ordering is defined.
ord
An ordering to be used for comparing elements.
returns
the smallest element of this string builder with respect to the ordering ord.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def minBy[B](f: (Char) => B)(implicit ord: math.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.
B
The result type of the function f.
f
The measuring function.
returns
the first element of this string builder with the smallest value measured by function f with respect to the ordering cmp.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def minByOption[B](f: (Char) => B)(implicit ord: math.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.
B
The result type of the function f.
f
The measuring function.
returns
an option value containing the first element of this string builder with the smallest value measured by function f with respect to the ordering cmp.
Definition Classes
IterableOnceOps
def minOption[B >: Char](implicit ord: math.Ordering[B]): Option[Char]
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
B
The type over which the ordering is defined.
ord
An ordering to be used for comparing elements.
returns
an option value containing the smallest element of this string builder with respect to the ordering ord.
Definition Classes
IterableOnceOps
final def mkString: String
Displays all elements of this string builder in a string.
Displays all elements of this string builder in a string.
Delegates to addString, which can be overridden.
returns
a string representation of this string builder. In the resulting string the string representations (w.r.t. the method toString) of all elements of this string builder follow each other without any separator string.
Definition Classes
IterableOnceOps
Annotations
@inline()
final def mkString(sep: String): String
Displays all elements of this string builder in a string using a separator string.
Displays all elements of this string builder in a string using a separator string.
Delegates to addString, which can be overridden.
sep
the separator string.
returns
a string representation of this string builder. In the resulting string the string representations (w.r.t. the method toString) of all elements of this string builder are separated by the string sep.
Definition Classes
IterableOnceOps
Annotations
@inline()
Example:
1. List(1, 2, 3).mkString("|") = "1|2|3"
final def mkString(start: String, sep: String, end: String): String
Displays all elements of this string builder in a string using start, end, and separator strings.
Displays all elements of this string builder in a string using start, end, and separator strings.
Delegates to addString, which can be overridden.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
a string representation of this string builder. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this string builder are separated by the string sep.
Definition Classes
IterableOnceOps
Example:
1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.
Definition Classes
AnyRef
def newSpecificBuilder: Builder[Char, StringBuilder]
returns
a strict builder for the same collection type. Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList), it is possible to implement this method but the resulting Builder will break laziness. As a consequence, operations should preferably be implemented with fromSpecific instead of this method.
Attributes
protected
Definition Classes
StringBuilder → IterableFactoryDefaults → IterableOps
Note
When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.
,
As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as the returned builder is only fed with A values taken from this instance, it is safe.
def nonEmpty: Boolean
Tests whether the string builder is not empty.
Tests whether the string builder is not empty.
returns
true if the string builder contains at least one element, false otherwise.
Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding()
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Definition Classes
AnyRef
Annotations
@native()
Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Definition Classes
AnyRef
Annotations
@native()
Note
not specified by SLS as a member of AnyRef
def occCounts[B](sq: collection.Seq[B]): Map[B, Int]
Attributes
protected[collection]
Definition Classes
SeqOps
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.
A1
the argument type of the fallback function
B1
the result type of the fallback function
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.
Definition Classes
PartialFunction
def padTo[B >: Char](len: Int, elem: B): IndexedSeq[B]
A copy of this string builder with an element value appended until a given target length is reached.
A copy of this string builder with an element value appended until a given target length is reached.
B
the element type of the returned string builder.
len
the target length
elem
the padding value
returns
a new string builder consisting of all elements of this string builder followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.
Definition Classes
SeqOps
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.
Definition Classes
IterableOps
def partitionMap[A1, A2](f: (Char) => Either[A1, A2]): (IndexedSeq[A1], IndexedSeq[A2])
Applies a function f to each element of the string builder and returns a pair of string builders: 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 string builder and returns a pair of string builders: 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 = `mutable.IndexedSeq`(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (`mutable.IndexedSeq`(1, 2, 3),
//        `mutable.IndexedSeq`(one, two, three))
```
A1
the element type of the first resulting collection
A2
the element type of the second resulting collection
f
the 'split function' mapping the elements of this string builder to an scala.util.Either
returns
a pair of string builders: 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.
Definition Classes
IterableOps
def patch[B >: Char](from: Int, other: IterableOnce[B], replaced: Int): IndexedSeq[B]
Produces a new string builder where a slice of elements in this string builder is replaced by another sequence.
Produces a new string builder where a slice of elements in this string builder 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 string builder appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
B
the element type of the returned string builder.
from
the index of the first replaced element
other
the replacement sequence
replaced
the number of elements to drop in the original string builder
returns
a new string builder consisting of all elements of this string builder except that replaced elements starting from from are replaced by all the elements of other.
Definition Classes
SeqOps
def permutations: Iterator[StringBuilder]
Iterates over distinct permutations of elements.
Iterates over distinct permutations of elements.
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 string builder.
Definition Classes
SeqOps
Example:
1. Seq('a', 'b', 'b').permutations.foreach(println) // List(a, b, b) // List(b, a, b) // List(b, b, a)
def prepended[B >: Char](elem: B): IndexedSeq[B]
A copy of the string builder with an element prepended.
A copy of the string builder with an element prepended.
Also, the original string builder is not modified, so you will want to capture the result.
Example:
```
scala> val x = List(1)
x: List[Int] = List(1)

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

scala> println(x)
List(1)
```
B
the element type of the returned string builder.
elem
the prepended element
returns
a new string builder consisting of value followed by all elements of this string builder.
Definition Classes
IndexedSeqOps → SeqOps
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.
B
the element type of the returned collection.
prefix
the iterable to prepend.
returns
a new string builder which contains all elements of prefix followed by all the elements of this string builder.
Definition Classes
SeqOps
def product[B >: Char](implicit num: math.Numeric[B]): B
Multiplies together the elements of this collection.
Multiplies together the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
B
the result type of the * operator.
num
an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.
returns
the product of all elements of this string builder with respect to the * operator in num.
Definition Classes
IterableOnceOps
def reduce[B >: Char](op: (B, B) => B): B
Reduces the elements of this string builder using the specified associative binary operator.
Reduces the elements of this string builder using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
B
A type parameter for the binary operator, a supertype of A.
op
A binary operator that must be associative.
returns
The result of applying reduce operator op between all the elements if the string builder is nonempty.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def reduceLeft[B >: Char](op: (B, Char) => B): B
Applies a binary operator to all elements of this string builder, going left to right.
Applies a binary operator to all elements of this string builder, going left to right.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this string builder, going left to right: op( op( ... op(x₁, x₂) ..., x_n-1), x_n) where x₁, ..., x_n are the elements of this string builder.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def reduceLeftOption[B >: Char](op: (B, Char) => B): Option[B]
Optionally applies a binary operator to all elements of this string builder, going left to right.
Optionally applies a binary operator to all elements of this string builder, going left to right.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceLeft(op) if this string builder is nonempty, None otherwise.
Definition Classes
IterableOnceOps
def reduceOption[B >: Char](op: (B, B) => B): Option[B]
Reduces the elements of this string builder, if any, using the specified associative binary operator.
Reduces the elements of this string builder, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
B
A type parameter for the binary operator, a supertype of A.
op
A binary operator that must be associative.
returns
An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.
Definition Classes
IterableOnceOps
def reduceRight[B >: Char](op: (Char, B) => B): B
Applies a binary operator to all elements of this string builder, going right to left.
Applies a binary operator to all elements of this string builder, going right to left.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this string builder, going right to left: op(x₁, op(x₂, ..., op(x_n-1, x_n)...)) where x₁, ..., x_n are the elements of this string builder.
Definition Classes
IterableOnceOps
Exceptions thrown
UnsupportedOperationException if this string builder is empty.
def reduceRightOption[B >: Char](op: (Char, B) => B): Option[B]
Optionally applies a binary operator to all elements of this string builder, going right to left.
Optionally applies a binary operator to all elements of this string builder, going right to left.
Note: will not terminate for infinite-sized collections.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceRight(op) if this string builder is nonempty, None otherwise.
Definition Classes
IterableOnceOps
def replace(start: Int, end: Int, str: String): StringBuilder.this.type
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'.
start
The beginning index, inclusive.
end
The ending index, exclusive.
str
The String to be inserted at the start index.
returns
This StringBuilder.
Exceptions thrown
StringIndexOutOfBoundsException if start < 0, start > length, or start > end
def result(): String
Produces a collection from the added elements.
Produces a collection from the added elements.
After a call to result, the behavior of all other methods is undefined save for clear(). If clear() is called, then the builder is reset and may be used to build another instance.
returns
a collection containing the elements added to this builder.
Definition Classes
StringBuilder → ReusableBuilder → Builder
def reverse: StringBuilder
Returns new string builder with elements in reversed order.
Returns new string builder with elements in reversed order.
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.
returns
A new string builder with all elements of this string builder in reversed order.
Definition Classes
IndexedSeqOps → SeqOps
def reverseInPlace(): StringBuilder.this.type
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)
def reverseIterator: Iterator[Char]
An iterator yielding elements in reversed order.
An iterator yielding elements in reversed order.
Note: will not terminate for infinite-sized collections.
Note: xs.reverseIterator is the same as xs.reverse.iterator but might be more efficient.
returns
an iterator yielding the elements of this string builder in reversed order
Definition Classes
IndexedSeqOps → SeqOps
def reversed: collection.Iterable[Char]
Attributes
protected
Definition Classes
IndexedSeqOps → IterableOnceOps
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.
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.
Definition Classes
PartialFunction
See also
applyOrElse.
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?
Definition Classes
SeqOps
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.
B
element type of the resulting collection
z
neutral element for the operator op
op
the associative operator for the scan
returns
a new string builder containing the prefix scan of the elements in this string builder
Definition Classes
IterableOps
def scanLeft[B](z: B)(op: (B, Char) => B): IndexedSeq[B]
Produces a string builder containing cumulative results of applying the operator going left to right, including the initial value.
Produces a string builder containing cumulative results of applying the operator going left to right, including the initial value.
Note: will not terminate for infinite-sized collections.
B
the type of the elements in the resulting collection
z
the initial value
op
the binary operator applied to the intermediate result and the element
returns
collection with intermediate results
Definition Classes
IterableOps → IterableOnceOps
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: 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)
```
B
the type of the elements in the resulting collection
z
the initial value
op
the binary operator applied to the intermediate result and the element
returns
collection with intermediate results
Definition Classes
IterableOps
def search[B >: Char](elem: B, from: Int, to: Int)(implicit ord: math.Ordering[B]): SearchResult
Search within an interval in this sorted sequence for a specific element.
Search within an interval in this sorted sequence for a specific element. If this sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.
The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.
elem
the element to find.
from
the index where the search starts.
to
the index following where the search ends.
ord
the ordering to be used to compare elements.
returns
a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.
Definition Classes
IndexedSeqOps → SeqOps
Note
if to <= from, the search space is empty, and an InsertionPoint at from is returned
See also
scala.collection.IndexedSeq
scala.math.Ordering
scala.collection.SeqOps, method sorted
def search[B >: Char](elem: B)(implicit ord: math.Ordering[B]): SearchResult
Search this sorted sequence for a specific element.
Search this sorted sequence for a specific element. If the sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.
The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.
elem
the element to find.
ord
the ordering to be used to compare elements.
returns
a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.
Definition Classes
IndexedSeqOps → SeqOps
See also
scala.collection.IndexedSeq
scala.math.Ordering
scala.collection.SeqOps, method sorted
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.
p
the predicate used to test elements.
from
the index where the search starts.
returns
the length of the longest segment of this string builder starting from index from such that every element of the segment satisfies the predicate p.
Definition Classes
SeqOps
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.
p
the predicate used to test elements.
returns
the length of the longest segment of this string builder that starts from the first element such that every element of the segment satisfies the predicate p.
Definition Classes
SeqOps
def setCharAt(index: Int, ch: Char): StringBuilder.this.type
Update the sequence at the given index to hold the specified Char.
Update the sequence at the given index to hold the specified Char.
index
the index to modify.
ch
the new Char.
Exceptions thrown
IndexOutOfBoundsException if the index is out of bounds.
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.
len
the new length
Exceptions thrown
IndexOutOfBoundsException if the argument is negative.
final def size: Int
The size of this string builder.
The size of this string builder.
Note: will not terminate for infinite-sized collections.
returns
the number of elements in this string builder.
Definition Classes
SeqOps → IterableOnceOps
final def sizeCompare(that: collection.Iterable[_]): Int
Compares the size of this string builder to the size of another Iterable.
Compares the size of this string builder to the size of another Iterable.
that
the Iterable whose size is compared with this string builder's size.
returns
A value x where
```
x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size
```
The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.
Definition Classes
SeqOps → IterableOps
final def sizeCompare(otherSize: Int): Int
Compares the size of this string builder to a test value.
Compares the size of this string builder to a test value.
otherSize
the test value that gets compared with the size.
returns
A value x where
```
x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize
```
The method as implemented here does not call size directly; its running time is O(size min otherSize) instead of O(size). The method should be overridden if computing size is cheap and knownSize returns -1.
Definition Classes
SeqOps → IterableOps
See also
sizeIs
final def sizeHint(coll: IterableOnce[_], delta: Int = 0): 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.
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.
Definition Classes
Builder
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.
size
the hint how many elements will be added.
Definition Classes
Builder
final def sizeHintBounded(size: Int, boundingColl: collection.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.
size
the hint how many elements will be added.
boundingColl
the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.
Definition Classes
Builder
final def sizeIs: SizeCompareOps
Returns a value class containing operations for comparing the size of this string builder to a test value.
Returns a value class containing operations for comparing the size of this string builder 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
```
Definition Classes
IterableOps
Annotations
@inline()
def slice(from: Int, until: Int): StringBuilder
Selects an interval of elements.
Selects an interval of elements. The returned string builder is made up of all elements x which satisfy the invariant:
```
from <= indexOf(x) < until
```
from
the lowest index to include from this string builder.
until
the lowest index to EXCLUDE from this string builder.
returns
a string builder containing the elements greater than or equal to index from extending up to (but not including) index until of this string builder.
Definition Classes
IndexedSeqOps → IterableOps → IterableOnceOps
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.
size
the number of elements per group
step
the distance between the first elements of successive groups
returns
An iterator producing string builders 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.
Definition Classes
IterableOps
Examples:
1. List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))
2. List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))
See also
scala.collection.Iterator, method sliding
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.
size
the number of elements per group
returns
An iterator producing string builders 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.
Definition Classes
IterableOps
Examples:
1. List().sliding(2) = empty iterator
2. List(1).sliding(2) = Iterator(List(1))
3. List(1, 2).sliding(2) = Iterator(List(1, 2))
4. List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))
See also
scala.collection.Iterator, method sliding
def sortBy[B](f: (Char) => B)(implicit ord: Ordering[B]): StringBuilder
Sorts this string builder according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
Sorts this string builder 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.
B
the target type of the transformation f, and the type where the ordering ord is defined.
f
the transformation function mapping elements to some other domain B.
ord
the ordering assumed on domain B.
returns
a string builder consisting of the elements of this string builder sorted according to the ordering where x < y if ord.lt(f(x), f(y)).
Definition Classes
SeqOps
Example:
1. val words = "The quick brown fox jumped over the lazy dog".split(' ') // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]] words.sortBy(x => (x.length, x.head)) res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
See also
scala.math.Ordering
def sortInPlace[B >: Char]()(implicit ord: Ordering[B]): StringBuilder.this.type
Sorts this string builder in place according to an Ordering.
Sorts this string builder in place according to an Ordering.
ord
the ordering to be used to compare elements.
returns
modified input string builder sorted according to the ordering ord.
Definition Classes
IndexedSeqOps
See also
scala.collection.SeqOps.sorted
def sortInPlaceBy[B](f: (Char) => B)(implicit ord: Ordering[B]): StringBuilder.this.type
Sorts this string builder in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
Sorts this string builder in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
Definition Classes
IndexedSeqOps
See also
scala.collection.SeqOps.sortBy
def sortInPlaceWith(lt: (Char, Char) => Boolean): StringBuilder.this.type
Sorts this string builder in place according to a comparison function.
Sorts this string builder in place according to a comparison function.
Definition Classes
IndexedSeqOps
See also
scala.collection.SeqOps.sortWith
def sortWith(lt: (Char, Char) => Boolean): StringBuilder
Sorts this string builder according to a comparison function.
Sorts this string builder 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 (lt returns false for both directions of comparison) appear in the same order in the sorted sequence as in the original.
lt
a predicate that is true if its first argument strictly precedes its second argument in the desired ordering.
returns
a string builder consisting of the elements of this string builder sorted according to the comparison function lt.
Definition Classes
SeqOps
Example:
1. List("Steve", "Bobby", "Tom", "John", "Bob").sortWith((x, y) => x.take(3).compareTo(y.take(3)) < 0) = List("Bobby", "Bob", "John", "Steve", "Tom")
def sorted[B >: Char](implicit ord: Ordering[B]): StringBuilder
Sorts this string builder according to an Ordering.
Sorts this string builder according to an Ordering.
The sort is stable. That is, elements that are equal (as determined by ord.compare) appear in the same order in the sorted sequence as in the original.
ord
the ordering to be used to compare elements.
returns
a string builder consisting of the elements of this string builder sorted according to the ordering ord.
Definition Classes
SeqOps
See also
scala.math.Ordering Note: Even when applied to a view or a lazy collection it will always force the elements.
def span(p: (Char) => Boolean): (StringBuilder, StringBuilder)
Splits this string builder into a prefix/suffix pair according to a predicate.
Splits this string builder into a prefix/suffix pair according to a predicate.
Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.
p
the test predicate
returns
a pair consisting of the longest prefix of this string builder whose elements all satisfy p, and the rest of this string builder.
Definition Classes
IterableOps → IterableOnceOps
def splitAt(n: Int): (StringBuilder, StringBuilder)
Splits this string builder into a prefix/suffix pair at a given position.
Splits this string builder into a prefix/suffix pair at a given position.
Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).
n
the position at which to split.
returns
a pair of string builders consisting of the first n elements of this string builder, and the other elements.
Definition Classes
IterableOps → IterableOnceOps
def startsWith[B >: Char](that: IterableOnce[B], offset: Int = 0): Boolean
Tests whether this string builder contains the given sequence at a given index.
Tests whether this string builder contains the given sequence at a given index.
Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.
that
the sequence to test
offset
the index where the sequence is searched.
returns
true if the sequence that is contained in this string builder at index offset, otherwise false.
Definition Classes
SeqOps
def stepper[S <: Stepper[_]](implicit shape: StepperShape[Char, S]): S with EfficientSplit
Returns a scala.collection.Stepper for the elements of this collection.
Returns a scala.collection.Stepper for the elements of this collection.
The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.
The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.
- For collections of Int, Short, Byte or Char, an scala.collection.IntStepper is returned
- For collections of Double or Float, a scala.collection.DoubleStepper is returned
- For collections of Long a scala.collection.LongStepper is returned
- For any other element type, an scala.collection.AnyStepper is returned
Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.
Definition Classes
IndexedSeqOps → IterableOnce
def stringPrefix: String
Attributes
protected[this]
Definition Classes
IndexedSeq → Seq → Iterable
Annotations
@nowarn()
def subSequence(start: Int, end: Int): CharSequence
For implementing CharSequence.
For implementing CharSequence.
Definition Classes
StringBuilder → CharSequence
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
start
The beginning index, inclusive.
end
The ending index, exclusive.
returns
The new String.
Exceptions thrown
StringIndexOutOfBoundsException If either index is out of bounds, or if start > end.
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)
start
The starting index, inclusive.
returns
The new String.
Exceptions thrown
IndexOutOfBoundsException if the index is out of bounds.
def sum[B >: Char](implicit num: math.Numeric[B]): B
Sums the elements of this collection.
Sums the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
B
the result type of the + operator.
num
an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.
returns
the sum of all elements of this string builder with respect to the + operator in num.
Definition Classes
IterableOnceOps
final def synchronized[T0](arg0: => T0): T0
Executes the code in body with an exclusive lock on this.
Executes the code in body with an exclusive lock on this.
returns
the result of body
Definition Classes
AnyRef
def tail: StringBuilder
The rest of the collection without its first element.
The rest of the collection without its first element.
Definition Classes
IterableOps
def tails: Iterator[StringBuilder]
Iterates over the tails of this string builder.
Iterates over the tails of this string builder. The first value will be this string builder and the final one will be an empty string builder, with the intervening values the results of successive applications of tail.
returns
an iterator over all the tails of this string builder
Definition Classes
IterableOps
Example:
1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
def take(n: Int): StringBuilder
Selects the first n elements.
Selects the first n elements.
n
the number of elements to take from this string builder.
returns
a string builder consisting only of the first n elements of this string builder, or else the whole string builder, if it has less than n elements. If n is negative, returns an empty string builder.
Definition Classes
IndexedSeqOps → IterableOps → IterableOnceOps
def takeRight(n: Int): StringBuilder
Selects the last n elements.
Selects the last n elements.
n
the number of elements to take from this string builder.
returns
a string builder consisting only of the last n elements of this string builder, or else the whole string builder, if it has less than n elements. If n is negative, returns an empty string builder.
Definition Classes
IndexedSeqOps → IterableOps
def takeWhile(p: (Char) => Boolean): StringBuilder
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
p
The predicate used to test elements.
returns
the longest prefix of this string builder whose elements all satisfy the predicate p.
Definition Classes
IterableOps → IterableOnceOps
def tapEach[U](f: (Char) => U): StringBuilder
Applies a side-effecting function to each element in this collection.
Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.
U
the return type of f
f
a function to apply to each element in this string builder
returns
The same logical collection as this
Definition Classes
IterableOps → IterableOnceOps
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]
```
Definition Classes
IterableOnceOps
def toArray[B >: Char](implicit ct: ClassTag[B]): Array[B]
Convert collection to array.
Convert collection to array.
Implementation note: DO NOT call Array.from from this method.
Definition Classes
StringBuilder → IterableOnceOps
final def toBuffer[B >: Char]: Buffer[B]
Definition Classes
IterableOnceOps
Annotations
@inline()
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.
def toIndexedSeq: immutable.IndexedSeq[Char]
Definition Classes
IterableOnceOps
def toList: immutable.List[Char]
Definition Classes
IterableOnceOps
def toMap[K, V](implicit ev: <:<[Char, (K, V)]): immutable.Map[K, V]
Definition Classes
IterableOnceOps
def toSeq: immutable.Seq[Char]
returns
This collection as a Seq[A]. This is equivalent to to(Seq) but might be faster.
Definition Classes
IterableOnceOps
def toSet[B >: Char]: immutable.Set[B]
Definition Classes
IterableOnceOps
def toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.
Definition Classes
StringBuilder → CharSequence → Seq → Function1 → Iterable → AnyRef → Any
def toVector: immutable.Vector[Char]
Definition Classes
IterableOnceOps
def transpose[B](implicit asIterable: (Char) => collection.Iterable[B]): IndexedSeq[IndexedSeq[B]]
Transposes this string builder of iterable collections into a string builder of string builders.
Transposes this string builder of iterable collections into a string builder of string builders.
The resulting collection's type will be guided by the static type of string builder. 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.
B
the type of the elements of each iterable collection.
asIterable
an implicit conversion which asserts that the element type of this string builder is an Iterable.
returns
a two-dimensional string builder of string builders which has as nth row the nth column of this string builder.
Definition Classes
IterableOps
Exceptions thrown
IllegalArgumentException if all collections in this string builder are not of the same size.
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.
Definition Classes
PartialFunction
val underlying: java.lang.StringBuilder
def unzip[A1, A2](implicit asPair: (Char) => (A1, A2)): (IndexedSeq[A1], IndexedSeq[A2])
Converts this string builder of pairs into two collections of the first and second half of each pair.
Converts this string builder of pairs into two collections of the first and second half of each pair.
```
val xs = `mutable.IndexedSeq`(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (`mutable.IndexedSeq`(1, 2, 3),
//        `mutable.IndexedSeq`(one, two, three))
```
A1
the type of the first half of the element pairs
A2
the type of the second half of the element pairs
asPair
an implicit conversion which asserts that the element type of this string builder is a pair.
returns
a pair of string builders, containing the first, respectively second half of each element pair of this string builder.
Definition Classes
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: (Char) => (A1, A2, A3)): (IndexedSeq[A1], IndexedSeq[A2], IndexedSeq[A3])
Converts this string builder of triples into three collections of the first, second, and third element of each triple.
Converts this string builder of triples into three collections of the first, second, and third element of each triple.
```
val xs = `mutable.IndexedSeq`(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (`mutable.IndexedSeq`(1, 2, 3),
//        `mutable.IndexedSeq`(one, two, three),
//        `mutable.IndexedSeq`(1, 2, 3))
```
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
asTriple
an implicit conversion which asserts that the element type of this string builder is a triple.
returns
a triple of string builders, containing the first, second, respectively third member of each element triple of this string builder.
Definition Classes
IterableOps
def update(idx: Int, elem: Char): Unit
Replaces element at given index with a new value.
Replaces element at given index with a new value.
idx
the index of the element to replace.
elem
the new value.
Definition Classes
StringBuilder → SeqOps
Exceptions thrown
IndexOutOfBoundsException if the index is not valid.
def updated[B >: Char](index: Int, elem: B): IndexedSeq[B]
A copy of this string builder with one single replaced element.
A copy of this string builder with one single replaced element.
B
the element type of the returned string builder.
index
the position of the replacement
elem
the replacing element
returns
a new string builder which is a copy of this string builder with the element at position index replaced by elem.
Definition Classes
SeqOps
Exceptions thrown
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).
def view: IndexedSeqView[Char]
A view over the elements of this collection.
A view over the elements of this collection.
Definition Classes
IndexedSeqOps → SeqOps → IterableOps
final def wait(): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
Note
not specified by SLS as a member of AnyRef
final def wait(arg0: Long, arg1: Int): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
Note
not specified by SLS as a member of AnyRef
final def wait(arg0: Long): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
Note
not specified by SLS as a member of AnyRef
def withFilter(p: (Char) => Boolean): WithFilter[Char, [_]IndexedSeq[_]]
Creates a non-strict filter of this string builder.
Creates a non-strict filter of this string builder.
Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.
p
the predicate used to test elements.
returns
an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this string builder which satisfy the predicate p.
Definition Classes
IterableOps
def zip[B](that: IterableOnce[B]): IndexedSeq[(Char, B)]
Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs.
Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.
B
the type of the second half of the returned pairs
that
The iterable providing the second half of each result pair
returns
a new string builder containing pairs consisting of corresponding elements of this string builder and that. The length of the returned collection is the minimum of the lengths of this string builder and that.
Definition Classes
IterableOps
def zipAll[A1 >: Char, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): IndexedSeq[(A1, B)]
Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs.
Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
that
the iterable providing the second half of each result pair
thisElem
the element to be used to fill up the result if this string builder is shorter than that.
thatElem
the element to be used to fill up the result if that is shorter than this string builder.
returns
a new collection of type That containing pairs consisting of corresponding elements of this string builder and that. The length of the returned collection is the maximum of the lengths of this string builder and that. If this string builder is shorter than that, thisElem values are used to pad the result. If that is shorter than this string builder, thatElem values are used to pad the result.
Definition Classes
IterableOps
def zipWithIndex: IndexedSeq[(Char, Int)]
Zips this string builder with its indices.
Zips this string builder with its indices.
returns
A new string builder containing pairs consisting of all elements of this string builder paired with their index. Indices start at 0.
Definition Classes
IterableOps → IterableOnceOps
Example:
1. List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Deprecated Value Members

final def +=(elem1: Char, elem2: Char, elems: Char*): StringBuilder.this.type
Adds two or more elements to this string builder.
Adds two or more elements to this string builder.
elem1
the first element to add.
elem2
the second element to add.
elems
the remaining elements to add.
returns
the string builder itself
Definition Classes
Growable
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use ++= aka addAll instead of varargs +=; infix operations with an operand of multiple args will be deprecated
def /:[B](z: B)(op: (B, Char) => B): B
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char])./:(z)(op)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.foldLeft instead
final def /:[B](z: B)(op: (B, Char) => B): B
Definition Classes
IterableOnceOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use foldLeft instead of /:
def :\[B](z: B)(op: (Char, B) => B): B
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).:\(z)(op)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.foldRight instead
final def :\[B](z: B)(op: (Char, B) => B): B
Definition Classes
IterableOnceOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use foldRight instead of :\
def aggregate[B](z: => B)(seqop: (B, Char) => B, combop: (B, B) => B): B
Definition Classes
IterableOnceOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) aggregate is not relevant for sequential collections. Use foldLeft(z)(seqop) instead.
def collectFirst[B](f: PartialFunction[Char, B]): Option[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).collectFirst(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.collectFirst(...) instead
def companion: IterableFactory[[_]IndexedSeq[_]]
Definition Classes
IterableOps
Annotations
@deprecated @deprecatedOverriding() @inline()
Deprecated
(Since version 2.13.0) Use iterableFactory instead
def copyToBuffer(dest: Buffer[Char]): Unit
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).copyToBuffer(dest)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.copyToBuffer(...) instead
final def copyToBuffer[B >: Char](dest: Buffer[B]): Unit
Definition Classes
IterableOnceOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use dest ++= coll instead
def count(f: (Char) => Boolean): Int
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).count(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.count(...) instead
def exists(f: (Char) => Boolean): Boolean
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).exists(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.exists(...) instead
def filter(f: (Char) => Boolean): Iterator[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).filter(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.filter(...) instead
def find(p: (Char) => Boolean): Option[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).find(p)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.find instead
def flatMap[B](f: (Char) => IterableOnce[B]): IterableOnce[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).flatMap(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.flatMap instead or consider requiring an Iterable
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).fold(z)(op)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.fold instead
def foldLeft[B](z: B)(op: (B, Char) => B): B
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).foldLeft(z)(op)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.foldLeft instead
def foldRight[B](z: B)(op: (Char, B) => B): B
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).foldRight(z)(op)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.foldRight instead
def forall(f: (Char) => Boolean): Boolean
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).forall(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.forall(...) instead
def foreach[U](f: (Char) => U): Unit
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).foreach(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.foreach(...) instead
def formatted(fmtstr: String): String
Returns string formatted according to given format string.
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).
Implicit
This member is added by an implicit conversion from StringBuilder toStringFormat[StringBuilder] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def hasDefiniteSize: Boolean
Tests whether this string builder is known to have a finite size.
Tests whether this string builder 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.
Definition Classes
IterableOnceOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
See also
method knownSize for a more useful alternative
def isEmpty: Boolean
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).isEmpty
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.isEmpty instead
def map[B](f: (Char) => B): IterableOnce[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).map(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.map instead or consider requiring an Iterable
def max(implicit ord: math.Ordering[Char]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).max(ord)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.max instead
def maxBy[B](f: (Char) => B)(implicit cmp: math.Ordering[B]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).maxBy(f)(cmp)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.maxBy(...) instead
def min(implicit ord: math.Ordering[Char]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).min(ord)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.min instead
def minBy[B](f: (Char) => B)(implicit cmp: math.Ordering[B]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).minBy(f)(cmp)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.minBy(...) instead
def mkString: String
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).mkString
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
def mkString(sep: String): String
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).mkString(sep)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
def mkString(start: String, sep: String, end: String): String
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).mkString(start, sep, end)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
def nonEmpty: Boolean
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).nonEmpty
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.nonEmpty instead
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.
p
the predicate used to test elements.
returns
the length of the longest prefix of this string builder such that every element of the segment satisfies the predicate p.
Definition Classes
SeqOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use segmentLength instead of prefixLength
def product(implicit num: math.Numeric[Char]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).product(num)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.product instead
def reduce(f: (Char, Char) => Char): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduce(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduce(...) instead
def reduceLeft(f: (Char, Char) => Char): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduceLeft(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduceLeft(...) instead
def reduceLeftOption(f: (Char, Char) => Char): Option[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduceLeftOption(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduceLeftOption(...) instead
def reduceOption(f: (Char, Char) => Char): Option[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduceOption(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduceOption(...) instead
def reduceRight(f: (Char, Char) => Char): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduceRight(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduceRight(...) instead
def reduceRightOption(f: (Char, Char) => Char): Option[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).reduceRightOption(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.reduceRightOption(...) instead
final def repr: StringBuilder
Definition Classes
IterableOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside
final def reverseContents(): StringBuilder.this.type
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)
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use reverseInPlace instead
def reverseMap[B](f: (Char) => B): IndexedSeq[B]
Definition Classes
SeqOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .reverseIterator.map(f).to(...) instead of .reverseMap(f)
def sameElements[B >: A](that: IterableOnce[B]): Boolean
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).sameElements(that)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.sameElements instead
def seq: StringBuilder.this.type
Definition Classes
Iterable
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Iterable.seq always returns the iterable itself
def size: Int
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).size
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.size instead
def sum(implicit num: math.Numeric[Char]): Char
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).sum(num)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.sum instead
def to[C1](factory: Factory[Char, C1]): C1
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).to(factory)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.to(factory) instead
def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toArray(arg0)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.toArray
def toBuffer[B >: A]: Buffer[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toBuffer
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.to(ArrayBuffer) instead
def toIndexedSeq: collection.IndexedSeq[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toIndexedSeq
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.toIndexedSeq instead
final def toIterable: collection.Iterable[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toIterable
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
final def toIterable: StringBuilder.this.type
returns
This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].
Definition Classes
Iterable → IterableOps
Annotations
@deprecated
Deprecated
(Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections
def toIterator: Iterator[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toIterator
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator instead
final def toIterator: Iterator[Char]
Definition Classes
IterableOnceOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator instead of .toIterator
def toList: immutable.List[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toList
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.to(List) instead
def toMap[K, V](implicit ev: <:<[Char, (K, V)]): immutable.Map[K, V]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toMap(ev)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.to(Map) instead
def toSeq: immutable.Seq[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toSeq
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(Seq) instead
def toSet[B >: A]: immutable.Set[B]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toSet
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(Set) instead
def toStream: immutable.Stream[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toStream
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(LazyList) instead
final def toStream: immutable.Stream[Char]
Definition Classes
IterableOnceOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .to(LazyList) instead of .toStream
final def toTraversable: collection.Traversable[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toTraversable
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
final def toTraversable: collection.Traversable[Char]
Converts this string builder to an unspecified Iterable.
Converts this string builder to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
returns
An Iterable containing all elements of this string builder.
Definition Classes
IterableOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections
def toVector: immutable.Vector[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).toVector
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use .iterator.to(Vector) instead
final def transform(f: (Char) => Char): StringBuilder.this.type
Definition Classes
SeqOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use mapInPlace on an IndexedSeq instead
final def union[B >: Char](that: collection.Seq[B]): IndexedSeq[B]
Produces a new sequence which contains all elements of this string builder and also all elements of a given sequence.
Produces a new sequence which contains all elements of this string builder and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys.
B
the element type of the returned string builder.
that
the sequence to add.
returns
a new collection which contains all elements of this string builder followed by all elements of that.
Definition Classes
SeqOps
Annotations
@deprecated @inline()
Deprecated
(Since version 2.13.0) Use concat instead
def view(from: Int, until: Int): IndexedSeqView[Char]
A view over a slice of the elements of this collection.
A view over a slice of the elements of this collection.
Definition Classes
IndexedSeqOps → IterableOps
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)
def withFilter(f: (Char) => Boolean): Iterator[Char]
Implicit
This member is added by an implicit conversion from StringBuilder toIterableOnceExtensionMethods[Char] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(stringBuilder: IterableOnceExtensionMethods[Char]).withFilter(f)
Definition Classes
IterableOnceExtensionMethods
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use .iterator.withFilter(...) instead
def →[B](y: B): (StringBuilder, B)
Implicit
This member is added by an implicit conversion from StringBuilder toArrowAssoc[StringBuilder] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from java.io.Serializable

Inherited from CharSequence

Inherited from IndexedSeq[Char]

Inherited from IndexedSeqOps[Char, IndexedSeq, StringBuilder]

Packages

Package structure

Automatic imports

StringBuilder

Companion object StringBuilder

final class StringBuilder extends AbstractSeq[Char] with ReusableBuilder[Char, String] with IndexedSeq[Char] with IndexedSeqOps[Char, IndexedSeq, StringBuilder] with IterableFactoryDefaults[Char, IndexedSeq] with CharSequence with Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from java.io.Serializable

Inherited from CharSequence

Inherited from IndexedSeq[Char]

Inherited from IndexedSeqOps[Char, IndexedSeq, StringBuilder]

Inherited from collection.IndexedSeq[Char]

Inherited from collection.IndexedSeqOps[Char, [_]IndexedSeq[_], StringBuilder]

Inherited from ReusableBuilder[Char, String]

Inherited from Builder[Char, String]

Inherited from Growable[Char]

Inherited from Clearable

Inherited from AbstractSeq[Char]

Inherited from Seq[Char]

Inherited from SeqOps[Char, [_]IndexedSeq[_], StringBuilder]

Inherited from Cloneable[StringBuilder]

Inherited from java.lang.Cloneable

Inherited from Iterable[Char]

Inherited from collection.AbstractSeq[Char]

Inherited from collection.Seq[Char]

Inherited from Equals

Inherited from collection.SeqOps[Char, [_]IndexedSeq[_], StringBuilder]

Inherited from PartialFunction[Int, Char]

Inherited from (Int) => Char

Inherited from collection.AbstractIterable[Char]

Inherited from collection.Iterable[Char]

Inherited from IterableFactoryDefaults[Char, [x]IndexedSeq[x]]

Inherited from IterableOps[Char, [_]IndexedSeq[_], StringBuilder]

Inherited from IterableOnceOps[Char, [_]IndexedSeq[_], StringBuilder]

Inherited from IterableOnce[Char]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion iterableOnceExtensionMethods fromStringBuilder to IterableOnceExtensionMethods[Char]

Inherited by implicit conversion any2stringadd fromStringBuilder to any2stringadd[StringBuilder]

Inherited by implicit conversion StringFormat fromStringBuilder to StringFormat[StringBuilder]

Inherited by implicit conversion Ensuring fromStringBuilder to Ensuring[StringBuilder]

Inherited by implicit conversion ArrowAssoc fromStringBuilder to ArrowAssoc[StringBuilder]

Ungrouped

StringBuilder