trait AsScalaConverters extends AnyRef
Defines converter methods from Java to Scala collections. These methods are available through the scala.jdk.javaapi.CollectionConverters object.
- Source
- AsScalaConverters.scala
- Alphabetic
- By Inheritance
- AsScalaConverters
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- 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
- final def ##: Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toany2stringadd[AsScalaConverters] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AsScalaConverters, B)
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toArrowAssoc[AsScalaConverters] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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
- final def asInstanceOf[T0]: T0
Cast the receiver object to be of type
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 aClassCastException
at runtime, while the expressionList(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 asScala(p: Properties): mutable.Map[String, String]
Converts a Java
Properties
to a Scala mutableMap[String, String]
.Converts a Java
Properties
to a Scala mutableMap[String, String]
.The returned Scala
Map[String, String]
is backed by the provided JavaProperties
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.- p
The Java
Properties
to be converted.- returns
A Scala mutable
Map[String, String]
view of the argument.
- def asScala[A, B](d: Dictionary[A, B]): mutable.Map[A, B]
Converts a Java
Dictionary
to a Scala mutableMap
.Converts a Java
Dictionary
to a Scala mutableMap
.The returned Scala
Map
is backed by the provided JavaDictionary
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Dictionary
was previously obtained from an implicit or explicit call ofasJavaDictionary
then the original ScalaMap
will be returned.- d
The Java
Dictionary
to be converted.- returns
A Scala mutable
Map
view of the argument.
- def asScala[A, B](m: ConcurrentMap[A, B]): concurrent.Map[A, B]
Converts a Java
ConcurrentMap
to a Scala mutableConcurrentMap
.Converts a Java
ConcurrentMap
to a Scala mutableConcurrentMap
.The returned Scala
ConcurrentMap
is backed by the provided JavaConcurrentMap
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
ConcurrentMap
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaConcurrentMap
will be returned.- m
The Java
ConcurrentMap
to be converted.- returns
A Scala mutable
ConcurrentMap
view of the argument.
- def asScala[A, B](m: java.util.Map[A, B]): mutable.Map[A, B]
Converts a Java
Map
to a Scala mutableMap
.Converts a Java
Map
to a Scala mutableMap
.The returned Scala
Map
is backed by the provided JavaMap
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Map
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaMap
will be returned.If the wrapped map is synchronized (e.g. from
java.util.Collections.synchronizedMap
), it is your responsibility to wrap all non-atomic operations withunderlying.synchronized
. This includesget
, asjava.util.Map
's API does not allow for an atomicget
whennull
values may be present.- m
The Java
Map
to be converted.- returns
A Scala mutable
Map
view of the argument.
- def asScala[A](s: java.util.Set[A]): mutable.Set[A]
Converts a Java
Set
to a Scala mutableSet
.Converts a Java
Set
to a Scala mutableSet
.The returned Scala
Set
is backed by the provided JavaSet
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Set
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaSet
will be returned.- s
The Java
Set
to be converted.- returns
A Scala mutable
Set
view of the argument.
- def asScala[A](l: java.util.List[A]): Buffer[A]
Converts a Java
List
to a Scala mutableBuffer
.Converts a Java
List
to a Scala mutableBuffer
.The returned Scala
Buffer
is backed by the provided JavaList
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
List
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaBuffer
will be returned.- l
The Java
List
to be converted.- returns
A Scala mutable
Buffer
view of the argument.
- def asScala[A](c: Collection[A]): Iterable[A]
Converts a Java
Collection
to a ScalaIterable
.Converts a Java
Collection
to a ScalaIterable
.If the Java
Collection
was previously obtained from an implicit or explicit call ofasJavaCollection
then the original ScalaIterable
will be returned.- c
The Java
Collection
to be converted.- returns
A Scala
Iterable
view of the argument.
- def asScala[A](i: java.lang.Iterable[A]): Iterable[A]
Converts a Java
Iterable
to a ScalaIterable
.Converts a Java
Iterable
to a ScalaIterable
.The returned Scala
Iterable
is backed by the provided JavaIterable
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Iterable
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaIterable
will be returned.- i
The Java
Iterable
to be converted.- returns
A Scala
Iterable
view of the argument.
- def asScala[A](e: java.util.Enumeration[A]): Iterator[A]
Converts a Java
Enumeration
to a ScalaIterator
.Converts a Java
Enumeration
to a ScalaIterator
.The returned Scala
Iterator
is backed by the provided JavaEnumeration
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Enumeration
was previously obtained from an implicit or explicit call ofasJavaEnumeration
then the original ScalaIterator
will be returned.- e
The Java
Enumeration
to be converted.- returns
A Scala
Iterator
view of the argument.
- def asScala[A](i: java.util.Iterator[A]): Iterator[A]
Converts a Java
Iterator
to a ScalaIterator
.Converts a Java
Iterator
to a ScalaIterator
.The returned Scala
Iterator
is backed by the provided JavaIterator
and any side-effects of using it via the Scala interface will be visible via the Java interface and vice versa.If the Java
Iterator
was previously obtained from an implicit or explicit call ofasJava
then the original ScalaIterator
will be returned.- i
The Java
Iterator
to be converted.- returns
A Scala
Iterator
view of the argument.
- 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.
- def ensuring(cond: (AsScalaConverters) => Boolean, msg: => Any): AsScalaConverters
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toEnsuring[AsScalaConverters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AsScalaConverters) => Boolean): AsScalaConverters
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toEnsuring[AsScalaConverters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AsScalaConverters
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toEnsuring[AsScalaConverters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AsScalaConverters
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toEnsuring[AsScalaConverters] 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
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
- It is consistent: for any non-null instances
- def equals(arg0: AnyRef): Boolean
The equality method for reference types.
- 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 betweenfinalize
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
- final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- def hashCode(): Int
The hashCode method for reference types.
- 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 returnstrue
if the value of the receiver object is aBigDecimal
or a subtype ofBigDecimal
.T0
is a parameterized class type, e.g.List[Int]
: this method returnstrue
if the value of the receiver object is someList[X]
for anyX
. For example,List(1, 2, 3).isInstanceOf[List[String]]
will return true.T0
is some singleton typex.type
or literalx
: this method returnsthis.eq(x)
. For example,x.isInstanceOf[1]
is equivalent tox.eq(1)
T0
is an intersectionX with Y
orX & Y: this method is equivalent to
x.isInstanceOf[X] && x.isInstanceOf[Y]T0
is a unionX | Y
: this method is equivalent tox.isInstanceOf[X] || x.isInstanceOf[Y]
T0
is a type parameter or an abstract type member: this method is equivalent toisInstanceOf[U]
whereU
isT0
's upper bound,Any
ifT0
is unbounded. For example,x.isInstanceOf[A]
whereA
is an unbounded type parameter will return true for any value ofx
.
This is exactly equivalent to the type pattern
_: T0
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
- Note
due to the unexpectedness of
List(1, 2, 3).isInstanceOf[List[String]]
returning true andx.isInstanceOf[A]
whereA
is a type parameter or abstract member returning true, these forms issue a warning.
- 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
- 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
- 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
- final def synchronized[T0](arg0: => T0): T0
Executes the code in
body
with an exclusive lock onthis
.Executes the code in
body
with an exclusive lock onthis
.- returns
the result of
body
- Definition Classes
- AnyRef
- 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
- final def wait(): Unit
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
- final def wait(arg0: Long, arg1: Int): Unit
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
- final def wait(arg0: Long): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
Deprecated Value Members
- 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 forString.format
(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from AsScalaConverters toStringFormat[AsScalaConverters] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AsScalaConverters, B)
- Implicit
- This member is added by an implicit conversion from AsScalaConverters toArrowAssoc[AsScalaConverters] 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.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
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 frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther 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 forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.