Scala 3/API/scala.collection.mutable/ArrayBuilder

ArrayBuilder

@SerialVersionUID(3L) sealed abstract class ArrayBuilder[T] extends ReusableBuilder[T, Array[T]] with Serializable

A builder class for arrays.

A builder class for arrays.

Type Params
T

the type of the elements for the builder.

Companion
object
trait Builder[T, Array[T]]
trait Growable[T]
trait Clearable
class Object
trait Matchable
class Any
class ofRef[T]
class ofByte
class ofShort
class ofChar
class ofInt
class ofLong
class ofFloat
class ofDouble
class ofBoolean
class ofUnit

Value members

Concrete methods

def addAll(xs: Array[_ <: T]): ArrayBuilder[T]

Add all elements of an array

Add all elements of an array

def addAll(xs: Array[_ <: T], offset: Int, length: Int): ArrayBuilder[T]

Add a slice of an array

Add a slice of an array

override def addAll(xs: IterableOnce[T]): ArrayBuilder[T]
Definition Classes
def clear(): Unit
override def knownSize: Int
Definition Classes
def length: Int
final override def sizeHint(size: Int): Unit
Definition Classes

Inherited methods

final def ++=(xs: IterableOnce[T]): ArrayBuilder[T]

Alias for addAll

Alias for addAll

Inherited from
Growable
final def +=(elem: T): ArrayBuilder[T]

Alias for addOne

Alias for addOne

Inherited from
Growable
def addOne(elem: T): ArrayBuilder[T]

Adds a single element to this growable collection.

Adds a single element to this growable collection.

Value Params
elem

the element to add.

Returns

the growable collection itself

Inherited from
Growable
def mapResult[NewTo](f: Array[T] => NewTo): Builder[T, NewTo]

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

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

Inherited from
Builder
override def result(): Array[T]

Produces a collection from the added elements.

Produces a collection from the added elements.

After a call to result, the behavior of all other methods is undefined save for clear(). If clear() is called, then the builder is reset and may be used to build another instance.

Returns

a collection containing the elements added to this builder.

Definition Classes
Inherited from
ReusableBuilder
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

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

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

Value Params
coll

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

delta

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

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

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

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

Value Params
boundingColl

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

size

the hint how many elements will be added.

Inherited from
Builder

Deprecated and Inherited methods

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

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

Value Params
elem1

the first element to add.

elem2

the second element to add.

elems

the remaining elements to add.

Returns

the growable collection itself

Deprecated
Inherited from
Growable