Based on PlayConfig, adds some helper methods over underlying Config.
- Companion
- object
Value members
Concrete methods
Get a deprecated configuration item.
Get a deprecated configuration item.
If the deprecated configuration item is defined, it will be returned, and a warning will be logged.
Otherwise, the configuration from path will be looked up.
Get a deprecated configuration.
Get a deprecated configuration.
If the deprecated configuration is defined, it will be returned, falling back to the new configuration, and a warning will be logged.
Otherwise, the configuration from path will be looked up and used as is.
Get an optional configuration item.
Get an optional configuration item.
If the value of the item is null, this will return None, otherwise returns Some.
- Throws
- com.typesafe.config.ConfigException.Missing
if the value is undefined (as opposed to null) this will still throw an exception.
Get an optional deprecated configuration item.
Get an optional deprecated configuration item.
If the deprecated configuration item is defined, it will be returned, and a warning will be logged.
Otherwise, the configuration from path will be looked up.
If the value of the item is null, this will return None, otherwise returns Some.
Get a prototyped map of objects.
Get a prototyped map of objects.
Each value in the map will fallback to the object loaded from prototype.$path.
Get a prototyped sequence of objects.
Get a prototyped sequence of objects.
Each object in the sequence will fallback to the object loaded from prototype.$path.
Creates a configuration error for a specific configuration key.
Creates a configuration error for a specific configuration key.
For example:
val configuration = Configuration.load()
throw configuration.reportError("engine.connectionUrl", "Cannot connect!")
- Value Params
- e
the related exception
- message
the error message
- path
the configuration key, related to this error
- Returns
a configuration exception