Packages

o

scala.util

Properties

object Properties extends PropertiesTrait

Loads library.properties from the jar.

Source
Properties.scala
Linear Supertypes
PropertiesTrait, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Properties
  2. PropertiesTrait
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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
    AnyRef → 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
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    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
  4. val ScalaCompilerVersion: Name

    Scala manifest attributes.

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

  6. def clearProp(name: String): String
    Definition Classes
    PropertiesTrait
  7. 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.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  8. val copyrightString: String
    Definition Classes
    PropertiesTrait
  9. 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
  10. 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
  11. def envOrElse(name: String, alt: => String): String
    Definition Classes
    PropertiesTrait
  12. def envOrNone(name: String): Option[String]
    Definition Classes
    PropertiesTrait
  13. def envOrSome(name: String, alt: => Option[String]): Option[String]
    Definition Classes
    PropertiesTrait
  14. 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 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
  15. def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

    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
  16. 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 between finalize 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

  17. final def getClass(): Class[_ <: AnyRef]

    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
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int

    The hashCode method for reference types.

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

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

    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:
    1. // 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

  22. lazy val isLinux: Boolean

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

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

    Definition Classes
    PropertiesTrait
  23. lazy val 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.

    Definition Classes
    PropertiesTrait
  24. lazy val 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.

    Definition Classes
    PropertiesTrait
  25. def javaClassPath: String
    Definition Classes
    PropertiesTrait
  26. def javaHome: String
    Definition Classes
    PropertiesTrait
  27. def javaSpecName: String
    Definition Classes
    PropertiesTrait
  28. def javaSpecVendor: String
    Definition Classes
    PropertiesTrait
  29. def javaSpecVersion: String
    Definition Classes
    PropertiesTrait
  30. def javaVendor: String
    Definition Classes
    PropertiesTrait
  31. def javaVersion: String
    Definition Classes
    PropertiesTrait
  32. def javaVmInfo: String
    Definition Classes
    PropertiesTrait
  33. def javaVmName: String
    Definition Classes
    PropertiesTrait
  34. def javaVmVendor: String
    Definition Classes
    PropertiesTrait
  35. def javaVmVersion: String
    Definition Classes
    PropertiesTrait
  36. def jdkHome: String
    Definition Classes
    PropertiesTrait
  37. def lineSeparator: String

    The default end of line character.

    The default end of line character.

    Definition Classes
    PropertiesTrait
  38. def main(args: Array[String]): Unit
    Definition Classes
    PropertiesTrait
  39. 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
  40. 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

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

  42. def osName: String
    Definition Classes
    PropertiesTrait
  43. def pickJarBasedOn: Class[Option[_]]
    Attributes
    protected
    Definition Classes
    Properties → PropertiesTrait
  44. def propCategory: String
    Attributes
    protected
    Definition Classes
    Properties → PropertiesTrait
  45. val propFilename: String

    The name of the properties file

    The name of the properties file

    Attributes
    protected
    Definition Classes
    PropertiesTrait
  46. def propIsSet(name: String): Boolean
    Definition Classes
    PropertiesTrait
  47. def propIsSetTo(name: String, value: String): Boolean
    Definition Classes
    PropertiesTrait
  48. def propOrElse(name: String, alt: => String): String
    Definition Classes
    PropertiesTrait
  49. def propOrEmpty(name: String): String
    Definition Classes
    PropertiesTrait
  50. def propOrFalse(name: String): Boolean
    Definition Classes
    PropertiesTrait
  51. def propOrNone(name: String): Option[String]
    Definition Classes
    PropertiesTrait
  52. def propOrNull(name: String): String
    Definition Classes
    PropertiesTrait
  53. 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
  54. def scalaCmd: String
    Definition Classes
    PropertiesTrait
  55. def scalaHome: String
    Definition Classes
    PropertiesTrait
  56. def scalaPropOrElse(name: String, alt: => String): String
    Definition Classes
    PropertiesTrait
  57. def scalaPropOrEmpty(name: String): String
    Definition Classes
    PropertiesTrait
  58. def scalaPropOrNone(name: String): Option[String]
    Definition Classes
    PropertiesTrait
  59. lazy val scalaProps: java.util.Properties

    The loaded properties

    The loaded properties

    Attributes
    protected
    Definition Classes
    PropertiesTrait
  60. def scalacCmd: String
    Definition Classes
    PropertiesTrait
  61. def setProp(name: String, value: String): String
    Definition Classes
    PropertiesTrait
  62. 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
  63. def sourceReader: String
    Definition Classes
    PropertiesTrait
  64. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  65. def tmpDir: String
    Definition Classes
    PropertiesTrait
  66. 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
  67. def userDir: String
    Definition Classes
    PropertiesTrait
  68. def userHome: String
    Definition Classes
    PropertiesTrait
  69. def userName: String
    Definition Classes
    PropertiesTrait
  70. def versionMsg: String
    Definition Classes
    PropertiesTrait
  71. 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
  72. val versionString: String

    A verbose alternative to versionNumberString.

    A verbose alternative to versionNumberString.

    Definition Classes
    PropertiesTrait
  73. 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

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

  75. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

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

    not specified by SLS as a member of AnyRef

Inherited from PropertiesTrait

Inherited from AnyRef

Inherited from Any

Ungrouped