Scala 3/scala.util/Properties

Properties

object Properties

Loads library.properties from the jar.

Source:
Properties.scala
class Object
trait Matchable
class Any

Value members

Inherited methods

def clearProp(name: String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
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"

Inherited from:
PropertiesTrait
Source:
Properties.scala
def envOrElse(name: String, alt: => String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def envOrNone(name: String): Option[String]
Inherited from:
PropertiesTrait
Source:
Properties.scala
def envOrSome(name: String, alt: => Option[String]): Option[String]
Inherited from:
PropertiesTrait
Source:
Properties.scala
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.

Value parameters:
version

a specification major version number

Inherited from:
PropertiesTrait
Source:
Properties.scala
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.

Value parameters:
version

a specification version number (legacy forms acceptable)

Returns:

true if the specification version of the current runtime is equal to or higher than the version denoted by the given string.

Throws:
NumberFormatException

if the given string is not a version string

Example:

// 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
Inherited from:
PropertiesTrait
Source:
Properties.scala
def isLinux: Boolean

Returns true iff the underlying operating system is a Linux distribution.

Returns true iff the underlying operating system is a Linux distribution.

Inherited from:
PropertiesTrait
Source:
Properties.scala
def isMac: Boolean

Returns true iff the underlying operating system is a version of Apple Mac OSX.

Returns true iff the underlying operating system is a version of Apple Mac OSX.

Inherited from:
PropertiesTrait
Source:
Properties.scala
def isWin: Boolean

Returns true iff the underlying operating system is a version of Microsoft Windows.

Returns true iff the underlying operating system is a version of Microsoft Windows.

Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaClassPath: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaHome: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaSpecName: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaSpecVendor: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaSpecVersion: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVendor: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVersion: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVmInfo: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVmName: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVmVendor: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def javaVmVersion: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def jdkHome: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def lineSeparator: String

The default end of line character.

The default end of line character.

Inherited from:
PropertiesTrait
Source:
Properties.scala
def main(args: Array[String]): Unit
Inherited from:
PropertiesTrait
Source:
Properties.scala
def osName: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propIsSet(name: String): Boolean
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propIsSetTo(name: String, value: String): Boolean
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propOrElse(name: String, alt: => String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propOrEmpty(name: String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propOrFalse(name: String): Boolean
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propOrNone(name: String): Option[String]
Inherited from:
PropertiesTrait
Source:
Properties.scala
def propOrNull(name: String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalaCmd: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalaHome: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalaPropOrElse(name: String, alt: => String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalaPropOrEmpty(name: String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalaPropOrNone(name: String): Option[String]
Inherited from:
PropertiesTrait
Source:
Properties.scala
def scalacCmd: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def setProp(name: String, value: String): String
Inherited from:
PropertiesTrait
Source:
Properties.scala
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.

Inherited from:
PropertiesTrait
Source:
Properties.scala
def sourceReader: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def tmpDir: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def userDir: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def userHome: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def userName: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def versionMsg: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
def versionNumberString: String

Either the development or release version if known, otherwise the empty string.

Either the development or release version if known, otherwise the empty string.

Inherited from:
PropertiesTrait
Source:
Properties.scala

Concrete fields

val ScalaCompilerVersion: Name

Scala manifest attributes.

Scala manifest attributes.

Source:
Properties.scala

Inherited fields

val copyrightString: String
Inherited from:
PropertiesTrait
Source:
Properties.scala
val developmentVersion: Option[String]

The development Scala version, if this is not a final release.

The development Scala version, if this is not a final release. The precise contents are not guaranteed, but it aims to provide a unique repository identifier (currently the svn revision) in the fourth dotted segment if the running version was built from source.

Returns:

Some(version) if this is a non-final version, None if this is a final release or the version cannot be read.

Inherited from:
PropertiesTrait
Source:
Properties.scala
protected val propFilename: String

The name of the properties file

The name of the properties file

Inherited from:
PropertiesTrait
Source:
Properties.scala
val releaseVersion: Option[String]

The numeric portion of the runtime Scala version, if this is a final release.

The numeric portion of the runtime Scala version, if this is a final release. If for instance the versionString says "version 2.9.0.final", this would return Some("2.9.0").

Returns:

Some(version) if this is a final release build, None if it is an RC, Beta, etc. or was built from source, or if the version cannot be read.

Inherited from:
PropertiesTrait
Source:
Properties.scala
lazy protected val scalaProps: Properties

The loaded properties

The loaded properties

Inherited from:
PropertiesTrait
Source:
Properties.scala
val versionString: String

The version number of the jar this was loaded from plus "version " prefix, or "version (unknown)" if it cannot be determined.

The version number of the jar this was loaded from plus "version " prefix, or "version (unknown)" if it cannot be determined.

Inherited from:
PropertiesTrait
Source:
Properties.scala