ImmutableBuilder

abstract class ImmutableBuilder[-A, C <: IterableOnce[_]](empty: C) extends ReusableBuilder[A, C]

Reusable builder for immutable collections

Reusable builder for immutable collections

trait Builder[A, C]
trait Growable[A]
trait Clearable
class Object
trait Matchable
class Any

Value members

Concrete methods

def clear(): Unit
override def knownSize: Int
Definition Classes
def result(): C

Inherited methods

final def ++=(xs: IterableOnce[A]): ImmutableBuilder[A, C]

Alias for addAll

Alias for addAll

Inherited from
Growable
final def +=(elem: A): ImmutableBuilder[A, C]

Alias for addOne

Alias for addOne

Inherited from
Growable

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

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

Value Params
xs

the IterableOnce producing the elements to add.

Returns

the growable collection itself.

Inherited from
Growable
def addOne(elem: A): ImmutableBuilder[A, C]

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: C => NewTo): Builder[A, 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
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
def sizeHint(size: Int): Unit

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

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

Value Params
size

the hint how many elements will be added.

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: A, elem2: A, elems: A*): ImmutableBuilder[A, C]

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

Concrete fields

protected var elems: C