Configuration

Abstract Value Members

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

Returns every key as a set of key to value pairs, by recursively iterating through the config objects.
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
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.
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
```
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]
```
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
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}
```
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}]
```
abstract def getConfigurationValue(key: String): Option[ConfigurationValue]
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"]
```
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.
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
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]
```
abstract def getDurationValue(path: String): Option[FiniteDuration]
abstract def getDurationValue(path: String, unit: TimeUnit): Option[Long]
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
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]
```
abstract def getIsNull(path: String): Try[Boolean]
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
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]
```
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
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]
```
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
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"]
```
abstract def hasPath(path: String): Try[Boolean]
abstract def hasPathOrNull(path: String): Try[Boolean]
abstract def isEmpty: Boolean
abstract def isResolved(): Boolean
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
abstract def resolve(option: ConfigurationResolveOptions): Try[Configuration]
abstract def resolve: Try[Configuration]
abstract def resolveWith(source: Configuration, options: ConfigurationResolveOptions): Try[Configuration]
abstract def resolveWith(source: Configuration): Try[Configuration]
abstract def root: ConfigurationObject
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
abstract val underlying: Config

Definition Classes
Configuration → ConfigurationMergeable
abstract def withFallback(other: ConfigurationMergeable): Configuration

Definition Classes
Configuration → ConfigurationMergeable
abstract def withOnlyPath(path: String): Configuration
abstract def withValue(path: String, value: ConfigurationValue): Configuration
abstract def withoutPath(path: String): Configuration
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.
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.
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.
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Configuration | package config

trait Configuration extends ConfigurationMergeable

Abstract Value Members

abstract def ++(other: Configuration): Configuration

abstract def checkValid(reference: Configuration, restrictToPaths: String*): Try[Unit]

abstract def entrySet: Set[(String, ConfigValue)]

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

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

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

abstract def getByteValues(key: String): Option[Seq[Long]]

abstract def getConfiguration(key: String): Option[Configuration]

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

abstract def getConfigurationObjects(key: String): Option[Seq[ConfigurationObject]]

abstract def getConfigurationValue(key: String): Option[ConfigurationValue]

abstract def getConfigurationValues(key: String): Option[Seq[ConfigurationValue]]

abstract def getConfigurations(key: String): Option[Seq[Configuration]]

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

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

abstract def getDurationValue(path: String): Option[FiniteDuration]

abstract def getDurationValue(path: String, unit: TimeUnit): Option[Long]

abstract def getIntValue(key: String): Option[Int]

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

abstract def getIsNull(path: String): Try[Boolean]

abstract def getLongValue(key: String): Option[Long]

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

abstract def getNumberValue(key: String): Option[Number]

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

abstract def getStringValue(key: String, validValues: Option[Set[String]] = None): Option[String]

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

abstract def hasPath(path: String): Try[Boolean]

abstract def hasPathOrNull(path: String): Try[Boolean]

abstract def isEmpty: Boolean

abstract def isResolved(): Boolean

abstract def keys: Set[String]

abstract def resolve(option: ConfigurationResolveOptions): Try[Configuration]

abstract def resolve: Try[Configuration]

abstract def resolveWith(source: Configuration, options: ConfigurationResolveOptions): Try[Configuration]

abstract def resolveWith(source: Configuration): Try[Configuration]

abstract def root: ConfigurationObject

abstract def subKeys: Set[String]

abstract val underlying: Config

abstract def withFallback(other: ConfigurationMergeable): Configuration

abstract def withOnlyPath(path: String): Configuration

abstract def withValue(path: String, value: ConfigurationValue): Configuration

abstract def withoutPath(path: String): Configuration

abstract def getMillisecondValue(key: String): Option[Long]

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

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

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ConfigurationMergeable

Inherited from AnyRef

Inherited from Any

Ungrouped