trait Configuration extends ConfigurationMergeable

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

Abstract Value Members

  1. abstract def ++(other: Configuration): Configuration
  2. abstract def checkValid(reference: Configuration, restrictToPaths: String*): Try[Unit]
  3. abstract def entrySet: Set[(String, ConfigValue)]

    Returns every key as a set of key to value pairs, by recursively iterating through the config objects.

  4. abstract def getBooleanValue(key: String): Option[Boolean]

    Retrieves a configuration value as a Boolean.

    Retrieves a configuration value as a Boolean.

    For example:

    val configuration = Configuration.load()
val isEnabled = configuration.getString("engine.isEnabled")

    A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized vales are yes/no or true/false.

    key

    the configuration key, relative to the configuration root key

    returns

    a configuration value

  5. abstract def getBooleanValues(key: String): Option[Seq[Boolean]]

    Retrieves a configuration value as a List of Boolean.

    Retrieves a configuration value as a List of Boolean.

    For example:

    val configuration = Configuration.load()
val switches = configuration.getBooleanList("board.switches")

    The configuration must be provided as:

    board.switches = [true, true, false]

    A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized vales are yes/no or true/false.

  6. abstract def getByteValue(key: String): Option[Long]

    Retrieves a configuration value as Bytes.

    Retrieves a configuration value as Bytes.

    For example:

    val configuration = Configuration.load()
val maxSize = configuration.getString("engine.maxSize")

    The configuration must be provided as:

    engine.maxSize = 512k
  7. abstract def getByteValues(key: String): Option[Seq[Long]]

    Retrieves a configuration value as a List of Bytes.

    Retrieves a configuration value as a List of Bytes.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getBytesList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [512k, 256k, 256k]
  8. abstract def getConfiguration(key: String): Option[Configuration]

    Retrieves a sub-configuration, i.e.

    Retrieves a sub-configuration, i.e. a configuration instance containing all keys starting with a given prefix.

    For example:

    val configuration = Configuration.load()
val engineConfig = configuration.getSub("engine")

    The root key of this new configuration will be ‘engine’, and you can access any sub-keys relatively.

    key

    the root prefix for this sub-configuration

    returns

    a new configuration

  9. abstract def getConfigurationObject(key: String): Option[ConfigurationObject]

    Retrieves a ConfigObject for this key, which implements Map<String,ConfigValue>

    Retrieves a ConfigObject for this key, which implements Map<String,ConfigValue>

    For example:

    val configuration = Configuration.load()
val engineProperties = configuration.getObject("engine.properties")

    The configuration must be provided as:

    engine.properties = {id: 1, power: 5}
  10. abstract def getConfigurationObjects(key: String): Option[Seq[ConfigurationObject]]

    Retrieves a configuration value as a List of ConfigObject.

    Retrieves a configuration value as a List of ConfigObject.

    For example:

    val configuration = Configuration.load()
val engineProperties = configuration.getObjectList("engine.properties")

    The configuration must be provided as:

    engine.properties = [{id: 5, power: 3}, {id: 6, power: 20}]
  11. abstract def getConfigurationValue(key: String): Option[ConfigurationValue]
  12. abstract def getConfigurationValues(key: String): Option[Seq[ConfigurationValue]]

    Gets a list value (with any element type) as a ConfigList, which implements java.util.List<ConfigValue>.

    Gets a list value (with any element type) as a ConfigList, which implements java.util.List<ConfigValue>.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = ["foo", "bar"]
  13. abstract def getConfigurations(key: String): Option[Seq[Configuration]]

    Retrieves a List of sub-configurations, i.e.

    Retrieves a List of sub-configurations, i.e. a configuration instance for each key that matches the key.

    For example:

    val configuration = Configuration.load()
val engineConfigs = configuration.getConfigList("engine")

    The root key of this new configuration will be "engine", and you can access any sub-keys relatively.

  14. abstract def getDoubleValue(key: String): Option[Double]

    Retrieves a configuration value as a Double.

    Retrieves a configuration value as a Double.

    For example:

    val configuration = Configuration.load()
val population = configuration.getDouble("world.population")

    A configuration error will be thrown if the configuration value is not a valid Double.

    key

    the configuration key, relative to the configuration root key

    returns

    a configuration value

  15. abstract def getDoubleValues(key: String): Option[Seq[Double]]

    Retrieves a configuration value as a List of Double.

    Retrieves a configuration value as a List of Double.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getDoubleList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [5.0, 3.34, 2.6]
  16. abstract def getDurationValue(path: String): Option[FiniteDuration]
  17. abstract def getDurationValue(path: String, unit: TimeUnit): Option[Long]
  18. abstract def getIntValue(key: String): Option[Int]

    Retrieves a configuration value as an Int.

    Retrieves a configuration value as an Int.

    For example:

    val configuration = Configuration.load()
val poolSize = configuration.getInt("engine.pool.size")

    A configuration error will be thrown if the configuration value is not a valid Int.

    key

    the configuration key, relative to the configuration root key

    returns

    a configuration value

  19. abstract def getIntValues(key: String): Option[Seq[Int]]

    Retrieves a configuration value as a List of Integer.

    Retrieves a configuration value as a List of Integer.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getIntList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [100, 500, 2]
  20. abstract def getIsNull(path: String): Try[Boolean]
  21. abstract def getLongValue(key: String): Option[Long]

    Retrieves a configuration value as a Long.

    Retrieves a configuration value as a Long.

    For example:

    val configuration = Configuration.load()
val duration = configuration.getLong("timeout.duration")

    A configuration error will be thrown if the configuration value is not a valid Long.

    key

    the configuration key, relative to the configuration root key

    returns

    a configuration value

  22. abstract def getLongValues(key: String): Option[Seq[Long]]

    Retrieves a configuration value as a List of Long.

    Retrieves a configuration value as a List of Long.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getLongList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [10000000000000, 500, 2000]
  23. abstract def getNumberValue(key: String): Option[Number]

    Retrieves a configuration value as a Number.

    Retrieves a configuration value as a Number.

    For example:

    val configuration = Configuration.load()
val counter = configuration.getNumber("foo.counter")

    A configuration error will be thrown if the configuration value is not a valid Number.

    key

    the configuration key, relative to the configuration root key

    returns

    a configuration value

  24. abstract def getNumberValues(key: String): Option[Seq[Number]]

    Retrieves a configuration value as a List of Number.

    Retrieves a configuration value as a List of Number.

    For example:

    val configuration = Configuration.load()
val maxSizes = configuration.getNumberList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [50, 500, 5000]
  25. abstract def getStringValue(key: String, validValues: Option[Set[String]] = None): Option[String]

    Retrieves a configuration value as a String.

    Retrieves a configuration value as a String.

    This method supports an optional set of valid values:

    val config = Configuration.load()
val mode = config.getString("engine.mode", Some(Set("dev","prod")))

    A configuration error will be thrown if the configuration value does not match any of the required values.

    validValues

    valid values for this configuration

    returns

    a configuration value

  26. abstract def getStringValues(key: String): Option[Seq[String]]

    Retrieves a configuration value as a List of String.

    Retrieves a configuration value as a List of String.

    For example:

    val configuration = Configuration.load()
val names = configuration.getStringList("names")

    The configuration must be provided as:

    names = ["Jim", "Bob", "Steve"]
  27. abstract def hasPath(path: String): Try[Boolean]
  28. abstract def hasPathOrNull(path: String): Try[Boolean]
  29. abstract def isEmpty: Boolean
  30. abstract def isResolved(): Boolean
  31. abstract def keys: Set[String]

    Returns available keys.

    Returns available keys.

    For example:

    val configuration = Configuration.load()
val keys = configuration.keys
    returns

    the set of keys available in this configuration

  32. abstract def resolve(option: ConfigurationResolveOptions): Try[Configuration]
  33. abstract def resolve: Try[Configuration]
  34. abstract def resolveWith(source: Configuration, options: ConfigurationResolveOptions): Try[Configuration]
  35. abstract def resolveWith(source: Configuration): Try[Configuration]
  36. abstract def root: ConfigurationObject
  37. abstract def subKeys: Set[String]

    Returns sub-keys.

    Returns sub-keys.

    For example:

    val configuration = Configuration.load()
val subKeys = configuration.subKeys
    returns

    the set of direct sub-keys available in this configuration

  38. abstract val underlying: Config
    Definition Classes
    Configuration → ConfigurationMergeable
  39. abstract def withFallback(other: ConfigurationMergeable): Configuration
    Definition Classes
    Configuration → ConfigurationMergeable
  40. abstract def withOnlyPath(path: String): Configuration
  41. abstract def withValue(path: String, value: ConfigurationValue): Configuration
  42. abstract def withoutPath(path: String): Configuration
  43. abstract def getMillisecondValue(key: String): Option[Long]

    Retrieves a configuration value as Milliseconds.

    Retrieves a configuration value as Milliseconds.

    For example:

    val configuration = Configuration.load()
val timeout = configuration.getMilliseconds("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
    Annotations
    @deprecated
    Deprecated

    (Since version v0.0.5) it's the old method.

  44. abstract def getMillisecondValues(key: String): Option[Seq[Long]]

    Retrieves a configuration value as List of Milliseconds.

    Retrieves a configuration value as List of Milliseconds.

    For example:

    val configuration = Configuration.load()
val timeouts = configuration.getMillisecondsList("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version v0.0.5) it's the old method.

  45. abstract def getNanosecondValue(key: String): Option[Long]

    Retrieves a configuration value as Nanoseconds.

    Retrieves a configuration value as Nanoseconds.

    For example:

    val configuration = Configuration.load()
val timeout = configuration.getNanoseconds("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
    Annotations
    @deprecated
    Deprecated

    (Since version v0.0.5) it's the old method.

  46. abstract def getNanosecondValues(key: String): Option[Seq[Long]]

    Retrieves a configuration value as List of Nanoseconds.

    Retrieves a configuration value as List of Nanoseconds.

    For example:

    val configuration = Configuration.load()
val timeouts = configuration.getNanosecondsList("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version v0.0.5) it's the old method.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ConfigurationMergeable

Inherited from AnyRef

Inherited from Any

Ungrouped