knobs

MutableConfig

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def add(paths: List[KnobsResource]): Task[Unit]

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

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

    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.

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

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

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

    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.

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

    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.

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. val base: BaseConfig

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

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

  14. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  16. def finalize(): Unit

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

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

    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.

  19. def immutable: Task[Config]

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

  20. final def isInstanceOf[T0]: Boolean

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

    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.

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

    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.

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

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. def pretty: Task[String]

    Perform a simple dump of a MutableConfig to a String.

  27. lazy val reload: Task[Unit]

    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.

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

    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.

  29. val root: String

  30. def subconfig(g: Name): MutableConfig

    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.

  31. def subscribe(p: Pattern, h: (Name, Option[CfgValue]) ⇒ Task[Unit]): Task[Unit]

    Subscribe to notifications.

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

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

    Definition Classes
    AnyRef
  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def display: Task[Unit]

    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