Object scala.util.Properties

object Properties extends PropertiesTrait

Loads library.properties from the jar.

Source
Properties.scala
Linear Supertypes
PropertiesTrait, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

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 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

final def ==(arg0: Any): Boolean

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

val ScalaCompilerVersion: Name

final def asInstanceOf[T0]: 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 a ClassCastException at runtime, while the expression List(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 type T0.

def clearProp(name: String): String

Definition Classes
PropertiesTrait

def clone(): AnyRef

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

not specified by SLS as a member of AnyRef

val copyrightString: String

Definition Classes
PropertiesTrait

val developmentVersion: Option[String]

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.

Definition Classes
PropertiesTrait

def encodingString: String

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).

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

def equals(arg0: AnyRef): Boolean

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

def finalize(): Unit

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[java.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.

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def hashCode(): Int

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()

final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is T0.

Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. 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 specified type.

returns

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

Definition Classes
Any

def isJavaAtLeast(version: Int): Boolean

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.

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.

Definition Classes
PropertiesTrait
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
Exceptions thrown

NumberFormatException if the given string is not a version string

def isLinux: Boolean

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

Definition Classes
PropertiesTrait

def isMac: Boolean

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

Definition Classes
PropertiesTrait

def isWin: Boolean

Returns true iff 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.

Definition Classes
PropertiesTrait

def main(args: Array[String]): Unit

Definition Classes
PropertiesTrait

final def ne(arg0: AnyRef): Boolean

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.

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.

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

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

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

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

Definition Classes
AnyRef

def tmpDir: String

Definition Classes
PropertiesTrait

def toString(): String

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

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

Definition Classes
PropertiesTrait

val versionString: String

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

Definition Classes
PropertiesTrait

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/util/Properties$.html