object Properties extends PropertiesTrait
- Alphabetic
- By Inheritance
- Properties
- PropertiesTrait
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
- final def ##: Int
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- AnyRef → Any
- val ScalaCompilerVersion: Name
Scala manifest attributes.
- 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
asInstanceOfhas any effect at runtime. It might do a runtime type test on the erasure ofT0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.In particular,
asInstanceOfis 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
asInstanceOfis useful:- when flow analysis fails to deduce
T0automatically - 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
asInstanceOfwhenT0is a primitive type. WhenT0is primitive,asInstanceOfmay insert a conversion instead of a type test. If your intent is to convert, use atoTmethod (x.toChar,x.toByte, etc.).- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastExceptionif the receiver is not an instance of the erasure ofT0, if that can be checked on this platform
- when flow analysis fails to deduce
- def clearProp(name: String): String
- Definition Classes
- PropertiesTrait
- def clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clonemethod is platform dependent.- returns
a copy of the receiver object.
- val copyrightString: String
- Definition Classes
- PropertiesTrait
- val developmentVersion: Option[String]
The version of the Scala runtime, if this is a snapshot.
The version of the Scala runtime, if this is a snapshot.
- Definition Classes
- PropertiesTrait
- def encodingString: String
This is the default text encoding, overridden (unreliably) with
JAVA_OPTS="-Dfile.encoding=Foo"This is the default text encoding, overridden (unreliably) with
JAVA_OPTS="-Dfile.encoding=Foo"- Definition Classes
- PropertiesTrait
- def envOrElse(name: String, alt: => String): String
- Definition Classes
- PropertiesTrait
- def envOrNone(name: String): Option[String]
- Definition Classes
- PropertiesTrait
- def envOrSome(name: String, alt: => Option[String]): Option[String]
- Definition Classes
- PropertiesTrait
- 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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
trueif the argument is a reference to the receiver object;falseotherwise.
- 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
finalizemethod is invoked, as well as the interaction betweenfinalizeand 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
T0is, the test is done in one of the below ways:T0is a non-parameterized class type, e.g.BigDecimal: this method returnstrueif the value of the receiver object is aBigDecimalor a subtype ofBigDecimal.T0is a parameterized class type, e.g.List[Int]: this method returnstrueif the value of the receiver object is someList[X]for anyX. For example,List(1, 2, 3).isInstanceOf[List[String]]will return true.T0is some singleton typex.typeor literalx: this method returnsthis.eq(x). For example,x.isInstanceOf[1]is equivalent tox.eq(1)T0is an intersectionX with YorX & Y: this method is equivalent tox.isInstanceOf[X] && x.isInstanceOf[Y]T0is a unionX | Y: this method is equivalent tox.isInstanceOf[X] || x.isInstanceOf[Y]T0is a type parameter or an abstract type member: this method is equivalent toisInstanceOf[U]whereUisT0's upper bound,AnyifT0is unbounded. For example,x.isInstanceOf[A]whereAis an unbounded type parameter will return true for any value ofx.
This is exactly equivalent to the type pattern
_: T0- returns
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
- Note
due to the unexpectedness of
List(1, 2, 3).isInstanceOf[List[String]]returning true andx.isInstanceOf[A]whereAis a type parameter or abstract member returning true, these forms issue a warning.
- def isJavaAtLeast(version: Int): Boolean
Compares the given specification version to the major version of the platform.
Compares the given specification version to the major version of the platform.
- version
a specification major version number
- Definition Classes
- PropertiesTrait
- def isJavaAtLeast(version: String): Boolean
Compares the given specification version to the specification version of the platform.
Compares the given specification version to the specification version of the platform.
- version
a specification version number (legacy forms acceptable)
- returns
trueif the specification version of the current runtime is equal to or higher than the version denoted by the given string.
- Definition Classes
- PropertiesTrait
// In this example, the runtime's Java specification is assumed to be at version 8. isJavaAtLeast("1.8") // true isJavaAtLeast("8") // true isJavaAtLeast("9") // false isJavaAtLeast("9.1") // false isJavaAtLeast("1.9") // throws
- Exceptions thrown
NumberFormatExceptionif the given string is not a version string
Example: - lazy val isLinux: Boolean
Returns
trueiff the underlying operating system is a Linux distribution.Returns
trueiff the underlying operating system is a Linux distribution.- Definition Classes
- PropertiesTrait
- lazy val isMac: Boolean
Returns
trueiff the underlying operating system is a version of Apple Mac OSX.Returns
trueiff the underlying operating system is a version of Apple Mac OSX.- Definition Classes
- PropertiesTrait
- lazy val isWin: Boolean
Returns
trueiff the underlying operating system is a version of Microsoft Windows.Returns
trueiff the underlying operating system is a version of Microsoft Windows.- Definition Classes
- PropertiesTrait
- def javaClassPath: String
- Definition Classes
- PropertiesTrait
- def javaHome: String
- Definition Classes
- PropertiesTrait
- def javaSpecName: String
- Definition Classes
- PropertiesTrait
- def javaSpecVendor: String
- Definition Classes
- PropertiesTrait
- def javaSpecVersion: String
- Definition Classes
- PropertiesTrait
- def javaVendor: String
- Definition Classes
- PropertiesTrait
- def javaVersion: String
- Definition Classes
- PropertiesTrait
- def javaVmInfo: String
- Definition Classes
- PropertiesTrait
- def javaVmName: String
- Definition Classes
- PropertiesTrait
- def javaVmVendor: String
- Definition Classes
- PropertiesTrait
- def javaVmVersion: String
- Definition Classes
- PropertiesTrait
- def jdkHome: String
- Definition Classes
- PropertiesTrait
- def lineSeparator: String
The default end of line character.
The default end of line character.
- Definition Classes
- PropertiesTrait
- def main(args: Array[String]): Unit
- Definition Classes
- PropertiesTrait
- final def ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
- def osName: String
- Definition Classes
- PropertiesTrait
- def pickJarBasedOn: Class[Option[_]]
- Attributes
- protected
- Definition Classes
- Properties → PropertiesTrait
- def propCategory: String
- Attributes
- protected
- Definition Classes
- Properties → PropertiesTrait
- val propFilename: String
The name of the properties file
The name of the properties file
- Attributes
- protected
- Definition Classes
- PropertiesTrait
- def propIsSet(name: String): Boolean
- Definition Classes
- PropertiesTrait
- def propIsSetTo(name: String, value: String): Boolean
- Definition Classes
- PropertiesTrait
- def propOrElse(name: String, alt: => String): String
- Definition Classes
- PropertiesTrait
- def propOrEmpty(name: String): String
- Definition Classes
- PropertiesTrait
- def propOrFalse(name: String): Boolean
- Definition Classes
- PropertiesTrait
- def propOrNone(name: String): Option[String]
- Definition Classes
- PropertiesTrait
- def propOrNull(name: String): String
- Definition Classes
- PropertiesTrait
- val releaseVersion: Option[String]
The version of the Scala runtime, if this is not a snapshot.
The version of the Scala runtime, if this is not a snapshot.
- Definition Classes
- PropertiesTrait
- def scalaCmd: String
- Definition Classes
- PropertiesTrait
- def scalaHome: String
- Definition Classes
- PropertiesTrait
- def scalaPropOrElse(name: String, alt: => String): String
- Definition Classes
- PropertiesTrait
- def scalaPropOrEmpty(name: String): String
- Definition Classes
- PropertiesTrait
- def scalaPropOrNone(name: String): Option[String]
- Definition Classes
- PropertiesTrait
- lazy val scalaProps: java.util.Properties
The loaded properties
The loaded properties
- Attributes
- protected
- Definition Classes
- PropertiesTrait
- def scalacCmd: String
- Definition Classes
- PropertiesTrait
- def setProp(name: String, value: String): String
- Definition Classes
- PropertiesTrait
- def sourceEncoding: String
This is the encoding to use reading in source files, overridden with -encoding.
This is the encoding to use reading in source files, overridden with -encoding. Note that it uses "prop" i.e. looks in the scala jar, not the system properties.
- Definition Classes
- PropertiesTrait
- def sourceReader: String
- Definition Classes
- PropertiesTrait
- final def synchronized[T0](arg0: => T0): T0
Executes the code in
bodywith an exclusive lock onthis.Executes the code in
bodywith an exclusive lock onthis.- returns
the result of
body
- Definition Classes
- AnyRef
- def tmpDir: String
- Definition Classes
- PropertiesTrait
- 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
- def userDir: String
- Definition Classes
- PropertiesTrait
- def userHome: String
- Definition Classes
- PropertiesTrait
- def userName: String
- Definition Classes
- PropertiesTrait
- def versionMsg: String
- Definition Classes
- PropertiesTrait
- def versionNumberString: String
The version of the Scala runtime, or the empty string if unknown.
The version of the Scala runtime, or the empty string if unknown.
Note that the version of the Scala library need not correlate with the version of the Scala compiler used to emit either the library or user code.
For example, Scala 3.0 and 3.1 use the Scala 2.13 library, which is reflected in this version string. For the Dotty version, see
dotty.tools.dotc.config.Properties.versionNumberString.- Definition Classes
- PropertiesTrait
- val versionString: String
A verbose alternative to versionNumberString.
A verbose alternative to versionNumberString.
- Definition Classes
- PropertiesTrait
- 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-.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.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.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.