Scala Standard Library2.13.17 < 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 jdk

  The jdk package contains utilities to interact with JDK classes.

  The jdk package contains utilities to interact with JDK classes.

  This packages offers a number of converters, that are able to wrap or copy types from the scala library to equivalent types in the JDK class library and vice versa:

  - CollectionConverters, converting collections like scala.collection.Seq, scala.collection.Map, scala.collection.Set, scala.collection.mutable.Buffer, scala.collection.Iterator and scala.collection.Iterable to their JDK counterparts
  - OptionConverters, converting between Option and java.util.Optional and primitive variations
  - StreamConverters, to create JDK Streams from scala collections
  - DurationConverters, for conversions between scala scala.concurrent.duration.FiniteDuration and java.time.Duration
  - FunctionConverters, from scala Functions to java java.util.function.Function, java.util.function.UnaryOperator, java.util.function.Consumer and java.util.function.Predicate, as well as primitive variations and Bi-variations.

  By convention, converters that wrap an object to provide a different interface to the same underlying data structure use .asScala and .asJava extension methods, whereas converters that copy the underlying data structure use .toScala and .toJava.

  In the javaapi package, the same converters can be found with a java-friendly interface that don't rely on implicit enrichments.

  Additionally, this package offers Accumulators, capable of efficiently traversing JDK Streams.

  Definition Classes
    scala
-  object FunctionWrappers
  Definition Classes
    jdk
- AsJavaBiConsumer
- AsJavaBiFunction
- AsJavaBiPredicate
- AsJavaBinaryOperator
- AsJavaBooleanSupplier
- AsJavaConsumer
- AsJavaDoubleBinaryOperator
- AsJavaDoubleConsumer
- AsJavaDoubleFunction
- AsJavaDoublePredicate
- AsJavaDoubleSupplier
- AsJavaDoubleToIntFunction
- AsJavaDoubleToLongFunction
- AsJavaDoubleUnaryOperator
- AsJavaFunction
- AsJavaIntBinaryOperator
- AsJavaIntConsumer
- AsJavaIntFunction
- AsJavaIntPredicate
- AsJavaIntSupplier
- AsJavaIntToDoubleFunction
- AsJavaIntToLongFunction
- AsJavaIntUnaryOperator
- AsJavaLongBinaryOperator
- AsJavaLongConsumer
- AsJavaLongFunction
- AsJavaLongPredicate
- AsJavaLongSupplier
- AsJavaLongToDoubleFunction
- AsJavaLongToIntFunction
- AsJavaLongUnaryOperator
- AsJavaObjDoubleConsumer
- AsJavaObjIntConsumer
- AsJavaObjLongConsumer
- AsJavaPredicate
- AsJavaSupplier
- AsJavaToDoubleBiFunction
- AsJavaToDoubleFunction
- AsJavaToIntBiFunction
- AsJavaToIntFunction
- AsJavaToLongBiFunction
- AsJavaToLongFunction
- AsJavaUnaryOperator
- FromJavaBiConsumer
- FromJavaBiFunction
- FromJavaBiPredicate
- FromJavaBinaryOperator
- FromJavaBooleanSupplier
- FromJavaConsumer
- FromJavaDoubleBinaryOperator
- FromJavaDoubleConsumer
- FromJavaDoubleFunction
- FromJavaDoublePredicate
- FromJavaDoubleSupplier
- FromJavaDoubleToIntFunction
- FromJavaDoubleToLongFunction
- FromJavaDoubleUnaryOperator
- FromJavaFunction
- FromJavaIntBinaryOperator
- FromJavaIntConsumer
- FromJavaIntFunction
- FromJavaIntPredicate
- FromJavaIntSupplier
- FromJavaIntToDoubleFunction
- FromJavaIntToLongFunction
- FromJavaIntUnaryOperator
- FromJavaLongBinaryOperator
- FromJavaLongConsumer
- FromJavaLongFunction
- FromJavaLongPredicate
- FromJavaLongSupplier
- FromJavaLongToDoubleFunction
- FromJavaLongToIntFunction
- FromJavaLongUnaryOperator
- FromJavaObjDoubleConsumer
- FromJavaObjIntConsumer
- FromJavaObjLongConsumer
- FromJavaPredicate
- FromJavaSupplier
- FromJavaToDoubleBiFunction
- FromJavaToDoubleFunction
- FromJavaToIntBiFunction
- FromJavaToIntFunction
- FromJavaToLongBiFunction
- FromJavaToLongFunction
- FromJavaUnaryOperator
- RichBiConsumerAsFunction2
- RichBiFunctionAsFunction2
- RichBiPredicateAsFunction2
- RichBinaryOperatorAsFunction2
- RichBooleanSupplierAsFunction0
- RichConsumerAsFunction1
- RichDoubleBinaryOperatorAsFunction2
- RichDoubleConsumerAsFunction1
- RichDoubleFunctionAsFunction1
- RichDoublePredicateAsFunction1
- RichDoubleSupplierAsFunction0
- RichDoubleToIntFunctionAsFunction1
- RichDoubleToLongFunctionAsFunction1
- RichDoubleUnaryOperatorAsFunction1
- RichFunction0AsBooleanSupplier
- RichFunction0AsDoubleSupplier
- RichFunction0AsIntSupplier
- RichFunction0AsLongSupplier
- RichFunction0AsSupplier
- RichFunction1AsConsumer
- RichFunction1AsDoubleConsumer
- RichFunction1AsDoubleFunction
- RichFunction1AsDoublePredicate
- RichFunction1AsDoubleToIntFunction
- RichFunction1AsDoubleToLongFunction
- RichFunction1AsDoubleUnaryOperator
- RichFunction1AsFunction
- RichFunction1AsIntConsumer
- RichFunction1AsIntFunction
- RichFunction1AsIntPredicate
- RichFunction1AsIntToDoubleFunction
- RichFunction1AsIntToLongFunction
- RichFunction1AsIntUnaryOperator
- RichFunction1AsLongConsumer
- RichFunction1AsLongFunction
- RichFunction1AsLongPredicate
- RichFunction1AsLongToDoubleFunction
- RichFunction1AsLongToIntFunction
- RichFunction1AsLongUnaryOperator
- RichFunction1AsPredicate
- RichFunction1AsToDoubleFunction
- RichFunction1AsToIntFunction
- RichFunction1AsToLongFunction
- RichFunction1AsUnaryOperator
- RichFunction2AsBiConsumer
- RichFunction2AsBiFunction
- RichFunction2AsBiPredicate
- RichFunction2AsBinaryOperator
- RichFunction2AsDoubleBinaryOperator
- RichFunction2AsIntBinaryOperator
- RichFunction2AsLongBinaryOperator
- RichFunction2AsObjDoubleConsumer
- RichFunction2AsObjIntConsumer
- RichFunction2AsObjLongConsumer
- RichFunction2AsToDoubleBiFunction
- RichFunction2AsToIntBiFunction
- RichFunction2AsToLongBiFunction
- RichFunctionAsFunction1
- RichIntBinaryOperatorAsFunction2
- RichIntConsumerAsFunction1
- RichIntFunctionAsFunction1
- RichIntPredicateAsFunction1
- RichIntSupplierAsFunction0
- RichIntToDoubleFunctionAsFunction1
- RichIntToLongFunctionAsFunction1
- RichIntUnaryOperatorAsFunction1
- RichLongBinaryOperatorAsFunction2
- RichLongConsumerAsFunction1
- RichLongFunctionAsFunction1
- RichLongPredicateAsFunction1
- RichLongSupplierAsFunction0
- RichLongToDoubleFunctionAsFunction1
- RichLongToIntFunctionAsFunction1
- RichLongUnaryOperatorAsFunction1
- RichObjDoubleConsumerAsFunction2
- RichObjIntConsumerAsFunction2
- RichObjLongConsumerAsFunction2
- RichPredicateAsFunction1
- RichSupplierAsFunction0
- RichToDoubleBiFunctionAsFunction2
- RichToDoubleFunctionAsFunction1
- RichToIntBiFunctionAsFunction2
- RichToIntFunctionAsFunction1
- RichToLongBiFunctionAsFunction2
- RichToLongFunctionAsFunction1
- RichUnaryOperatorAsFunction1

c

scala.jdk.FunctionWrappers

# RichFunction2AsObjIntConsumer

###

#### final class RichFunction2AsObjIntConsumer[T] extends AnyVal

Source
  FunctionWrappers.scala

Linear Supertypes
AnyVal, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RichFunction2AsObjIntConsumer
2. AnyVal
3. 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 RichFunction2AsObjIntConsumer(underlying: (T, Int) => Unit)

### 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
     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
     Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toany2stringadd[RichFunction2AsObjIntConsumer[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (RichFunction2AsObjIntConsumer[T], B)
   Implicit
     This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toArrowAssoc[RichFunction2AsObjIntConsumer[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. 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
     Any
6.  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

7.  def asJava: ObjIntConsumer[T]
   Annotations
     @inline()
8.  def asJavaObjIntConsumer: ObjIntConsumer[T]
   Annotations
     @inline()
9.  def ensuring(cond: (RichFunction2AsObjIntConsumer[T]) => Boolean, msg: => Any): RichFunction2AsObjIntConsumer[T]
   Implicit
     This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toEnsuring[RichFunction2AsObjIntConsumer[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (RichFunction2AsObjIntConsumer[T]) => Boolean): RichFunction2AsObjIntConsumer[T]
    Implicit
      This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toEnsuring[RichFunction2AsObjIntConsumer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): RichFunction2AsObjIntConsumer[T]
    Implicit
      This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toEnsuring[RichFunction2AsObjIntConsumer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): RichFunction2AsObjIntConsumer[T]
    Implicit
      This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toEnsuring[RichFunction2AsObjIntConsumer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def getClass(): Class[_ <: AnyVal]

    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
      AnyVal → Any
14.  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.

15.  def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    Definition Classes
      Any

### Deprecated Value Members

1.  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 RichFunction2AsObjIntConsumer[T] toStringFormat[RichFunction2AsObjIntConsumer[T]] 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.

2.  def →[B](y: B): (RichFunction2AsObjIntConsumer[T], B)
   Implicit
     This member is added by an implicit conversion from RichFunction2AsObjIntConsumer[T] toArrowAssoc[RichFunction2AsObjIntConsumer[T]] 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 AnyVal

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromRichFunction2AsObjIntConsumer[T] to any2stringadd[RichFunction2AsObjIntConsumer[T]]

### Inherited by implicit conversion StringFormat fromRichFunction2AsObjIntConsumer[T] to StringFormat[RichFunction2AsObjIntConsumer[T]]

### Inherited by implicit conversion Ensuring fromRichFunction2AsObjIntConsumer[T] to Ensuring[RichFunction2AsObjIntConsumer[T]]

### Inherited by implicit conversion ArrowAssoc fromRichFunction2AsObjIntConsumer[T] to ArrowAssoc[RichFunction2AsObjIntConsumer[T]]

### Ungrouped