Class scala.collection.immutable.VectorBuilder
final class VectorBuilder[A] extends ReusableBuilder[A, Vector[A]] with VectorPointer[A]
Instance Constructors
new VectorBuilder()
Value Members
final def !=(arg0: Any): Boolean
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
final def ##(): Int
Equivalent to x.hashCode
except for boxed numeric types and null
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null
returns a hashcode where null.hashCode
throws a NullPointerException
.
- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toany2stringadd[VectorBuilder[A]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
final def ++=(xs: IterableOnce[A]): VectorBuilder.this.type
final def +=(elem: A): VectorBuilder.this.type
def ->[B](y: B): (VectorBuilder[A], B)
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toArrowAssoc[VectorBuilder[A]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
final def ==(arg0: Any): Boolean
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
def addAll(xs: IterableOnce[A]): VectorBuilder.this.type
Adds all elements produced by an IterableOnce to this growable collection.
- xs
the IterableOnce producing the elements to add.
- returns
the growable collection itself.
- Definition Classes
- VectorBuilder → Growable
def addOne(elem: A): VectorBuilder.this.type
Adds a single element to this growable collection.
- elem
the element to add.
- returns
the growable collection itself
- Definition Classes
- VectorBuilder → Growable
final def asInstanceOf[T0]: T0
Cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expression List(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
def clear(): Unit
Clears the contents of this builder. After execution of this method, the builder will contain no elements.
If executed immediately after a call to result()
, this allows a new instance of the same type of collection to be built.
- Definition Classes
- VectorBuilder → ReusableBuilder → Builder → Clearable
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def ensuring(cond: (VectorBuilder[A]) => Boolean, msg: => Any): VectorBuilder[A]
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toEnsuring[VectorBuilder[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (VectorBuilder[A]) => Boolean): VectorBuilder[A]
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toEnsuring[VectorBuilder[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: => Any): VectorBuilder[A]
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toEnsuring[VectorBuilder[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): VectorBuilder[A]
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toEnsuring[VectorBuilder[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional properties:
-
It is consistent: for any non-null instances
x
and y
of type AnyRef
, multiple invocations of x.eq(y)
consistently returns true
or consistently returns false
.For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
null.eq(null)
returns true
. When overriding the equals
or hashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).
- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def equals(arg0: AnyRef): Boolean
The equality method for reference types. Default implementation delegates to eq
.
See also equals
in scala.Any.
- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
def formatted(fmtstr: String): String
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from VectorBuilder[A] toStringFormat[VectorBuilder[A]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def hashCode(): Int
The hashCode method for reference types. See hashCode in scala.Any.
- returns
the hash code value for this object.
def isEmpty: Boolean
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
def knownSize: Int
- returns
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise. The default implementation always returns -1.
- Definition Classes
- VectorBuilder → Growable
def mapResult[NewTo](f: (Vector[A]) => NewTo): Builder[A, NewTo]
A builder resulting from this builder my mapping the result using f
.
- Definition Classes
- Builder
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that)
.
- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def nonEmpty: Boolean
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
def preClean(depth: Int): Unit
- Attributes
- protected
- Definition Classes
- VectorPointer
def result(): Vector[A]
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
- VectorBuilder → ReusableBuilder → Builder
def size: Int
final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit
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.
- 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(size: Int): Unit
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
final def sizeHintBounded(size: Int, boundingColl: collection.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. 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
final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
def toString(): String
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.
- Definition Classes
- AnyRef → Any
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/VectorBuilder.html
A class to build instances of
Vector
. This builder is reusable.