Class

scalismo.ui.settings

PersistentSettings

Related Doc: package settings

Permalink

class PersistentSettings extends AnyRef

High-level abstraction for storing user preferences / settings.

Settings are identified by keys, and can have one or more values. Values can be of any type, as long as a codec for that type is defined below, or in a type class provided by the user.

Applications can define their own keys; to avoid name clashes, keys should have package-like names. "common" is reserved for the keys defined in the GlobalSettings source file.

Linear Supertypes
AnyRef, Any
Known Subclasses
GlobalSettings
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PersistentSettings(settingsFile: SettingsFile)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. def get[A](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[A], arg1: Codec[A]): Option[A]

    Permalink

    Returns a single-valued setting, wrapped in an Option.

    Returns a single-valued setting, wrapped in an Option. Returns None if the key is not found, or an error occured.

    If multiple values with this key are present, the first is returned.

    A

    type of the setting's value.

    key

    settings key

    returns

    the first value with the appropriate key, or None on error/not found.

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def getList[A](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[A], arg1: Codec[A]): Option[List[A]]

    Permalink

    Returns a multi-valued setting, wrapped in an Option.

    Returns a multi-valued setting, wrapped in an Option.

    Returns an empty list if the key is not found, None if an error occurred.

    A

    type of the setting's value

    key

    settings key

    returns

    all values for the key, or None on error.

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. def set[A](key: String, value: A)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[A], arg1: Codec[A]): Try[Unit]

    Permalink

    Sets a single-valued setting.

    Sets a single-valued setting.

    All previous settings for the respective key are discarded and replaced by the new value.

    A

    type of the setting's value.

    key

    settings key

    value

    settings value

    returns

    Failure on error, Success otherwise

  18. def setList[A](key: String, values: List[A])(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[A], arg1: Codec[A]): Try[Unit]

    Permalink

    Sets a multi-valued setting.

    Sets a multi-valued setting.

    All previous settings for the respective key are discarded and replaced by the new values.

    A

    type of the setting's values.

    key

    settings key

    values

    settings values

    returns

    Failure on error, Success otherwise

  19. val settingsFile: SettingsFile

    Permalink

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped