Object/Trait

dagr.core.config

Configuration

Related Docs: trait Configuration | package config

Permalink

object Configuration extends ConfigurationLike

Companion object to the Configuration trait that keeps track of all configuration keys that have been requested so that they can be reported later if desired.

Linear Supertypes
ConfigurationLike, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Configuration
  2. ConfigurationLike
  3. LazyLogging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. object Keys

    Permalink
  5. var _config: Config

    Permalink
    Attributes
    protected
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def asType[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink

    Converts the configuration path to the given type.

    Converts the configuration path to the given type. If the requested type is not supported, an exception is thrown. Override this method to support custom types.

    Attributes
    protected
    Definition Classes
    ConfigurationLike
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def commandLineName: String

    Permalink
    Definition Classes
    ConfigurationLike
  10. def config: Config

    Permalink
    Attributes
    protected
    Definition Classes
    Configuration → ConfigurationLike
  11. def configure[T](path: String, defaultValue: T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink

    Looks up a value in the configuration, and if present returns it, otherwise returns the default value provided.

    Looks up a value in the configuration, and if present returns it, otherwise returns the default value provided.

    Definition Classes
    ConfigurationLike
  12. def configure[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink

    Looks up a single value of a specific type in configuration.

    Looks up a single value of a specific type in configuration. If the configuration key does not exist, an exception is thrown. If the requested type is not supported, an exception is thrown.

    Definition Classes
    ConfigurationLike
  13. def configureExecutable(path: String, executable: String): Path

    Permalink

    Attempts to determine the path to an executable, first by looking it up in config, and if that fails, by attempting to locate it on the system path.

    Attempts to determine the path to an executable, first by looking it up in config, and if that fails, by attempting to locate it on the system path. If both fail then an exception is raised.

    path

    the configuration path to look up

    executable

    the default name of the executable

    returns

    An absolute path to the executable to use

    Definition Classes
    ConfigurationLike
  14. def configureExecutableFromBinDirectory(binPath: String, executable: String, subDir: Option[Path] = None): Path

    Permalink

    Attempts to determine the path to an executable.

    Attempts to determine the path to an executable.

    The config path is assumed to be the directory containing the executable. If the config lookup fails, then we attempt to locate it on the system path. If both fail then an exception is raised. No validation is performed that the executable actually exists at the returned path.

    binPath

    the configuration path to look up, representing the directory containing the executable

    executable

    the default name of the executable

    subDir

    optionally a sub-directory within the bin-directory containing the executable.

    returns

    An absolute path to the executable to use

    Definition Classes
    ConfigurationLike
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. def initialize(customConfig: Config): Unit

    Permalink

    Allows initialization with a custom configuration.

    Allows initialization with a custom configuration.

    Attributes
    protected
  21. def initialize(path: Option[Path]): Unit

    Permalink

    Initialize the configuration by loading configuration from the supplied path, and combining it with configuration information from the system properties (higher priority), application.conf and reference.conf files (lower priority).

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def optionallyConfigure[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]

    Permalink

    Optionally accesses a configuration value.

    Optionally accesses a configuration value. If the value is not present in the configuration a None will be returned, else a Some(T) of the appropriate type.

    Definition Classes
    ConfigurationLike
  28. def requestedKeys: SortedSet[String]

    Permalink

    Returns a sorted set of all keys that have been requested up to this point in time.

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

    Permalink
    Definition Classes
    AnyRef
  30. def systemPath: Seq[Path]

    Permalink

    Grabs the config key "PATH" which, if not defined in config will default to the environment variable PATH, splits it on the path separator and returns it as a Seq[String]

    Grabs the config key "PATH" which, if not defined in config will default to the environment variable PATH, splits it on the path separator and returns it as a Seq[String]

    Attributes
    protected
    Definition Classes
    ConfigurationLike
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

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

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

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

Inherited from ConfigurationLike

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped