Builder
Base trait for collection builders.
After callingresult() the behavior of a Builder (which is not also ascala.collection.mutable.ReusableBuilder) is undefined. No further methods should be called. It is common for mutable collections to be their own non-reusable Builder, in which caseresult() simply returnsthis.
Attributes
- See also
scala.collection.mutable.ReusableBuilder for Builders which can be reused after calling
result()- Source
- Builder.scala
- Graph
- Supertypes
- Known subtypes
- classLongMap[V]classSystemPropertiesclassPriorityQueue[A]classVectorBuilder[A]classArrayBuilder[T]classofBooleanclassofByteclassofCharclassofDoubleclassofFloatclassofIntclassofLongclassofRef[T]classofShortclassofUnitclassListBuffer[A]classLongMapBuilder[V]classStringBuilderclassHashSet[A]classLinkedHashSet[A]traitSet[A]classAbstractSet[A]classBitSetclassTreeSet[A]traitSortedSet[A]classUnrolledBuffer[T]classAnyAccumulator[A]classDoubleAccumulatorclassIntAccumulatorclassLongAccumulatorShow all
- Self type
Members list
Value members
Abstract methods
Clears the contents of this builder.
Clears the contents of this builder. After execution of this method the builder will contain no elements.
Attributes
- Source
- Builder.scala
Result collection consisting of all elements appended so far.
Concrete methods
A builder resulting from this builder by mapping the result usingf.
Gives a hint how many elements are expected to be added in total by the timeresult is called.
Gives a hint how many elements are expected to be added in total by the timeresult is called.
Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, e.g., a different number of elements is added, or the hint is out of range.
The default implementation simply ignores the hint.
Value parameters
- size
the hint how many elements will be added.
Attributes
- Source
- Builder.scala
Gives a hint that theresult of this builder is expected to have the same size as the given collection, plus some delta.
Gives a hint that theresult of this builder is expected to have the same size as the given collection, plus some delta.
This method provides a hint only if the collection has a known size, as specified by the following pseudocode:
if (coll.knownSize != -1) if (coll.knownSize + delta <= 0) sizeHint(0) else sizeHint(coll.knownSize + delta)If the delta is negative and the result size is known to be negative, then the size hint is issued at zero.
Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, i.e., if a different number of elements is added.
Value parameters
- coll
the collection which serves as a hint for the result's size.
- delta
a correction to add to the
coll.sizeto produce the size hint (zero if omitted).
Attributes
- Source
- Builder.scala
Gives a hint how many elements are expected to be added when the nextresult 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 nextresult 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 parameters
- 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.
Attributes
- Source
- Builder.scala
Inherited methods
Alias foraddAll
Alias foraddOne
Adds all elements produced by an IterableOnce to this growable collection.
Adds all elements produced by an IterableOnce to this growable collection.
Value parameters
- elems
the IterableOnce producing the elements to add.
Attributes
- Returns
the growable collection itself.
- Inherited from:
- Growable
- Source
- Growable.scala
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
Attributes
- Returns
The number of elements. The default implementation always returns -1.
- Inherited from:
- Growable
- Source
- Growable.scala
Inherited and Abstract methods
Adds a single element to this growable collection.
Adds a single element to this growable collection.
Value parameters
- elem
the element to add.
Attributes
- Returns
the growable collection itself
- Inherited from:
- Growable
- Source
- Growable.scala
Deprecated and Inherited methods
Adds two or more elements to this growable collection.
Adds two or more elements to this growable collection.
Value parameters
- elem1
the first element to add.
- elem2
the second element to add.
- elems
the remaining elements to add.
Attributes
- Returns
the growable collection itself
- Deprecated
[Since version 2.13.0]Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated- Inherited from:
- Growable
- Source
- Growable.scala