Scala Standard Library2.13.15 < Back


# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other packages exist. See the complete list on the right.

  Additional parts of the standard library are shipped as separate libraries. These include:

  - `scala.reflect` - Scala's reflection API (scala-reflect.jar)
  - `scala.xml` - XML parsing, manipulation, and serialization (scala-xml.jar)
  - `scala.collection.parallel` - Parallel collections (scala-parallel-collections.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)

  #### Automatic imports

  Identifiers in the scala package and the `scala.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package collection
  Definition Classes
    scala
-  package mutable
  Definition Classes
    collection
-  object AnyRefMap extends java.io.Serializable
  Definition Classes
    mutable
- AnyRefMapBuilder

c

scala.collection.mutable.AnyRefMap

# AnyRefMapBuilder

###

#### final class AnyRefMapBuilder[K <: AnyRef, V] extends ReusableBuilder[(K, V), AnyRefMap[K, V]]

A builder for instances of `AnyRefMap`.

This builder can be reused to create multiple instances.

Source
  AnyRefMap.scala

Linear Supertypes
ReusableBuilder[(K, V), AnyRefMap[K, V]], Builder[(K, V), AnyRefMap[K, V]], Growable[(K, V)], Clearable, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AnyRefMapBuilder
2. ReusableBuilder
3. Builder
4. Growable
5. Clearable
6. AnyRef
7. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new AnyRefMapBuilder()

### Value Members

1.  final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     AnyRef → Any
2.  final def ##: Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   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
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toany2stringadd[AnyRefMapBuilder[K, V]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  final def ++=(elems: IterableOnce[(K, V)]): AnyRefMapBuilder.this.type

   Alias for `addAll`

   Alias for `addAll`

   Definition Classes
     Growable
   Annotations
     @inline()
5.  final def +=(elem: (K, V)): AnyRefMapBuilder.this.type

   Alias for `addOne`

   Alias for `addOne`

   Definition Classes
     Growable
   Annotations
     @inline()
6.  def ->[B](y: B): (AnyRefMapBuilder[K, V], B)
   Implicit
     This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toArrowAssoc[AnyRefMapBuilder[K, V]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
7.  final def ==(arg0: Any): Boolean

   The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

   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
8.  def addAll(elems: IterableOnce[(K, V)]): AnyRefMapBuilder.this.type

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

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

   elems

     the IterableOnce producing the elements to add.

   returns

     the growable collection itself.

   Definition Classes
     Growable
9.  def addOne(entry: (K, V)): AnyRefMapBuilder.this.type

   Adds a single element to this growable collection.

   Adds a single element to this growable collection.

   returns

     the growable collection itself

   Definition Classes
     AnyRefMapBuilder → Growable
10.  final def asInstanceOf[T0]: T0

    Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

    Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

    This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

    It is platform dependent whether `asInstanceOf` has any effect at runtime. It might do a runtime type test on the erasure of `T0`, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

    In particular, `asInstanceOf` is not a type test. It does **not** mean:

        this match {
         case x: T0 => x
         case _     => throw ClassCastException("...")

    Use pattern matching or isInstanceOf for type testing instead.

    Situations where `asInstanceOf` is useful:

    - when flow analysis fails to deduce `T0` automatically
    - when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

    Be careful of using `asInstanceOf` when `T0` is a primitive type. When `T0` is primitive, `asInstanceOf` may insert a conversion instead of a type test. If your intent is to convert, use a `toT` method (`x.toChar`, `x.toByte`, etc.).

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown

      `ClassCastException` if the receiver is not an instance of the erasure of `T0`, if that can be checked on this platform

11.  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.

    If executed immediately after a call to `result()`, this allows a new instance of the same type of collection to be built.

    Definition Classes
      AnyRefMapBuilder → ReusableBuilder → Builder → Clearable
12.  def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

      not specified by SLS as a member of AnyRef

13.  def ensuring(cond: (AnyRefMapBuilder[K, V]) => Boolean, msg: => Any): AnyRefMapBuilder[K, V]
    Implicit
      This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toEnsuring[AnyRefMapBuilder[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: (AnyRefMapBuilder[K, V]) => Boolean): AnyRefMapBuilder[K, V]
    Implicit
      This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toEnsuring[AnyRefMapBuilder[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean, msg: => Any): AnyRefMapBuilder[K, V]
    Implicit
      This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toEnsuring[AnyRefMapBuilder[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: Boolean): AnyRefMapBuilder[K, V]
    Implicit
      This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toEnsuring[AnyRefMapBuilder[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (`that`) is a reference to the receiver object (`this`).

    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
18.  def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

    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
19.  def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    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.

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
    Note

      not specified by SLS as a member of AnyRef

20.  final def getClass(): Class[_ <: AnyRef]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

      a class object corresponding to the runtime type of the receiver.

    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

      the hash code value for this object.

    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as `T0`.

    Test whether the dynamic type of the receiver object has the same erasure as `T0`.

    Depending on what `T0` is, the test is done in one of the below ways:

    - `T0` is a non-parameterized class type, e.g. `BigDecimal`: this method returns `true` if the value of the receiver object is a `BigDecimal` or a subtype of `BigDecimal`.
    - `T0` is a parameterized class type, e.g. `List[Int]`: this method returns `true` if the value of the receiver object is some `List[X]` for any `X`. For example, `List(1, 2, 3).isInstanceOf[List[String]]` will return true.
    - `T0` is some singleton type `x.type` or literal `x`: this method returns `this.eq(x)`. For example, `x.isInstanceOf[1]` is equivalent to `x.eq(1)`
    - `T0` is an intersection `X with Y` or `X & Y: this method is equivalent to` x.isInstanceOf[X] && x.isInstanceOf[Y]``
    - `T0` is a union `X | Y`: this method is equivalent to `x.isInstanceOf[X] || x.isInstanceOf[Y]`
    - `T0` is a type parameter or an abstract type member: this method is equivalent to `isInstanceOf[U]` where `U` is `T0`'s upper bound, `Any` if `T0` is unbounded. For example, `x.isInstanceOf[A]` where `A` is an unbounded type parameter will return true for any value of `x`.

    This is exactly equivalent to the type pattern `_: T0`

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    Definition Classes
      Any
    Note

      due to the unexpectedness of `List(1, 2, 3).isInstanceOf[List[String]]` returning true and `x.isInstanceOf[A]` where `A` is a type parameter or abstract member returning true, these forms issue a warning.

23.  def knownSize: Int

    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.

    returns

      The number of elements. The default implementation always returns -1.

    Definition Classes
      AnyRefMapBuilder → Growable
24.  def mapResult[NewTo](f: (AnyRefMap[K, V]) => NewTo): Builder[(K, V), NewTo]

    A builder resulting from this builder by mapping the result using `f`.

    A builder resulting from this builder by mapping the result using `f`.

    Definition Classes
      Builder
25.  final def ne(arg0: AnyRef): Boolean

    Equivalent to `!(this eq that)`.

    Equivalent to `!(this eq that)`.

    returns

      `true` if the argument is not a reference to the receiver object; `false` otherwise.

    Definition Classes
      AnyRef
26.  final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    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

27.  final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    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

28.  def result(): AnyRefMap[K, V]

    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
      AnyRefMapBuilder → ReusableBuilder → Builder
29.  final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit

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

    Gives a hint that the `result` 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.

    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 (zero if omitted).

    Definition Classes
      Builder
30.  def sizeHint(size: Int): Unit

    Gives a hint how many elements are expected to be added in total by the time `result` is called.

    Gives a hint how many elements are expected to be added in total by the time `result` 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.

    size

      the hint how many elements will be added.

    Definition Classes
      Builder
31.  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.

    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
32.  final def synchronized[T0](arg0: => T0): T0

    Executes the code in `body` with an exclusive lock on `this`.

    Executes the code in `body` with an exclusive lock on `this`.

    returns

      the result of `body`

    Definition Classes
      AnyRef
33.  def toString(): String

    Creates a String representation of this object.

    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
34.  final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
    Note

      not specified by SLS as a member of AnyRef

35.  final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
    Note

      not specified by SLS as a member of AnyRef

36.  final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
    Note

      not specified by SLS as a member of AnyRef

### Deprecated Value Members

1.  final def +=(elem1: (K, V), elem2: (K, V), elems: (K, V)*): AnyRefMapBuilder.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
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.13.0) Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated

2.  def formatted(fmtstr: String): String

   Returns string formatted according to given `format` 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 AnyRefMapBuilder[K, V] toStringFormat[AnyRefMapBuilder[K, V]] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

3.  def →[B](y: B): (AnyRefMapBuilder[K, V], B)
   Implicit
     This member is added by an implicit conversion from AnyRefMapBuilder[K, V] toArrowAssoc[AnyRefMapBuilder[K, V]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from ReusableBuilder[(K, V), AnyRefMap[K, V]]

### Inherited from Builder[(K, V), AnyRefMap[K, V]]

### Inherited from Growable[(K, V)]

### Inherited from Clearable

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromAnyRefMapBuilder[K, V] to any2stringadd[AnyRefMapBuilder[K, V]]

### Inherited by implicit conversion StringFormat fromAnyRefMapBuilder[K, V] to StringFormat[AnyRefMapBuilder[K, V]]

### Inherited by implicit conversion Ensuring fromAnyRefMapBuilder[K, V] to Ensuring[AnyRefMapBuilder[K, V]]

### Inherited by implicit conversion ArrowAssoc fromAnyRefMapBuilder[K, V] to ArrowAssoc[AnyRefMapBuilder[K, V]]

### Ungrouped