final class StringBuilder extends AbstractSeq[Char] with CharSequence with IndexedSeq[Char] with StringLike[StringBuilder] with ReusableBuilder[Char, String] with Serializable
A builder for mutable sequence of characters. This class provides an API
mostly compatible with java.lang.StringBuilder
, except where there are
conflicts with the Scala collections API (such as the reverse
method.)
- Annotations
- @SerialVersionUID()
- Source
- StringBuilder.scala
- Version
2.8
- Since
2.7
- Alphabetic
- By Inheritance
- StringBuilder
- Serializable
- Serializable
- ReusableBuilder
- Builder
- Growable
- Clearable
- StringLike
- Ordered
- Comparable
- IndexedSeqOptimized
- IndexedSeq
- IndexedSeqLike
- IndexedSeq
- IndexedSeqLike
- CharSequence
- AbstractSeq
- Seq
- SeqLike
- Cloneable
- Cloneable
- Cloneable
- Iterable
- Traversable
- Mutable
- AbstractSeq
- Seq
- SeqLike
- GenSeq
- GenSeqLike
- PartialFunction
- Function1
- AbstractIterable
- Iterable
- IterableLike
- Equals
- GenIterable
- GenIterableLike
- AbstractTraversable
- Traversable
- GenTraversable
- GenericTraversableTemplate
- TraversableLike
- GenTraversableLike
- Parallelizable
- TraversableOnce
- GenTraversableOnce
- FilterMonadic
- HasNewBuilder
- AnyRef
- Any
- by SeqCharSequence
- by CollectionsHaveToParArray
- by MonadOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- by alternateImplicit
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
NegativeArraySizeException
if capacity < 0.
-
new
StringBuilder()
Constructs a string builder with no characters in it and an initial capacity of 16 characters.
-
new
StringBuilder(initCapacity: Int, initValue: String)
Constructs a string builder initialized with string value
initValue
and with additional character capacityinitCapacity
. - new StringBuilder(underlying: java.lang.StringBuilder)
Type Members
-
class
WithFilter extends FilterMonadic[A, Repr]
A class supporting filtered operations.
A class supporting filtered operations. Instances of this class are returned by method
withFilter
.- Definition Classes
- TraversableLike
Value Members
-
def
*(n: Int): String
Return the current string concatenated
n
times.Return the current string concatenated
n
times.- Definition Classes
- StringLike
-
def
+(x: Char): StringBuilder.this.type
!!! This should create a new sequence.
-
def
++[B >: Char, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the traversable collection is the most specific superclass encompassing the element types of the two operands.
- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
++:[B >: Char, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.It differs from
++
in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
This overload exists because: for the implementation of
++:
we should reuse that of++
because many collections override it with more efficient versions.Since
TraversableOnce
has no++
method, we have to implement that directly, butTraversable
and down can use the overload.- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- Definition Classes
- TraversableLike
-
def
++:[B](that: TraversableOnce[B]): IndexedSeq[B]
[use case] As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.[use case]As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.It differs from
++
in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
- B
the element type of the returned collection.
- that
the traversable to append.
- returns
a new string builder which contains all elements of this string builder followed by all elements of
that
.
- Definition Classes
- TraversableLike
Full Signaturedef ++:[B >: Char, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
++=(s: String): StringBuilder.this.type
Optimization.
-
def
++=(xs: TraversableOnce[Char]): StringBuilder.this.type
adds all elements produced by a TraversableOnce to this growable collection.
adds all elements produced by a TraversableOnce to this growable collection.
- xs
the TraversableOnce producing the elements to add.
- returns
the growable collection itself.
- Definition Classes
- Growable
-
def
+:(elem: A): IndexedSeq[A]
[use case] A copy of the string builder with an element prepended.
[use case]A copy of the string builder with an element prepended.
Note that :-ending operators are right associative (see example). A mnemonic for
+:
vs.:+
is: the COLon goes on the COLlection side.Also, the original string 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)
- elem
the prepended element
- returns
a new string builder consisting of
elem
followed by all elements of this string builder.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef +:[B >: Char, That](elem: B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
+=(x: Char): StringBuilder.this.type
Appends the given Char to the end of the sequence.
Appends the given Char to the end of the sequence.
- returns
the builder itself.
- Definition Classes
- StringBuilder → Builder → Growable
-
def
+=(elem1: Char, elem2: Char, elems: Char*): StringBuilder.this.type
adds two or more elements to this growable collection.
adds two or more elements to this growable collection.
- elem1
the first element to add.
- elem2
the second element to add.
- elems
the remaining elements to add.
- returns
the growable collection itself
- Definition Classes
- Growable
-
def
/:[B](z: B)(op: (B, Char) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note:
/:
is alternate syntax forfoldLeft
;z /: xs
is the same asxs foldLeft z
.Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (5 /: a)(_+_) b: Int = 15 scala> val c = (5 /: a)((x,y) => x + y) c: Int = 15
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:op(...op(op(z, x_1), x_2), ..., x_n)
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
:+(elem: A): IndexedSeq[A]
[use case] A copy of this string builder with an element appended.
[use case]A copy of this string builder with an element appended.
A mnemonic for
+:
vs.:+
is: the COLon goes on the COLlection side.Example:
scala> val a = List(1) a: List[Int] = List(1) scala> val b = a :+ 2 b: List[Int] = List(1, 2) scala> println(a) List(1)
- elem
the appended element
- returns
a new string builder consisting of all elements of this string builder followed by
elem
.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef :+[B >: Char, That](elem: B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
:\[B](z: B)(op: (Char, B) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note:
:\
is alternate syntax forfoldRight
;xs :\ z
is the same asxs foldRight z
.Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (a :\ 5)(_+_) b: Int = 15 scala> val c = (a :\ 5)((x,y) => x + y) c: Int = 15
- B
the result type of the binary operator.
- z
the start value
- op
the binary operator
- returns
the result of inserting
op
between consecutive elements of this traversable or iterator, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
<(that: String): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
- Definition Classes
- Ordered
-
def
<=(that: String): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
.- Definition Classes
- Ordered
-
def
>(that: String): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
.- Definition Classes
- Ordered
-
def
>=(that: String): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
.- Definition Classes
- Ordered
-
def
addString(b: scala.StringBuilder): scala.StringBuilder
Appends all elements of this traversable or iterator to a string builder.
Appends all elements of this traversable or iterator to a string builder. The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator without any separator string.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> val h = a.addString(b) h: StringBuilder = 1234
- b
the string builder to which elements are appended.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
-
def
addString(b: scala.StringBuilder, sep: String): scala.StringBuilder
Appends all elements of this traversable or iterator to a string builder using a separator string.
Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator, separated by the stringsep
.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b, ", ") res0: StringBuilder = 1, 2, 3, 4
- b
the string builder to which elements are appended.
- sep
the separator string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
-
def
addString(b: scala.StringBuilder, start: String, sep: String, end: String): scala.StringBuilder
Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings.
Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this traversable or iterator are separated by the stringsep
.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b , "List(" , ", " , ")") res5: StringBuilder = List(1, 2, 3, 4)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
-
def
aggregate[B](z: ⇒ B)(seqop: (B, Char) ⇒ B, combop: (B, B) ⇒ B): B
Aggregates the results of applying an operator to subsequent elements.
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of
fold
andreduce
. It is similar tofoldLeft
in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.aggregate
splits the traversable or iterator into partitions and processes each partition by sequentially applyingseqop
, starting withz
(likefoldLeft
). Those intermediate results are then combined by usingcombop
(likefold
). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), socombop
may be invoked an arbitrary number of times (even 0).As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First,
seqop
transforms each input character to an Int and adds it to the sum (of the partition). Then,combop
just needs to sum up the intermediate results of the partitions:List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
- B
the type of accumulated results
- z
the initial value for the accumulated result of the partition - this will typically be the neutral element for the
seqop
operator (e.g.Nil
for list concatenation or0
for summation) and may be evaluated more than once- seqop
an operator used to accumulate results within a partition
- combop
an associative operator used to combine results from different partitions
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
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.
- C
the result type of the transformation function.
- k
the transformation function
- returns
a partial function with the same domain as this partial function, which maps arguments
x
tok(this(x))
.
- Definition Classes
- PartialFunction → Function1
- def append(x: Char): StringBuilder
- def append(x: Double): StringBuilder
- def append(x: Float): StringBuilder
- def append(x: Long): StringBuilder
- def append(x: Int): StringBuilder
- def append(x: Short): StringBuilder
- def append(x: Byte): StringBuilder
-
def
append(x: Boolean): StringBuilder
Append the String representation of the given primitive type to this sequence.
Append the String representation of the given primitive type to this sequence. The argument is converted to a String with String.valueOf.
- x
a primitive value
- returns
This StringBuilder.
-
def
append(sb: StringBuilder): StringBuilder
Appends the specified string builder to this sequence.
-
def
append(s: String): StringBuilder
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
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
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
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: TraversableOnce[Char]): StringBuilder
Appends all the Chars in the given Seq[Char] to this sequence.
Appends all the Chars in the given Seq[Char] to this sequence.
- xs
the characters to be appended.
- returns
this StringBuilder.
- def appendAll(xs: String): StringBuilder
-
def
apply(index: Int): Char
Equivalent to charAt.
Equivalent to charAt.
- returns
the element of this string builder at index
idx
, where0
indicates the first element.
- Definition Classes
- StringBuilder → StringLike → SeqLike → GenSeqLike → 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 toif(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 anapplyOrElse
implementation which avoids double evaluation of pattern matchers and guards. This makesapplyOrElse
the basis for the efficient implementation for many operations and scenarios, such as:- combining partial functions into
orElse
/andThen
chains does not lead to excessiveapply
/isDefinedAt
evaluation lift
andunlift
do not evaluate source functions twice on each invocationrunWith
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 overrideapplyOrElse
with custom implementation that avoids doubleisDefinedAt
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
- Since
2.10
- combining partial functions into
-
def
canEqual(that: Any): Boolean
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
- that
The object with which this iterable collection should be compared
- returns
true
, if this iterable collection can possibly equalthat
,false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
- Definition Classes
- IterableLike → 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
capitalize: String
Returns this string with first character converted to upper case.
Returns this string with first character converted to upper case. If the first character of the string is capitalized, it is returned unchanged. This method does not convert characters outside the Basic Multilingual Plane (BMP).
- Definition Classes
- StringLike
-
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
clear(): Unit
Clears the builder contents.
Clears the builder contents.
- Definition Classes
- StringBuilder → ReusableBuilder → Builder → Growable → 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
- StringBuilder → Cloneable → AnyRef
- Note
not specified by SLS as a member of AnyRef
-
def
codePoints(): IntStream
- Definition Classes
- CharSequence
-
def
collect[B](pf: PartialFunction[A, B]): IndexedSeq[B]
[use case] Builds a new collection by applying a partial function to all elements of this string builder on which the function is defined.
[use case]Builds a new collection 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 collection.
- 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
- TraversableLike → GenTraversableLike
Full Signaturedef collect[B, That](pf: PartialFunction[Char, B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
collectFirst[B](pf: PartialFunction[Char, B]): Option[B]
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- pf
the partial function
- returns
an option value containing pf applied to the first value for which it is defined, or
None
if none exists.
- Definition Classes
- TraversableOnce
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Example: -
def
combinations(n: Int): Iterator[StringBuilder]
Iterates over combinations.
Iterates over combinations. A _combination_ of length
n
is a subsequence of the original sequence, with the elements taken in order. Thus,"xy"
and"yy"
are both length-2 combinations of"xyy"
, but"yx"
is not. If there is more than one way to generate the same subsequence, only one will be returned.For example,
"xyyy"
has three different ways to generate"xy"
depending on whether the first, second, or third"y"
is selected. However, since all are identical, only one will be chosen. Which of the three will be taken is an implementation detail that is not defined.- returns
An Iterator which traverses the possible n-element combinations of this sequence.
- Definition Classes
- SeqLike
"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)
Example: -
def
companion: GenericCompanion[IndexedSeq]
The factory companion object that builds instances of class
IndexedSeq
.The factory companion object that builds instances of class
IndexedSeq
. (or itsIterable
superclass where classIndexedSeq
is not aSeq
.)- Definition Classes
- IndexedSeq → IndexedSeq → Seq → Seq → GenSeq → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate
-
def
compare(other: String): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.Implement this method to determine how instances of A will be sorted.
Returns
x
where:x < 0
whenthis < that
x == 0
whenthis == that
x > 0
whenthis > that
- Definition Classes
- StringLike → Ordered
-
def
compareTo(that: String): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.- Definition Classes
- Ordered → Comparable
-
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 thatf(x) == apply(g(x))
- Definition Classes
- Function1
- Annotations
- @unspecialized()
-
def
contains[A1 >: Char](elem: A1): Boolean
Tests whether this sequence contains a given value as an element.
Tests whether this sequence contains a given value as an element.
Note: may not terminate for infinite-sized collections.
- elem
the element to test.
- returns
true
if this sequence has an element that is equal (as determined by==
) toelem
,false
otherwise.
- Definition Classes
- SeqLike
-
def
containsSlice[B](that: GenSeq[B]): Boolean
Tests whether this sequence contains a given sequence as a slice.
Tests whether this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
the sequence to test
- returns
true
if this sequence contains a slice with the same elements asthat
, otherwisefalse
.
- Definition Classes
- SeqLike
-
def
copyToArray(xs: Array[A], start: Int, len: Int): Unit
[use case] Copies the elements of this string builder to an array.
[use case]Copies the elements of this string builder to an array. Fills the given array
xs
with at mostlen
elements of this string builder, starting at positionstart
. Copying will stop once either the end of the current string builder is reached, or the end of the target array is reached, orlen
elements have been copied.- xs
the array to fill.
- start
the starting index.
- len
the maximal number of elements to copy.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
copyToArray(xs: Array[A]): Unit
[use case] Copies the elements of this string builder to an array.
[use case]Copies the elements of this string builder to an array. Fills the given array
xs
with values of this string builder. Copying will stop once either the end of the current string builder is reached, or the end of the target array is reached.- xs
the array to fill.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToArray(xs: Array[A], start: Int): Unit
[use case] Copies the elements of this string builder to an array.
[use case]Copies the elements of this string builder to an array. Fills the given array
xs
with values of this string builder, beginning at indexstart
. Copying will stop once either the end of the current string builder is reached, or the end of the target array is reached.- xs
the array to fill.
- start
the starting index.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToBuffer[B >: Char](dest: Buffer[B]): Unit
Copies all elements of this traversable or iterator to a buffer.
Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite-sized collections.
- dest
The buffer to which elements are copied.
- Definition Classes
- TraversableOnce
-
def
corresponds[B](that: GenSeq[B])(p: (Char, B) ⇒ Boolean): Boolean
Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate.
Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate.
- B
the type of the elements of
that
- that
the other sequence
- p
the test predicate, which relates elements from both sequences
- returns
true
if both sequences have the same length andp(x, y)
istrue
for all corresponding elementsx
of this sequence andy
ofthat
, otherwisefalse
.
- Definition Classes
- SeqLike → GenSeqLike
-
def
count(p: (Char) ⇒ Boolean): Int
Counts the number of elements in the traversable or iterator which satisfy a predicate.
Counts the number of elements in the traversable or iterator which satisfy a predicate.
- p
the predicate used to test elements.
- returns
the number of elements satisfying the predicate
p
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
delete(start: Int, end: Int): StringBuilder
Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.
Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.
- 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
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(that: collection.Seq[Char]): IndexedSeq[Char]
[use case] Computes the multiset difference between this string builder and another sequence.
[use case]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 valuex
appears n times inthat
, then the first n occurrences ofx
will not form part of the result, but any following occurrences will.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef diff[B >: Char](that: GenSeq[B]): StringBuilder
-
def
distinct: StringBuilder
Builds a new sequence from this sequence without any duplicate elements.
Builds a new sequence from this sequence without any duplicate elements.
Note: will not terminate for infinite-sized collections.
- returns
A new sequence which contains the first occurrence of every element of this sequence.
- Definition Classes
- SeqLike → GenSeqLike
-
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 sequence.
- returns
a sequence consisting of all elements of this sequence except the first
n
ones, or else the empty sequence, if this sequence has less thann
elements. Ifn
is negative, don't drop any elements.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
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 take
- returns
a sequence consisting of all elements of this sequence except the last
n
ones, or else the empty sequence, if this sequence has less thann
elements.
- Definition Classes
- IndexedSeqOptimized → IterableLike
-
def
dropWhile(p: (Char) ⇒ Boolean): StringBuilder
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
- returns
the longest suffix of this sequence whose first element does not satisfy the predicate
p
.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
endsWith[B](that: GenSeq[B]): Boolean
Tests whether this sequence ends with the given sequence.
Tests whether this sequence ends with the given sequence.
- that
the sequence to test
- returns
true
if this sequence hasthat
as a suffix,false
otherwise.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
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
equals(that: Any): Boolean
The equals method for arbitrary sequences.
The equals method for arbitrary sequences. Compares this sequence to some other object.
- that
The object to compare the sequence to
- returns
true
ifthat
is a sequence that has the same elements as this sequence in the same order,false
otherwise
- Definition Classes
- GenSeqLike → Equals → Any
-
def
exists(p: (Char) ⇒ Boolean): Boolean
Tests whether a predicate holds for at least one element of this sequence.
Tests whether a predicate holds for at least one element of this sequence.
- p
the predicate used to test elements.
- returns
false
if this sequence is empty, otherwisetrue
if the given predicatep
holds for some of the elements of this sequence, otherwisefalse
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
filter(p: (Char) ⇒ Boolean): StringBuilder
Selects all elements of this traversable collection which satisfy a predicate.
Selects all elements of this traversable collection which satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new traversable collection consisting of all elements of this traversable collection that satisfy the given predicate
p
. The order of the elements is preserved.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
filterNot(p: (Char) ⇒ Boolean): StringBuilder
Selects all elements of this traversable collection which do not satisfy a predicate.
Selects all elements of this traversable collection which do not satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given predicate
p
. The order of the elements is preserved.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
find(p: (Char) ⇒ Boolean): Option[Char]
Finds the first element of the sequence satisfying a predicate, if any.
Finds the first element of the sequence satisfying a predicate, if any.
- p
the predicate used to test elements.
- returns
an option value containing the first element in the sequence that satisfies
p
, orNone
if none exists.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): IndexedSeq[B]
[use case] Builds a new collection by applying a function to all elements of this string builder and using the elements of the resulting collections.
[use case]Builds a new collection 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 => 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
- TraversableLike → GenTraversableLike → FilterMonadic
Full Signaturedef flatMap[B, That](f: (Char) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
flatten[B]: IndexedSeq[B]
[use case] Converts this string builder of traversable collections into a string builder formed by the elements of these traversable collections.
[use case]Converts this string builder of traversable collections into a string builder formed by the elements of these traversable collections.
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(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 traversable collection.
- returns
a new string builder resulting from concatenating all element string builders.
- Definition Classes
- GenericTraversableTemplate
Full Signaturedef flatten[B](implicit asTraversable: (Char) ⇒ GenTraversableOnce[B]): IndexedSeq[B]
-
def
fold[A1 >: Char](z: A1)(op: (A1, A1) ⇒ A1): A1
Folds the elements of this traversable or iterator using the specified associative binary operator.
Folds the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- A1
a type parameter for the binary operator, a supertype of
A
.- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).- op
a binary operator that must be associative.
- returns
the result of applying the fold operator
op
between all the elements andz
, orz
if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldLeft[B](z: B)(op: (B, Char) ⇒ B): B
Applies a binary operator to a start value and all elements of this sequence, going left to right.
Applies a binary operator to a start value and all elements of this sequence, going left to right.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this sequence, going left to right with the start valuez
on the left:op(...op(z, x_1), x_2, ..., x_n)
where
x1, ..., xn
are the elements of this sequence. Returnsz
if this sequence is empty.
- Definition Classes
- IndexedSeqOptimized → TraversableOnce → GenTraversableOnce
-
def
foldRight[B](z: B)(op: (Char, B) ⇒ B): B
Applies a binary operator to all elements of this sequence and a start value, going right to left.
Applies a binary operator to all elements of this sequence and a start value, going right to left.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this sequence, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this sequence. Returnsz
if this sequence is empty.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
-
def
forall(p: (Char) ⇒ Boolean): Boolean
Tests whether a predicate holds for all elements of this sequence.
Tests whether a predicate holds for all elements of this sequence.
- p
the predicate used to test elements.
- returns
true
if this sequence is empty or the given predicatep
holds for all elements of this sequence, otherwisefalse
.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
foreach(f: (A) ⇒ Unit): Unit
[use case] Applies a function
f
to all elements of this string builder.[use case]Applies a function
f
to all elements of this string builder.Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
- f
the function that is applied for its side-effect to every element. The result of function
f
is discarded.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
-
def
format(args: Any*): String
Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.
Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.
The interpretation of the formatting patterns is described in java.util.Formatter, with the addition that classes deriving from
ScalaNumber
(such as scala.BigInt and scala.BigDecimal) are unwrapped to pass a type whichFormatter
understands.- args
the arguments used to instantiating the pattern.
- Definition Classes
- StringLike
- Exceptions thrown
-
def
formatLocal(l: Locale, args: Any*): String
Like
format(args*)
but takes an initialLocale
parameter which influences formatting as injava.lang.String
's format.Like
format(args*)
but takes an initialLocale
parameter which influences formatting as injava.lang.String
's format.The interpretation of the formatting patterns is described in java.util.Formatter, with the addition that classes deriving from
ScalaNumber
(such asscala.BigInt
andscala.BigDecimal
) are unwrapped to pass a type whichFormatter
understands.- l
an instance of
java.util.Locale
- args
the arguments used to instantiating the pattern.
- Definition Classes
- StringLike
- Exceptions thrown
-
def
genericBuilder[B]: Builder[B, IndexedSeq[B]]
The generic builder that builds instances of Traversable at arbitrary element types.
The generic builder that builds instances of Traversable at arbitrary element types.
- Definition Classes
- GenericTraversableTemplate
-
def
groupBy[K](f: (Char) ⇒ K): immutable.Map[K, StringBuilder]
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.
- K
the type of keys returned by the discriminator function.
- f
the discriminator function.
- returns
A map from keys to traversable collections such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)
That is, every key
k
is bound to a traversable collection of those elementsx
for whichf(x)
equalsk
.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
grouped(size: Int): Iterator[StringBuilder]
Partitions elements in fixed size iterable collections.
Partitions elements in fixed size iterable collections.
- size
the number of elements per group
- returns
An iterator producing iterable collections of size
size
, except the last will be less than sizesize
if the elements don't divide evenly.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
grouped
-
def
hasDefiniteSize: Boolean
Tests whether this traversable collection is known to have a finite size.
Tests whether this traversable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as
Stream
, the predicate returnstrue
if all elements have been computed. It returnsfalse
if the stream is not yet evaluated to the end. Non-empty Iterators usually returnfalse
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
returnstrue
. However, checkinghasDefiniteSize
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
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
hashCode(): Int
Hashcodes for IndexedSeq produce a value from the hashcodes of all the elements of the sequence.
Hashcodes for IndexedSeq produce a value from the hashcodes of all the elements of the sequence.
- returns
the hash code value for this object.
- Definition Classes
- IndexedSeqLike → GenSeqLike → Any
-
def
head: Char
Selects the first element of this sequence.
Selects the first element of this sequence.
- returns
the first element of this sequence.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
if the sequence is empty.
-
def
headOption: Option[Char]
Optionally selects the first element.
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the first element of this traversable collection if it is nonempty,
None
if it is empty.
- Definition Classes
- TraversableLike → GenTraversableLike
-
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(elem: Char, from: Int): Int
[use case] Finds index of first occurrence of some value in this string builder after or at some start index.
[use case]Finds index of first occurrence of some value in this string builder after or at some start index.
- elem
the element value to search for.
- from
the start index
- returns
the index
>= from
of the first element of this string builder that is equal (as determined by==
) toelem
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
indexOf(elem: Char): Int
[use case] Finds index of first occurrence of some value in this string builder.
[use case]Finds index of first occurrence of some value in this string builder.
- elem
the element value to search for.
- returns
the index of the first element of this string builder that is equal (as determined by
==
) toelem
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
indexOfSlice[B >: Char](that: GenSeq[B], from: Int): Int
Finds first index after or at a start index where this sequence contains a given sequence as a slice.
Finds first index after or at a start index where this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
the sequence to test
- from
the start index
- returns
the first index
>= from
such that the elements of this sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- Definition Classes
- SeqLike
-
def
indexOfSlice[B >: Char](that: GenSeq[B]): Int
Finds first index where this sequence contains a given sequence as a slice.
Finds first index where this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
the sequence to test
- returns
the first index such that the elements of this sequence starting at this index match the elements of sequence
that
, or-1
of no such subsequence exists.
- Definition Classes
- SeqLike
-
def
indexWhere(p: (Char) ⇒ Boolean, from: Int): Int
Finds index of the first element satisfying some predicate after or at some start index.
Finds index of the first element satisfying some predicate after or at some start index.
- p
the predicate used to test elements.
- from
the start index
- returns
the index
>= from
of the first element of this sequence that satisfies the predicatep
, or-1
, if none exists.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
indexWhere(p: (Char) ⇒ Boolean): Int
Finds index of first element satisfying some predicate.
Finds index of first element satisfying some predicate.
Note: may not terminate for infinite-sized collections.
- p
the predicate used to test elements.
- returns
the index of the first element of this general sequence that satisfies the predicate
p
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
indices: immutable.Range
Produces the range of all indices of this sequence.
Produces the range of all indices of this sequence.
- returns
a
Range
value from0
to one less than the length of this sequence.
- Definition Classes
- SeqLike
-
def
init: StringBuilder
Selects all elements except the last.
Selects all elements except the last.
- returns
a sequence consisting of all elements of this sequence except the last one.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
UnsupportedOperationException
if the sequence is empty.
-
def
inits: Iterator[StringBuilder]
Iterates over the inits of this traversable collection.
Iterates over the inits of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of
init
.- returns
an iterator over all the inits of this traversable collection
- Definition Classes
- TraversableLike
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Example: - def insert(index: Int, x: Char): StringBuilder
- def insert(index: Int, x: Double): StringBuilder
- def insert(index: Int, x: Float): StringBuilder
- def insert(index: Int, x: Long): StringBuilder
- def insert(index: Int, x: Int): StringBuilder
- def insert(index: Int, x: Short): StringBuilder
- def insert(index: Int, x: Byte): StringBuilder
-
def
insert(index: Int, x: Boolean): StringBuilder
Calls String.valueOf on the given primitive value, and inserts the String at the given index.
Calls String.valueOf on the given primitive value, and inserts the String at the given index.
- index
the offset position.
- x
a primitive value.
- returns
this StringBuilder.
-
def
insert(index: Int, x: String): StringBuilder
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
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
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: TraversableOnce[Char]): StringBuilder
Inserts the given Seq[Char] into this sequence at the given index.
Inserts the given Seq[Char] into this sequence at the given index.
- 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
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(that: collection.Seq[Char]): IndexedSeq[Char]
[use case] Computes the multiset intersection between this string builder and another sequence.
[use case]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 valuex
appears n times inthat
, then the first n occurrences ofx
will be retained in the result, but any following occurrences will be omitted.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef intersect[B >: Char](that: GenSeq[B]): StringBuilder
-
def
isDefinedAt(idx: Int): Boolean
Tests whether this general sequence contains given index.
Tests whether this general sequence contains given index.
The implementations of methods
apply
andisDefinedAt
turn aSeq[A]
into aPartialFunction[Int, A]
.- idx
the index to test
- returns
true
if this general sequence contains an element at positionidx
,false
otherwise.
- Definition Classes
- GenSeqLike
-
def
isEmpty: Boolean
Tests whether this sequence is empty.
Tests whether this sequence is empty.
- returns
true
if the sequence contain no elements,false
otherwise.
- Definition Classes
- IndexedSeqOptimized → SeqLike → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
final
def
isTraversableAgain: Boolean
Tests whether this traversable collection can be repeatedly traversed.
Tests whether this traversable collection can be repeatedly traversed.
- returns
true
- Definition Classes
- TraversableLike → GenTraversableLike → GenTraversableOnce
-
def
iterator: Iterator[Char]
Creates a new iterator over all elements contained in this iterable object.
Creates a new iterator over all elements contained in this iterable object.
- returns
the new iterator
- Definition Classes
- IndexedSeqLike → IterableLike → GenIterableLike
-
def
last: Char
Selects the last element.
Selects the last element.
- returns
The last element of this sequence.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
If the sequence 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(elem: Char, end: Int): Int
[use case] Finds index of last occurrence of some value in this string builder before or at a given end index.
[use case]Finds index of last occurrence of some value in this string builder before or at a given end index.
- elem
the element value to search for.
- end
the end index.
- returns
the index
<= end
of the last element of this string builder that is equal (as determined by==
) toelem
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
lastIndexOf(elem: Char): Int
[use case] Finds index of last occurrence of some value in this string builder.
[use case]Finds index of last occurrence of some value in this string builder.
- elem
the element value to search for.
- returns
the index of the last element of this string builder that is equal (as determined by
==
) toelem
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
lastIndexOfSlice[B >: Char](that: GenSeq[B], end: Int): Int
Finds last index before or at a given end index where this sequence contains a given sequence as a slice.
Finds last index before or at a given end index where this sequence contains a given sequence as a slice.
- that
the sequence to test
- end
the end index
- returns
the last index
<= end
such that the elements of this sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- Definition Classes
- SeqLike
-
def
lastIndexOfSlice[B >: Char](that: GenSeq[B]): Int
Finds last index where this sequence contains a given sequence as a slice.
Finds last index where this sequence contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
- that
the sequence to test
- returns
the last index such that the elements of this sequence starting a this index match the elements of sequence
that
, or-1
of no such subsequence exists.
- Definition Classes
- SeqLike
-
def
lastIndexWhere(p: (Char) ⇒ Boolean, end: Int): Int
Finds index of last element satisfying some predicate before or at given end index.
Finds index of last element satisfying some predicate before or at given end index.
- p
the predicate used to test elements.
- returns
the index
<= end
of the last element of this sequence that satisfies the predicatep
, or-1
, if none exists.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
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 general sequence that satisfies the predicate
p
, or-1
, if none exists.
- Definition Classes
- GenSeqLike
-
def
lastOption: Option[Char]
Optionally selects the last element.
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the last element of this traversable collection$ if it is nonempty,
None
if it is empty.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
length: Int
The length of the string builder.
The length of the string builder.
Note:
xs.length
andxs.size
yield the same result.- returns
the number of elements in this string builder.
- Definition Classes
- StringBuilder → StringLike → CharSequence → SeqLike → GenSeqLike
- Exceptions thrown
IllegalArgumentException
if the length of the sequence cannot be represented in anInt
, for example,(-1 to Int.MaxValue).length
.
-
def
lengthCompare(len: Int): Int
Compares the length of this sequence to a test value.
Compares the length of this sequence to a test value.
- len
the test value that gets compared with the length.
- returns
A value
x
wherex < 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 isO(length min len)
instead ofO(length)
. The method should be overwritten if computinglength
is cheap.
- Definition Classes
- IndexedSeqOptimized → SeqLike
- 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
toSome(this(x))
ifthis
is defined forx
, and toNone
otherwise.
- Definition Classes
- PartialFunction
- See also
Function.unlift
-
def
lines: Iterator[String]
Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply
.stripLineEnd
to all lines returned bylinesWithSeparators
.Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply
.stripLineEnd
to all lines returned bylinesWithSeparators
.- Definition Classes
- StringLike
-
def
linesWithSeparators: Iterator[String]
Return all lines in this string in an iterator, including trailing line end characters.
Return all lines in this string in an iterator, including trailing line end characters.
This method is analogous to
s.split(EOL).toIterator
, except that any existing line endings are preserved in the result strings, and the empty string yields an empty iterator.A line end character is one of
LF
- line feed (0x0A
)FF
- form feed (0x0C
)
- Definition Classes
- StringLike
-
def
map[B](f: (A) ⇒ B): IndexedSeq[B]
[use case] Builds a new collection by applying a function to all elements of this string builder.
[use case]Builds a new collection by applying a function to all elements of this string builder.
- 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 function
f
to each element of this string builder and collecting the results.
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
Full Signaturedef map[B, That](f: (Char) ⇒ B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
mapResult[NewTo](f: (String) ⇒ NewTo): Builder[Char, NewTo]
Creates a new builder by applying a transformation function to the results of this builder.
Creates a new builder by applying a transformation function to the results of this builder.
- NewTo
the type of collection returned by
f
.- f
the transformation function.
- returns
a new builder which is the same as the current builder except that a transformation function is applied to this builder's result.
- Definition Classes
- Builder
- Note
The original builder should no longer be used after
mapResult
is called.
-
def
max: A
[use case] Finds the largest element.
[use case]Finds the largest element.
- returns
the largest element of this string builder.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this string builder is empty.
-
def
maxBy[B](f: (A) ⇒ B): A
[use case] Finds the first element which yields the largest value measured by function f.
[use case]Finds the first element which yields the largest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this string builder with the largest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this string builder is empty.
-
def
min: A
[use case] Finds the smallest element.
[use case]Finds the smallest element.
- returns
the smallest element of this string builder
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this string builder is empty.
-
def
minBy[B](f: (A) ⇒ B): A
[use case] Finds the first element which yields the smallest value measured by function f.
[use case]Finds the first element which yields the smallest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this string builder with the smallest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this string builder is empty.
-
def
mkString: String
Returns a new String representing the data in this sequence.
Returns a new String representing the data in this sequence.
- returns
the current contents of this sequence as a String
- Definition Classes
- StringBuilder → StringLike → TraversableOnce → GenTraversableOnce
-
def
mkString(sep: String): String
Displays all elements of this traversable or iterator in a string using a separator string.
Displays all elements of this traversable or iterator in a string using a separator string.
- sep
the separator string.
- returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("|") = "1|2|3"
Example: -
def
mkString(start: String, sep: String, end: String): String
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
a string representation of this traversable or iterator. The resulting string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Example: -
def
nonEmpty: Boolean
Tests whether the traversable or iterator is not empty.
Tests whether the traversable or iterator is not empty.
- returns
true
if the traversable or iterator contains at least one element,false
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
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 takesx
tothis(x)
wherethis
is defined, and tothat(x)
where it is not.
- Definition Classes
- PartialFunction
-
def
padTo(len: Int, elem: A): IndexedSeq[A]
[use case] A copy of this string builder with an element value appended until a given target length is reached.
[use case]A copy of this string builder with an element value appended until a given target length is reached.
- 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 string builder has a length of at leastlen
.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef padTo[B >: Char, That](len: Int, elem: B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
par: ParSeq[Char]
Returns a parallel implementation of this collection.
Returns a parallel implementation of this collection.
For most collection types, this method creates a new parallel collection by copying all the elements. For these collection,
par
takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.Specific collections (e.g.
ParArray
ormutable.ParHashMap
) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections,par
takes constant or sublinear time.All parallel collections return a reference to themselves.
- returns
a parallel implementation of this collection
- Definition Classes
- Parallelizable
-
def
partition(p: (Char) ⇒ Boolean): (StringBuilder, StringBuilder)
Partitions this traversable collection in two traversable collections according to a predicate.
Partitions this traversable collection in two traversable collections according to a predicate.
- p
the predicate on which to partition.
- returns
a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate
p
and the second traversable collection consists of all elements that don't. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
patch(from: Int, that: GenSeq[A], replaced: Int): IndexedSeq[A]
[use case] Produces a new string builder where a slice of elements in this string builder is replaced by another sequence.
[use case]Produces a new string builder where a slice of elements in this string builder is replaced by another sequence.
- from
the index of the first replaced element
- 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 fromfrom
are replaced bypatch
.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef patch[B >: Char, That](from: Int, patch: GenSeq[B], replaced: Int)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
permutations: Iterator[StringBuilder]
Iterates over distinct permutations.
Iterates over distinct permutations.
- returns
An Iterator which traverses the distinct permutations of this sequence.
- Definition Classes
- SeqLike
"abb".permutations = Iterator(abb, bab, bba)
Example: -
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 general sequence such that every element of the segment satisfies the predicate
p
.
- Definition Classes
- GenSeqLike
-
def
product: A
[use case] Multiplies up the elements of this collection.
[use case]Multiplies up the elements of this collection.
- returns
the product of all elements in this string builder of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the string builder and as result type ofproduct
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
r(groupNames: String*): Regex
You can follow a string with
.r(g1, ... , gn)
, turning it into aRegex
, with group names g1 through gn.You can follow a string with
.r(g1, ... , gn)
, turning it into aRegex
, with group names g1 through gn."""(\d\d)-(\d\d)-(\d\d\d\d)""".r("month", "day", "year")
matches dates and provides its subcomponents through groups named "month", "day" and "year".- groupNames
The names of the groups in the pattern, in the order they appear.
- Definition Classes
- StringLike
-
def
r: Regex
You can follow a string with
.r
, turning it into aRegex
.You can follow a string with
.r
, turning it into aRegex
. E.g."""A\w*""".r
is the regular expression for identifiers starting withA
.- Definition Classes
- StringLike
-
def
reduce[A1 >: Char](op: (A1, A1) ⇒ A1): A1
Reduces the elements of this traversable or iterator using the specified associative binary operator.
Reduces the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
The result of applying reduce operator
op
between all the elements if the traversable or iterator is nonempty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
-
def
reduceLeft[B >: Char](op: (B, Char) ⇒ B): B
Applies a binary operator to all elements of this sequence, going left to right.
Applies a binary operator to all elements of this sequence, going left to right.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this sequence, going left to right:op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
where
x1, ..., xn
are the elements of this sequence.
- Definition Classes
- IndexedSeqOptimized → TraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this sequence is empty.
-
def
reduceLeftOption[B >: Char](op: (B, Char) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceLeft(op)
if this traversable or iterator is nonempty,None
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceOption[A1 >: Char](op: (A1, A1) ⇒ A1): Option[A1]
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRight[B >: Char](op: (Char, B) ⇒ B): B
Applies a binary operator to all elements of this sequence, going right to left.
Applies a binary operator to all elements of this sequence, going right to left.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this sequence, going right to left:op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
where
x1, ..., xn
are the elements of this sequence.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this sequence is empty.
-
def
reduceRightOption[B >: Char](op: (Char, B) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceRight(op)
if this traversable or iterator is nonempty,None
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
replace(start: Int, end: Int, str: String): StringBuilder
Replaces a subsequence of Chars with the given String.
Replaces a subsequence of Chars with the given String. The semantics are as in delete, with the String argument then inserted at index 'start'.
- 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
replaceAllLiterally(literal: String, replacement: String): String
Replace all literal occurrences of
literal
with the literal stringreplacement
.Replace all literal occurrences of
literal
with the literal stringreplacement
. This method is equivalent to java.lang.String#replace.- literal
the string which should be replaced everywhere it occurs
- replacement
the replacement string
- returns
the resulting string
- Definition Classes
- StringLike
-
def
repr: StringBuilder
The collection of type traversable collection underlying this
TraversableLike
object.The collection of type traversable collection underlying this
TraversableLike
object. By default this is implemented as theTraversableLike
object itself, but this can be overridden.- Definition Classes
- TraversableLike → GenTraversableLike
-
def
result(): String
Returns the result of this Builder (a String).
Returns the result of this Builder (a String).
If this method is called multiple times, each call will result in a snapshot of the buffer at that point in time. In particular, a
StringBuilder
can be used to build multiple independent strings by emptying the buffer withclear
after each call toresult
.- returns
the string assembled by this StringBuilder
- Definition Classes
- StringBuilder → ReusableBuilder → Builder
-
def
reverse: StringBuilder
Creates a new StringBuilder with the reversed contents of this one.
Creates a new StringBuilder with the reversed contents of this one. If surrogate pairs are present, they are treated as indivisible units: each pair will appear in the same order in the updated sequence.
- returns
the reversed StringBuilder
- Definition Classes
- StringBuilder → IndexedSeqOptimized → SeqLike → GenSeqLike
- Annotations
- @migration
- Migration
(Changed in version 2.8.0)
reverse
returns a new instance. UsereverseContents
to update in place and return that StringBuilder itself.
-
def
reverseContents(): StringBuilder
Like reverse, but destructively updates the target StringBuilder.
Like reverse, but destructively updates the target StringBuilder.
- returns
the reversed StringBuilder (same as the target StringBuilder)
-
def
reverseIterator: Iterator[Char]
An iterator yielding elements in reversed order.
An iterator yielding elements in reversed order.
Note:
xs.reverseIterator
is the same asxs.reverse.iterator
but might be more efficient.- returns
an iterator yielding the elements of this sequence in reversed order
- Definition Classes
- IndexedSeqOptimized → SeqLike
-
def
reverseMap[B](f: (A) ⇒ B): IndexedSeq[B]
[use case] Builds a new collection by applying a function to all elements of this string builder and collecting the results in reversed order.
[use case]Builds a new collection by applying a function to all elements of this string builder and collecting the results in reversed order.
Note:
xs.reverseMap(f)
is the same asxs.reverse.map(f)
but might be more efficient.- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new string builder resulting from applying the given function
f
to each element of this string builder and collecting the results in reversed order.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef reverseMap[B, That](f: (Char) ⇒ B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
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 toif(pf isDefinedAt x) { action(pf(x)); true } else false
except that
runWith
is implemented viaapplyOrElse
and thus potentially more efficient. UsingrunWith
avoids double evaluation of pattern matchers and guards for partial function literals.- action
the action function
- returns
a function which maps arguments
x
toisDefinedAt(x)
. The resulting function runsaction(this(x))
wherethis
is defined.
- Definition Classes
- PartialFunction
- Since
2.10
- See also
applyOrElse
.
-
def
sameElements(that: GenIterable[A]): Boolean
[use case] Checks if the other iterable collection contains the same elements in the same order as this string builder.
[use case]Checks if the other iterable collection contains the same elements in the same order as this string builder.
- that
the collection to compare with.
- returns
true
, if both collections contain the same elements in the same order,false
otherwise.
- Definition Classes
- IndexedSeqOptimized → IterableLike → GenIterableLike
Full Signaturedef sameElements[B >: Char](that: GenIterable[B]): Boolean
-
def
scan[B >: Char, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[StringBuilder, B, That]): That
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element
z
may be applied more than once.- B
element type of the resulting collection
- That
type of the resulting collection
- z
neutral element for the operator
op
- op
the associative operator for the scan
- cbf
combiner factory which provides a combiner
- returns
a new traversable collection containing the prefix scan of the elements in this traversable collection
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanLeft[B, That](z: B)(op: (B, Char) ⇒ B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
Produces a collection containing cumulative results of applying the operator going left to right.
Produces a collection containing cumulative results of applying the operator going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanRight[B, That](z: B)(op: (Char, B) ⇒ B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
Produces a collection containing cumulative results of applying the operator going right to left.
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
(Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
-
def
segmentLength(p: (Char) ⇒ Boolean, from: Int): Int
Computes length of longest segment whose elements all satisfy some predicate.
Computes length of longest segment whose elements all satisfy some predicate.
- p
the predicate used to test elements.
- from
the index where the search starts.
- returns
the length of the longest segment of this sequence starting from index
from
such that every element of the segment satisfies the predicatep
.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
seq: IndexedSeq[Char]
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
- returns
a sequential view of the collection.
- Definition Classes
- IndexedSeq → IndexedSeq → IndexedSeqLike → Seq → Seq → GenSeq → GenSeqLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
-
def
setCharAt(index: Int, ch: Char): Unit
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.
-
def
size: Int
The size of this sequence, equivalent to
length
.The size of this sequence, equivalent to
length
.Note: will not terminate for infinite-sized collections.
- returns
the number of elements in this sequence.
- Definition Classes
- SeqLike → GenTraversableLike → TraversableOnce → GenTraversableOnce
-
def
sizeHint(coll: TraversableLike[_, _], delta: Int): Unit
Gives a hint that one expects the
result
of this builder to have the same size as the given collection, plus some delta.Gives a hint that one expects the
result
of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheapsize
method. Currently this is assumed to be the case if and only if the collection is of typeIndexedSeqLike
. 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(coll: TraversableLike[_, _]): 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 is known to have a cheapsize
method, which is determined by callingsizeHint
.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.
- 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
-
def
sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): 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
-
def
slice(from: Int, until: Int): StringBuilder
Selects an interval of elements.
Selects an interval of elements. The returned collection is made up of all elements
x
which satisfy the invariant:from <= indexOf(x) < until
- returns
a string containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this string.
- Definition Classes
- StringLike → IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
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.)
- size
the number of elements per group
- step
the distance between the first elements of successive groups
- returns
An iterator producing iterable collections of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Definition Classes
- IterableLike
- 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
.) The "sliding window" step is set to one.Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in
grouped
.) The "sliding window" step is set to one.- size
the number of elements per group
- returns
An iterator producing iterable collections of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
sliding
-
def
sortBy[B](f: (Char) ⇒ B)(implicit ord: math.Ordering[B]): StringBuilder
Sorts this
Seq
according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.Sorts this
Seq
according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.- B
the target type of the transformation
f
, and the type where the orderingord
is defined.- f
the transformation function mapping elements to some other domain
B
.- ord
the ordering assumed on domain
B
.- returns
a sequence consisting of the elements of this sequence sorted according to the ordering where
x < y
iford.lt(f(x), f(y))
.
- Definition Classes
- SeqLike
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 Note: will not terminate for infinite-sized collections.
Example: -
def
sortWith(lt: (Char, Char) ⇒ Boolean): StringBuilder
Sorts this sequence according to a comparison function.
Sorts this sequence according to a comparison function.
Note: will not terminate for infinite-sized collections.
The sort is stable. That is, elements that are equal (as determined by
lt
) appear in the same order in the sorted sequence as in the original.- lt
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
- returns
a sequence consisting of the elements of this sequence sorted according to the comparison function
lt
.
- Definition Classes
- SeqLike
List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) = List("Bob", "John", "Steve", "Tom")
Example: -
def
sorted[B >: Char](implicit ord: math.Ordering[B]): StringBuilder
Sorts this sequence according to an Ordering.
Sorts this sequence according to an Ordering.
The sort is stable. That is, elements that are equal (as determined by
lt
) appear in the same order in the sorted sequence as in the original.- ord
the ordering to be used to compare elements.
- returns
a sequence consisting of the elements of this sequence sorted according to the ordering
ord
.
- Definition Classes
- SeqLike
- See also
-
def
span(p: (Char) ⇒ Boolean): (StringBuilder, StringBuilder)
Splits this sequence into a prefix/suffix pair according to a predicate.
Splits this sequence into a prefix/suffix pair according to a predicate.
Note:
c span p
is equivalent to (but possibly more efficient than)(c takeWhile p, c dropWhile p)
, provided the evaluation of the predicatep
does not cause any side-effects.- returns
a pair consisting of the longest prefix of this sequence whose elements all satisfy
p
, and the rest of this sequence.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
split(separators: Array[Char]): Array[String]
- Definition Classes
- StringLike
- Annotations
- @throws( clazz = ... )
-
def
split(separator: Char): Array[String]
Split this string around the separator character
Split this string around the separator character
If this string is the empty string, returns an array of strings that contains a single empty string.
If this string is not the empty string, returns an array containing the substrings terminated by the start of the string, the end of the string or the separator character, excluding empty trailing substrings
If the separator character is a surrogate character, only split on matching surrogate characters if they are not part of a surrogate pair
The behaviour follows, and is implemented in terms of String.split(re: String)
- separator
the character used as a delimiter
- Definition Classes
- StringLike
"a.b".split('.') //returns Array("a", "b") //splitting the empty string always returns the array with a single //empty string "".split('.') //returns Array("") //only trailing empty substrings are removed "a.".split('.') //returns Array("a") ".a.".split('.') //returns Array("", "a") "..a..".split('.') //returns Array("", "", "a") //all parts are empty and trailing ".".split('.') //returns Array() "..".split('.') //returns Array() //surrogate pairs val high = 0xD852.toChar val low = 0xDF62.toChar val highstring = high.toString val lowstring = low.toString //well-formed surrogate pairs are not split val highlow = highstring + lowstring highlow.split(high) //returns Array(highlow) //bare surrogate characters are split val bare = "_" + highstring + "_" bare.split(high) //returns Array("_", "_")
Example: -
def
splitAt(n: Int): (StringBuilder, StringBuilder)
Splits this sequence into two at a given position.
Splits this sequence into two at a given position. Note:
c splitAt n
is equivalent to (but possibly more efficient than)(c take n, c drop n)
.- n
the position at which to split.
- returns
a pair of sequences consisting of the first
n
elements of this sequence, and the other elements.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
startsWith[B](that: GenSeq[B], offset: Int): Boolean
Tests whether this sequence contains the given sequence at a given index.
Tests whether this sequence contains the given sequence at a given index.
Note: If the both the receiver object
this
and the argumentthat
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 sequencethat
is contained in this sequence at indexoffset
, otherwisefalse
.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
startsWith[B](that: GenSeq[B]): Boolean
Tests whether this general sequence starts with the given sequence.
Tests whether this general sequence starts with the given sequence.
- that
the sequence to test
- returns
true
if this collection hasthat
as a prefix,false
otherwise.
- Definition Classes
- GenSeqLike
-
def
stringPrefix: String
Defines the prefix of this object's
toString
representation.Defines the prefix of this object's
toString
representation.- returns
a string representation which starts the result of
toString
applied to this traversable collection. By default the string prefix is the simple name of the collection class traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
stripLineEnd: String
Strip trailing line end character from this string if it has one.
Strip trailing line end character from this string if it has one.
A line end character is one of
LF
- line feed (0x0A
hex)FF
- form feed (0x0C
hex)
If a line feed character
LF
is preceded by a carriage returnCR
(0x0D
hex), theCR
character is also stripped (Windows convention).- Definition Classes
- StringLike
-
def
stripMargin: String
For every line in this string:
For every line in this string:
Strip a leading prefix consisting of blanks or control characters followed by
|
from the line.- Definition Classes
- StringLike
-
def
stripMargin(marginChar: Char): String
For every line in this string:
For every line in this string:
Strip a leading prefix consisting of blanks or control characters followed by
marginChar
from the line.- Definition Classes
- StringLike
-
def
stripPrefix(prefix: String): String
Returns this string with the given
prefix
stripped.Returns this string with the given
prefix
stripped. If this string does not start withprefix
, it is returned unchanged.- Definition Classes
- StringLike
-
def
stripSuffix(suffix: String): String
Returns this string with the given
suffix
stripped.Returns this string with the given
suffix
stripped. If this string does not end withsuffix
, it is returned unchanged.- Definition Classes
- StringLike
-
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: A
[use case] Sums up the elements of this collection.
[use case]Sums up the elements of this collection.
- returns
the sum of all elements in this string builder of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the string builder and as result type ofsum
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
tail: StringBuilder
Selects all elements except the first.
Selects all elements except the first.
- returns
a sequence consisting of all elements of this sequence except the first one.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
java.lang.UnsupportedOperationException
if the sequence is empty.
-
def
tails: Iterator[StringBuilder]
Iterates over the tails of this traversable collection.
Iterates over the tails of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of
tail
.- returns
an iterator over all the tails of this traversable collection
- Definition Classes
- TraversableLike
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Example: -
def
take(n: Int): StringBuilder
Selects first n elements.
Selects first n elements.
- n
the number of elements to take from this sequence.
- returns
a sequence consisting only of the first
n
elements of this sequence, or else the whole sequence, if it has less thann
elements. Ifn
is negative, returns an empty sequence.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
takeRight(n: Int): StringBuilder
Selects last n elements.
Selects last n elements.
- n
the number of elements to take
- returns
a sequence consisting only of the last
n
elements of this sequence, or else the whole sequence, if it has less thann
elements.
- Definition Classes
- IndexedSeqOptimized → IterableLike
-
def
takeWhile(p: (Char) ⇒ Boolean): StringBuilder
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
- returns
the longest prefix of this sequence whose elements all satisfy the predicate
p
.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
to[Col[_]]: Col[A]
[use case] Converts this string builder into another by copying all elements.
[use case]Converts this string builder into another by copying all elements.
- Col
The collection type to build.
- returns
a new collection containing all elements of this string builder.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
Full Signaturedef to[Col[_]](implicit cbf: CanBuildFrom[Nothing, Char, Col[Char]]): Col[Char]
- def toArray: Array[Char]
-
def
toArray: Array[A]
[use case] Converts this string builder to an array.
[use case]Converts this string builder to an array.
- returns
an array containing all elements of this string builder. An
ClassTag
must be available for the element type of this string builder.
- Definition Classes
- StringLike → TraversableOnce → GenTraversableOnce
-
def
toBoolean: Boolean
- Definition Classes
- StringLike
- Exceptions thrown
java.lang.IllegalArgumentException
If the string does not contain a parsableBoolean
.
-
def
toBuffer[A1 >: Char]: Buffer[A1]
Uses the contents of this sequence to create a new mutable buffer.
Uses the contents of this sequence to create a new mutable buffer.
- returns
a buffer containing all elements of this sequence.
- Definition Classes
- IndexedSeqLike → TraversableOnce → GenTraversableOnce
-
def
toByte: Byte
Parse as a
Byte
(string must contain only decimal digits and optional leading-
).Parse as a
Byte
(string must contain only decimal digits and optional leading-
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NumberFormatException
If the string does not contain a parsableByte
.
-
def
toDouble: Double
Parse as a
Double
(surrounding whitespace is removed with atrim
).Parse as a
Double
(surrounding whitespace is removed with atrim
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NullPointerException
If the string is null.java.lang.NumberFormatException
If the string does not contain a parsableDouble
.
-
def
toFloat: Float
Parse as a
Float
(surrounding whitespace is removed with atrim
).Parse as a
Float
(surrounding whitespace is removed with atrim
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NullPointerException
If the string is null.java.lang.NumberFormatException
If the string does not contain a parsableFloat
.
-
def
toIndexedSeq: immutable.IndexedSeq[Char]
Converts this traversable or iterator to an indexed sequence.
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite-sized collections.
- returns
an indexed sequence containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toInt: Int
Parse as an
Int
(string must contain only decimal digits and optional leading-
).Parse as an
Int
(string must contain only decimal digits and optional leading-
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NumberFormatException
If the string does not contain a parsableInt
.
-
def
toIterable: collection.Iterable[Char]
Returns this iterable collection as an iterable collection.
Returns this iterable collection as an iterable collection.
A new collection will not be built; lazy collections will stay lazy.
Note: will not terminate for infinite-sized collections.
- returns
an
Iterable
containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
-
def
toIterator: Iterator[Char]
Returns an Iterator over the elements in this iterable collection.
Returns an Iterator over the elements in this iterable collection. Produces the same result as
iterator
.Note: will not terminate for infinite-sized collections.
- returns
an Iterator containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
-
def
toList: List[Char]
Converts this traversable or iterator to a list.
Converts this traversable or iterator to a list.
Note: will not terminate for infinite-sized collections.
- returns
a list containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toLong: Long
Parse as a
Long
(string must contain only decimal digits and optional leading-
).Parse as a
Long
(string must contain only decimal digits and optional leading-
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NumberFormatException
If the string does not contain a parsableLong
.
-
def
toMap[T, U]: collection.Map[T, U]
[use case] Converts this string builder to a map.
[use case]Converts this string builder to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
- returns
a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this string builder.
- Definition Classes
- TraversableOnce → GenTraversableOnce
Full Signaturedef toMap[T, U](implicit ev: <:<[Char, (T, U)]): immutable.Map[T, U]
-
def
toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from StringBuilder to CollectionsHaveToParArray[StringBuilder, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (StringBuilder) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
-
def
toSeq: collection.Seq[Char]
Converts this sequence to a sequence.
Converts this sequence to a sequence.
Note: will not terminate for infinite-sized collections.
A new collection will not be built; in particular, lazy sequences will stay lazy.
- returns
a sequence containing all elements of this sequence.
- Definition Classes
- SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce
-
def
toSet[B >: Char]: immutable.Set[B]
Converts this traversable or iterator to a set.
Converts this traversable or iterator to a set.
Note: will not terminate for infinite-sized collections.
- returns
a set containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toShort: Short
Parse as a
Short
(string must contain only decimal digits and optional leading-
).Parse as a
Short
(string must contain only decimal digits and optional leading-
).- Definition Classes
- StringLike
- Exceptions thrown
java.lang.NumberFormatException
If the string does not contain a parsableShort
.
-
def
toStream: immutable.Stream[Char]
Converts this iterable collection to a stream.
Converts this iterable collection to a stream.
- returns
a stream containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
-
def
toString(): String
Returns a new String representing the data in this sequence.
Returns a new String representing the data in this sequence.
- returns
the current contents of this sequence as a String
- Definition Classes
- StringBuilder → CharSequence → SeqLike → Function1 → TraversableLike → AnyRef → Any
- Note
because toString is inherited from AnyRef and used for many purposes, it is better practice to call mkString to obtain a StringBuilder result.
-
def
toTraversable: collection.Traversable[Char]
Converts this traversable collection to an unspecified Traversable.
Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite-sized collections.
- returns
a Traversable containing all elements of this traversable collection.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
-
def
toVector: Vector[Char]
Converts this traversable or iterator to a Vector.
Converts this traversable or iterator to a Vector.
Note: will not terminate for infinite-sized collections.
- returns
a vector containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
transform(f: (Char) ⇒ Char): StringBuilder.this.type
Applies a transformation function to all values contained in this sequence.
Applies a transformation function to all values contained in this sequence. The transformation function produces new values from existing elements.
- f
the transformation to apply
- returns
the sequence itself.
- Definition Classes
- SeqLike
-
def
transpose[B](implicit asTraversable: (Char) ⇒ GenTraversableOnce[B]): IndexedSeq[IndexedSeq[B]]
Transposes this collection of traversable collections into a collection of collections.
Transposes this collection of traversable collections into a collection of collections.
The resulting collection's type will be guided by the static type of collection. For example:
val xs = List( Set(1, 2, 3), Set(4, 5, 6)).transpose // xs == List( // List(1, 4), // List(2, 5), // List(3, 6)) val ys = Vector( List(1, 2, 3), List(4, 5, 6)).transpose // ys == Vector( // Vector(1, 4), // Vector(2, 5), // Vector(3, 6))
- B
the type of the elements of each traversable collection.
- asTraversable
an implicit conversion which asserts that the element type of this collection is a
Traversable
.- returns
a two-dimensional collection of collections which has as nth row the nth column of this collection.
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
(Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.- Exceptions thrown
IllegalArgumentException
if all collections in this collection are not of the same size.
-
def
union(that: collection.Seq[Char]): IndexedSeq[Char]
[use case] Produces a new sequence which contains all elements of this string builder and also all elements of a given sequence.
[use case]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 toxs ++ ys
.Another way to express this is that
xs union ys
computes the order-preserving multi-set union ofxs
andys
.union
is hence a counter-part ofdiff
andintersect
which also work on multi-sets.- that
the sequence to add.
- returns
a new string builder which contains all elements of this string builder followed by all elements of
that
.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef union[B >: Char, That](that: GenSeq[B])(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
unzip[A1, A2](implicit asPair: (Char) ⇒ (A1, A2)): (IndexedSeq[A1], IndexedSeq[A2])
Converts this collection of pairs into two collections of the first and second half of each pair.
Converts this collection of pairs into two collections of the first and second half of each pair.
val xs = Traversable( (1, "one"), (2, "two"), (3, "three")).unzip // xs == (Traversable(1, 2, 3), // Traversable(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 collection is a pair.
- returns
a pair of collections, containing the first, respectively second half of each element pair of this collection.
- Definition Classes
- GenericTraversableTemplate
-
def
unzip3[A1, A2, A3](implicit asTriple: (Char) ⇒ (A1, A2, A3)): (IndexedSeq[A1], IndexedSeq[A2], IndexedSeq[A3])
Converts this collection of triples into three collections of the first, second, and third element of each triple.
Converts this collection of triples into three collections of the first, second, and third element of each triple.
val xs = Traversable( (1, "one", '1'), (2, "two", '2'), (3, "three", '3')).unzip3 // xs == (Traversable(1, 2, 3), // Traversable(one, two, three), // Traversable(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 collection is a triple.
- returns
a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
- Definition Classes
- GenericTraversableTemplate
-
def
update(i: Int, c: Char): Unit
Equivalent to setCharAt.
Equivalent to setCharAt.
- Definition Classes
- StringBuilder → IndexedSeqLike → SeqLike
-
def
updated(index: Int, elem: A): IndexedSeq[A]
[use case] A copy of this string builder with one single replaced element.
[use case]A copy of this string builder with one single replaced element.
- index
the position of the replacement
- elem
the replacing element
- returns
a copy of this string builder with the element at position
index
replaced byelem
.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef updated[B >: Char, That](index: Int, elem: B)(implicit bf: CanBuildFrom[StringBuilder, B, That]): That
-
def
view(from: Int, until: Int): IndexedSeqView[Char, IndexedSeq[Char]]
A sub-sequence view starting at index
from
and extending up to (but not including) indexuntil
.A sub-sequence view starting at index
from
and extending up to (but not including) indexuntil
.- from
The index of the first element of the slice
- until
The index of the element following the slice
- returns
a non-strict view of a slice of this mutable indexed sequence, starting at index
from
and extending up to (but not including) indexuntil
.@note The difference betweenview
andslice
is thatview
produces a view of the current sequence, whereasslice
produces a new sequence.
- Definition Classes
- IndexedSeqLike → SeqLike → IterableLike → TraversableLike
- Note
view(from, to) is equivalent to view.slice(from, to)
-
def
view: IndexedSeqView[Char, IndexedSeq[Char]]
Creates a view of this iterable @see Iterable.View
Creates a view of this iterable @see Iterable.View
- returns
a non-strict view of this mutable indexed sequence.
- Definition Classes
- IndexedSeqLike → SeqLike → IterableLike → TraversableLike
-
def
withFilter(p: (Char) ⇒ Boolean): FilterMonadic[Char, StringBuilder]
Creates a non-strict filter of this traversable collection.
Creates a non-strict filter of this traversable collection.
Note: the difference between
c filter p
andc withFilter p
is that the former creates a new collection, whereas the latter only restricts the domain of subsequentmap
,flatMap
,foreach
, andwithFilter
operations.Note: might return different results for different runs, unless the underlying collection type is ordered.
- p
the predicate used to test elements.
- returns
an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this traversable collection which satisfy the predicatep
.
- Definition Classes
- TraversableLike → FilterMonadic
-
def
zip[B](that: GenIterable[B]): IndexedSeq[(A, B)]
[use case] Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs.
[use case]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 andthat
.
- Definition Classes
- IndexedSeqOptimized → IterableLike → GenIterableLike
Full Signaturedef zip[A1 >: Char, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[StringBuilder, (A1, B), That]): That
-
def
zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): IndexedSeq[(A, B)]
[use case] Returns a string builder formed from this string builder and another iterable collection by combining corresponding elements in pairs.
[use case]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.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- thisElem
the element to be used to fill up the result if this string 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 string builder 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 andthat
. If this string builder is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this string builder,thatElem
values are used to pad the result.
- Definition Classes
- IterableLike → GenIterableLike
Full Signaturedef zipAll[B, A1 >: Char, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[StringBuilder, (A1, B), That]): That
-
def
zipWithIndex: IndexedSeq[(A, Int)]
[use case] Zips this string builder with its indices.
[use case]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
- IndexedSeqOptimized → IterableLike → GenIterableLike
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
Full Signaturedef zipWithIndex[A1 >: Char, That](implicit bf: CanBuildFrom[StringBuilder, (A1, Int), That]): That
Example:
Shadowed Implicit Value Members
-
def
charAt(index: Int): Char
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).charAt(index)
- Definition Classes
- SeqCharSequence → CharSequence
-
def
chars(): IntStream
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).chars()
- Definition Classes
- CharSequence
-
def
codePoints(): IntStream
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).codePoints()
- Definition Classes
- CharSequence
-
def
filter(p: (Char) ⇒ Boolean): TraversableOnce[Char]
- Implicit
- This member is added by an implicit conversion from StringBuilder to MonadOps[Char] performed by method MonadOps in scala.collection.TraversableOnce.
- 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: MonadOps[Char]).filter(p)
- Definition Classes
- MonadOps
-
def
flatMap[B](f: (Char) ⇒ GenTraversableOnce[B]): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from StringBuilder to MonadOps[Char] performed by method MonadOps in scala.collection.TraversableOnce.
- 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: MonadOps[Char]).flatMap(f)
- Definition Classes
- MonadOps
-
def
length(): Int
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).length()
- Definition Classes
- SeqCharSequence → CharSequence
-
def
map[B](f: (Char) ⇒ B): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from StringBuilder to MonadOps[Char] performed by method MonadOps in scala.collection.TraversableOnce.
- 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: MonadOps[Char]).map(f)
- Definition Classes
- MonadOps
-
def
subSequence(start: Int, end: Int): CharSequence
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).subSequence(start, end)
- Definition Classes
- SeqCharSequence → CharSequence
-
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.
- Implicit
- This member is added by an implicit conversion from StringBuilder to SeqCharSequence performed by method SeqCharSequence in scala.Predef.
- 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: SeqCharSequence).toString()
- Definition Classes
- SeqCharSequence → CharSequence → AnyRef → Any
-
def
withFilter(p: (Char) ⇒ Boolean): Iterator[Char]
- Implicit
- This member is added by an implicit conversion from StringBuilder to MonadOps[Char] performed by method MonadOps in scala.collection.TraversableOnce.
- 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: MonadOps[Char]).withFilter(p)
- Definition Classes
- MonadOps
Deprecated Value Members
-
def
linesIterator: Iterator[String]
Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply
.stripLineEnd
to all lines returned bylinesWithSeparators
.Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply
.stripLineEnd
to all lines returned bylinesWithSeparators
.- Definition Classes
- StringLike
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) use
lines
instead
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.