Prop

scala.sys.Prop
See theProp companion object
trait Prop[+T]

A lightweight interface wrapping a property contained in some unspecified map. Generally it'll be the system properties but this is not a requirement.

See scala.sys.SystemProperties for an example usage.

Attributes

Companion
object
Source
Prop.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BooleanProp

Members list

Value members

Abstract methods

def clear(): Unit

Removes the property from the underlying map.

Removes the property from the underlying map.

Attributes

Source
Prop.scala
def get: String

Gets the current string value if any.

Gets the current string value if any. Will not return null: use isSet to test for existence.

Attributes

Returns

the current string value if any, else the empty string

Source
Prop.scala
def isSet: Boolean

True if the key exists in the properties map.

True if the key exists in the properties map. Note that this is not sufficient for a Boolean property to be considered true.

Attributes

Returns

whether the map contains the key

Source
Prop.scala
def key: String

The full name of the property, e.g., "java.awt.headless".

The full name of the property, e.g., "java.awt.headless".

Attributes

Source
Prop.scala
def option: Option[T]

Some(value) if the property is set, None otherwise.

Some(value) if the property is set, None otherwise.

Attributes

Source
Prop.scala
def set(newValue: String): String

Sets the property.

Sets the property.

Value parameters

newValue

the new string value

Attributes

Returns

the old value, or null if it was unset.

Source
Prop.scala
def setValue[T1 >: T](value: T1): T

Sets the property with a value of the represented type.

Sets the property with a value of the represented type.

Attributes

Source
Prop.scala
def value: T

If the key exists in the properties map, converts the value to type T using valueFn.

If the key exists in the properties map, converts the value to type T using valueFn. As yet no validation is performed: it will throw an exception on a failed conversion.

Attributes

Returns

the converted value, or zero if not in the map

Source
Prop.scala