Trait/Object

scala.sys

Prop

Related Docs: object Prop | package sys

Permalink

trait Prop[+T] extends AnyRef

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.

Source
Prop.scala
Version

2.9

Since

2.9

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Prop
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def clear(): Unit

    Permalink

    Removes the property from the underlying map.

  2. abstract def get: String

    Permalink

    Gets the current string value if any.

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

    returns

    the current string value if any, else the empty string

  3. abstract def isSet: Boolean

    Permalink

    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.

    returns

    whether the map contains the key

  4. abstract def key: String

    Permalink

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

  5. abstract def option: Option[T]

    Permalink

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

  6. abstract def set(newValue: String): String

    Permalink

    Sets the property.

    Sets the property.

    newValue

    the new string value

    returns

    the old value, or null if it was unset.

  7. abstract def setValue[T1 >: T](value: T1): T

    Permalink

    Sets the property with a value of the represented type.

  8. abstract def value: T

    Permalink

    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.

    returns

    the converted value, or zero if not in the map

  9. abstract def zero: T

    Permalink

    A value of type T for use when the property is unset.

    A value of type T for use when the property is unset. The default implementation delivers null for reference types and 0/0.0/false for non-reference types.

    Attributes
    protected