Class

knobs

MutableConfig

Related Doc: package knobs

Permalink

case class MutableConfig(root: String, base: BaseConfig) extends Product with Serializable

Mutable, reloadable, configuration data

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MutableConfig(root: String, base: BaseConfig)

    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. def add(paths: List[KnobsResource]): Task[Unit]

    Permalink

    Add additional files to this MutableConfig, causing it to be reloaded to add their contents.

  5. def addEnv(props: Env): Task[Unit]

    Permalink

    Add the properties in the given pure environment to this config.

    Add the properties in the given pure environment to this config. Note: If this config is reloaded from source, these additional properties will be lost.

  6. def addGroups(paths: List[(Name, KnobsResource)]): Task[Unit]

    Permalink

    Add additional files to named groups in this MutableConfig, causing it to be reloaded to add their contents.

  7. def addMap[V](props: Map[Name, V])(implicit arg0: Valuable[V]): Task[Unit]

    Permalink

    Add the properties in the given Map to this config.

    Add the properties in the given Map to this config. The values will be converted to CfgValues according to their Valuable instance. Note: If this config is reloaded from source, these additional properties will be lost.

  8. def addStrings(props: Map[Name, String]): Task[Unit]

    Permalink

    Add the properties in the given Map to this config.

    Add the properties in the given Map to this config. The String values will be parsed into CfgValues. Note: If this config is reloaded from source, these additional properties will be lost.

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. val base: BaseConfig

    Permalink
  11. def changes(p: Pattern): Process[Task, (Name, Option[CfgValue])]

    Permalink

    A process that produces chages to the configuration properties that match the given pattern

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getEnv: Task[Env]

    Permalink

    Fetch the Map that maps names to values.

    Fetch the Map that maps names to values. Turns the config into a pure value disconnected from the file resources it came from.

  17. def immutable: Task[Config]

    Permalink

    Get an immutable Config from of the current state of this MutableConfig.

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def lookup[A](name: Name)(implicit arg0: Configured[A]): Task[Option[A]]

    Permalink

    Look up a name in the MutableConfig.

    Look up a name in the MutableConfig. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwise None.

  20. def lookupDefault[A](default: A, name: Name)(implicit arg0: Configured[A]): Task[A]

    Permalink

    Look up a name in the MutableConfig.

    Look up a name in the MutableConfig. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwise return the default value.

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

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def pretty: Task[String]

    Permalink

    Perform a simple dump of a MutableConfig to a String.

  25. lazy val reload: Task[Unit]

    Permalink

    Forcibly reload this MutableConfig from sources.

    Forcibly reload this MutableConfig from sources. Throws an exception on error, such as * if files no longer exist or contain errors. If the provided MutableConfig is a subconfig, this will reload the entire top-level configuration, not just the local section. Any overridden properties set with addProperties will disappear.

  26. def require[A](name: Name)(implicit arg0: Configured[A]): Task[A]

    Permalink

    Look up a name in the MutableConfig.

    Look up a name in the MutableConfig. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwise throw a KeyError.

  27. val root: String

    Permalink
  28. def subconfig(g: Name): MutableConfig

    Permalink

    Gives a MutableConfig corresponding to just a single group of the original MutableConfig.

    Gives a MutableConfig corresponding to just a single group of the original MutableConfig. The subconfig can be used just like the original.

  29. def subscribe(p: Pattern, h: ChangeHandler): Task[Unit]

    Permalink

    Subscribe to notifications.

    Subscribe to notifications. The given handler will be invoked when any change occurs to a configuration property that matches the pattern.

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

    Permalink
    Definition Classes
    AnyRef
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

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

Deprecated Value Members

  1. def display: Task[Unit]

    Permalink

    Perform a simple dump of a MutableConfig to the console.

    Perform a simple dump of a MutableConfig to the console.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use pretty instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped