Trait

scala.collection.mutable

Builder

Related Doc: package mutable

Permalink

trait Builder[-Elem, +To] extends Growable[Elem]

The base trait of all builders. A builder lets one construct a collection incrementally, by adding elements to the builder with += and then converting to the required collection type with result.

Elem: the type of elements that get added to the builder.
To: the type of collection that it produced.

Since: 2.8

Linear Supertypes

Growable[Elem], Clearable, AnyRef, Any

Known Subclasses

AbstractMap, AbstractSet, AnyRefMap, AnyRefMapBuilder, ArrayBuffer, ArrayBuilder, ArrayStack, BitSet, Combiner, DefaultMapModel, GrowingBuilder, HashMap, HashSet, ImmutableMapAdaptor, ImmutableSetAdaptor, LazyBuilder, LazyCombiner, LinkedHashMap, LinkedHashSet, ListBuffer, ListMap, ListSetBuilder, LongMap, LongMapBuilder, Map, Map, MapBuilder, MapLike, MapProxy, MultiMap, MutableList, NoBuilder, ObservableMap, ObservableSet, OpenHashMap, PriorityQueue, PriorityQueueProxy, Queue, QueueProxy, ResizableParArrayCombiner, Script, Set, SetBuilder, SetLike, SetProxy, SortedSet, StackBuilder, StreamBuilder, StringBuilder, SynchronizedMap, SynchronizedPriorityQueue, SynchronizedQueue, SynchronizedSet, SystemProperties, TreeSet, TrieMap, UnrolledBuffer, UnrolledParArrayCombiner, VectorBuilder, WithDefault, WrappedArrayBuilder, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit

Ordering

Alphabetic
By Inheritance

Inherited

Builder
Growable
Clearable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def +=(elem: Elem): Builder.this.type

Adds a single element to the builder.
Adds a single element to the builder.
elem
the element to be added.
returns
the builder itself.

Definition Classes
Builder → Growable
abstract def clear(): Unit

Clears the contents of this builder.
Clears the contents of this builder. After execution of this method the builder will contain no elements.

Definition Classes
Builder → Growable → Clearable
abstract def result(): To

Produces a collection from the added elements.
Produces a collection from the added elements. The builder's contents are undefined after this operation.
returns
a collection containing the elements added to this builder.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def ++=(xs: TraversableOnce[Elem]): Builder.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 +=(elem1: Elem, elem2: Elem, elems: Elem*): Builder.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
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mapResult[NewTo](f: (To) ⇒ NewTo): Builder[Elem, 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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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 cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. 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.
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 cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. 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.
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.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Growable[Elem]

Inherited from Clearable

Inherited from AnyRef

Inherited from Any

Ungrouped