SimpleConfig

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 atKey(key: String): SimpleConfig

Places the config inside a Config at the given key.
Places the config inside a Config at the given key. See also atPath. Note that a key is NOT a path expression (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
key
key to store this config at.
returns
a Config instance containing this config at the given key.

Definition Classes
SimpleConfig → Config
def atPath(path: String): Config

Places the config inside another Config at the given path.
Places the config inside another Config at the given path.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
path
path expression to store this config at.
returns
a { @code Config} instance containing this config at the given path.

Definition Classes
SimpleConfig → Config
def checkValid(reference: Config, restrictToPaths: String*): Unit

Validates this config against a reference config, throwing an exception if it is invalid.
Validates this config against a reference config, throwing an exception if it is invalid. The purpose of this method is to "fail early" with a comprehensive list of problems; in general, anything this method can find would be detected later when trying to use the config, but it's often more user-friendly to fail right away when loading the config.
Using this method is always optional, since you can "fail late" instead.
You must restrict validation to paths you "own" (those whose meaning are defined by your code module). If you validate globally, you may trigger errors about paths that happen to be in the config but have nothing to do with your module. It's best to allow the modules owning those paths to validate them. Also, if every module validates only its own stuff, there isn't as much redundant work being done.
If no paths are specified in checkValid's parameter list, validation is for the entire config.
If you specify paths that are not in the reference config, those paths are ignored. (There's nothing to validate.)
Here's what validation involves:
- All paths found in the reference config must be present in this config or an exception will be thrown.
- Some changes in type from the reference config to this config will cause an exception to be thrown. Not all potential type problems are detected, in particular it's assumed that strings are compatible with everything except objects and lists. This is because string types are often "really" some other type (system properties always start out as strings, or a string like "5ms" could be used with getDuration(String)). Also, it's allowed to set any type to null or override null with any type.
- Any unresolved substitutions in this config will cause a validation failure; both the reference config and this config should be resolved before validation. If the reference config is unresolved, it's a bug in the caller of this method.
If you want to allow a certain setting to have a flexible type (or otherwise want validation to be looser for some settings), you could either remove the problematic setting from the reference config provided to this method, or you could intercept the validation exception and screen out certain problems. Of course, this will only work if all other callers of this method are careful to restrict validation to their own paths, as they should be.
If validation fails, the thrown exception contains a list of all problems found. See ConfigException.ValidationFailed#problems. The exception's getMessage will have all the problems concatenated into one huge string, as well.
Again, checkValid can't guess every domain-specific way a setting can be invalid, so some problems may arise later when attempting to use the config. checkValid is limited to reporting generic, but common, problems such as missing settings and blatant type incompatibilities.
reference
a reference configuration
restrictToPaths
only validate values underneath these paths that your code module owns and understands

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BugOrBroken if the reference config is unresolved or caller otherwise misuses the API
ConfigException.NotResolved if this config is not resolved
ConfigException.ValidationFailed if there are any validation issues
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val confObj: AbstractConfigObject
def entrySet: Set[Entry[String, ConfigValue]]

Returns the set of path-value pairs, excluding any null values, found by recursing the root object.
Returns the set of path-value pairs, excluding any null values, found by recursing the root object. Note that this is very different from root.entrySet which returns the set of immediate-child keys in the root object and includes null values.
Entries contain path expressions meaning there may be quoting and escaping involved. Parse path expressions with ConfigUtil#splitPath.
Because a Config is conceptually a single-level map from paths to values, there will not be any ConfigObject values in the entries (that is, all entries represent leaf nodes). Use ConfigObject rather than Config if you want a tree. (OK, this is a slight lie: Config entries may contain ConfigList and the lists may contain objects. But no objects are directly included as entry values.)
returns
set of paths with non-null values, built up by recursing the entire tree of { @link ConfigObject} and creating an entry for each leaf value.

Definition Classes
SimpleConfig → Config
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def equals(other: Any): Boolean

Definition Classes
SimpleConfig → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getAnyRef(path: String): AnyRef

Gets the value at the path as an unwrapped Java boxed value ( java.lang.Boolean java.lang.Integer, and so on - see ConfigValue#unwrapped).
Gets the value at the path as an unwrapped Java boxed value ( java.lang.Boolean java.lang.Integer, and so on - see ConfigValue#unwrapped).
path
path expression
returns
the unwrapped value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
def getAnyRefList(path: String): List[_ <: AnyRef]

Gets a list value with any kind of elements.
Gets a list value with any kind of elements. Throws if the path is unset or null or not a list. Each element is "unwrapped" (see ConfigValue#unwrapped).
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list
def getBoolean(path: String): Boolean

path
path expression
returns
the boolean value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to boolean
def getBooleanList(path: String): List[Boolean]

Gets a list value with boolean elements.
Gets a list value with boolean elements. Throws if the path is unset or null or not a list or contains values not convertible to boolean.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of booleans
def getBytes(path: String): Long

Gets a value as a size in bytes (parses special strings like "128M").
Gets a value as a size in bytes (parses special strings like "128M"). If the value is already a number, then it's left alone; if it's a string, it's parsed understanding unit suffixes such as "128K", as documented in the the spec.
path
path expression
returns
the value at the requested path, in bytes

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a size in bytes
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getBytesList(path: String): List[Long]

Gets a list value with elements representing a size in bytes.
Gets a list value with elements representing a size in bytes. Throws if the path is unset or null or not a list or contains values not convertible to memory sizes.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of memory sizes
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getConfig(path: String): SimpleConfig

path
path expression
returns
the nested Config value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a Config
def getConfigList(path: String): List[_ <: Config]

Gets a list value with Config elements.
Gets a list value with Config elements. Throws if the path is unset or null or not a list or contains values not convertible to Config.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of configs
def getDouble(path: String): Double

path
path expression
returns
the floating-point value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a double
def getDoubleList(path: String): List[Double]

Gets a list value with double elements.
Gets a list value with double elements. Throws if the path is unset or null or not a list or contains values not convertible to double.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of doubles
def getDuration(path: String): Duration

Gets a value as a java.time.Duration.
Gets a value as a java.time.Duration. If the value is already a number, then it's taken as milliseconds; if it's a string, it's parsed understanding units suffixes like "10m" or "5ns" as documented in the <a href="https://github.com/lightbend/config/blob/master/HOCON.md">the spec. This method never returns null.
path
path expression
returns
the duration value at the requested path

Definition Classes
SimpleConfig → Config
Since
1.3.0
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a number of the given TimeUnit
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getDuration(path: String, unit: TimeUnit): Long

Gets a value as a duration in a specified java.util.concurrent.TimeUnit.
Gets a value as a duration in a specified java.util.concurrent.TimeUnit. If the value is already a number, then it's taken as milliseconds and then converted to the requested TimeUnit; if it's a string, it's parsed understanding units suffixes like "10m" or "5ns" as documented in the <a the HOCON spec.
path
path expression
unit
convert the return value to this time unit
returns
the duration value at the requested path, in the given TimeUnit

Definition Classes
SimpleConfig → Config
Since
1.2.0
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a number of the given TimeUnit
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getDurationList(path: String): List[Duration]

Gets a list, converting each value in the list to a duration, using the same rules as getDuration(String).
Gets a list, converting each value in the list to a duration, using the same rules as getDuration(String).
path
a path expression
returns
list of durations

Definition Classes
SimpleConfig → Config
Since
1.3.0
def getDurationList(path: String, unit: TimeUnit): List[Long]

Gets a list, converting each value in the list to a duration, using the same rules as getDuration(String, TimeUnit).
Gets a list, converting each value in the list to a duration, using the same rules as getDuration(String, TimeUnit).
path
a path expression
unit
time units of the returned values
returns
list of durations, in the requested units

Definition Classes
SimpleConfig → Config
Since
1.2.0
def getEnum[T <: Enum[T]](enumClass: Class[T], path: String): T

enumClass
an enum class
path
path expression
returns
the { @code Enum} value at the requested path of the requested enum class

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to an Enum
def getEnumList[T <: Enum[T]](enumClass: Class[T], path: String): List[T]

Gets a list value with Enum elements.
Gets a list value with Enum elements. Throws if the path is unset or null or not a list or contains values not convertible to Enum.
enumClass
the enum class
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of { @code Enum}
def getInt(path: String): Int

Gets the integer at the given path.
Gets the integer at the given path. If the value at the path has a fractional (floating point) component, it will be discarded and only the integer part will be returned (it works like a "narrowing primitive conversion" in the Java language specification).
path
path expression
returns
the 32-bit integer value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to an int (for example it is out of range, or it's a boolean value)
def getIntList(path: String): List[Integer]

Gets a list value with int elements.
Gets a list value with int elements. Throws if the path is unset or null or not a list or contains values not convertible to int.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of ints
def getIsNull(path: String): Boolean

Checks whether a value is set to null at the given path, but throws an exception if the value is entirely unset.
Checks whether a value is set to null at the given path, but throws an exception if the value is entirely unset. This method will not throw if #hasPathOrNull returned true for the same path, so to avoid any possible exception check hasPathOrNull first. However, an exception for unset paths will usually be the right thing (because a reference.conf should exist that has the path set, the path should never be unset unless something is broken).
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
path
the path expression
returns
true if the value exists and is null, false if it exists and is not null

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BadPath if the path expression is invalid
ConfigException.Missing if value is not set at all
def getList(path: String): ConfigList

Gets a list value (with any element type) as a ConfigList, which implements java.util.List.
Gets a list value (with any element type) as a ConfigList, which implements java.util.List. Throws if the path is unset or null.
path
the path to the list value.
returns
the { @link ConfigList} at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a ConfigList
def getLong(path: String): Long

Gets the long integer at the given path.
Gets the long integer at the given path. If the value at the path has a fractional (floating point) component, it will be discarded and only the integer part will be returned (it works like a "narrowing primitive conversion" in the Java language specification).
path
path expression
returns
the 64-bit long value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a long
def getLongList(path: String): List[Long]

Gets a list value with long elements.
Gets a list value with long elements. Throws if the path is unset or null or not a list or contains values not convertible to long.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of longs
def getMemorySize(path: String): ConfigMemorySize

Gets a value as an amount of memory (parses special strings like "128M").
Gets a value as an amount of memory (parses special strings like "128M"). If the value is already a number, then it's left alone; if it's a string, it's parsed understanding unit suffixes such as "128K", as documented in the the spec.
path
path expression
returns
the value at the requested path, in bytes

Definition Classes
SimpleConfig → Config
Since
1.3.0
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a size in bytes
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getMemorySizeList(path: String): List[ConfigMemorySize]

Gets a list, converting each value in the list to a memory size, using the same rules as #getMemorySize.
Gets a list, converting each value in the list to a memory size, using the same rules as #getMemorySize.
path
a path expression
returns
list of memory sizes

Definition Classes
SimpleConfig → Config
Since
1.3.0
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of memory sizes
def getNumber(path: String): Number

path
path expression
returns
the numeric value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a number
def getNumberList(path: String): List[Number]

Gets a list value with number elements.
Gets a list value with number elements. Throws if the path is unset or null or not a list or contains values not convertible to number.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of numbers
def getObject(path: String): AbstractConfigObject

path
path expression
returns
the { @link ConfigObject} value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to an object
def getObjectList(path: String): List[ConfigObject]

Gets a list value with object elements.
Gets a list value with object elements. Throws if the path is unset or null or not a list or contains values not convertible to ConfigObject.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of objects
def getPeriod(path: String): Period

Gets a value as a java.time.Period.
Gets a value as a java.time.Period. If the value is already a number, then it's taken as days; if it's a string, it's parsed understanding units suffixes like "10d" or "5w" as documented in the <a href="https://github.com/lightbend/config/blob/master/HOCON.md">the spec. This method never returns null.
path
path expression
returns
the period value at the requested path

Definition Classes
SimpleConfig → Config
Since
1.3.0
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a number of the given TimeUnit
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getString(path: String): String

path
path expression
returns
the string value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a string
def getStringList(path: String): List[String]

Gets a list value with string elements.
Gets a list value with string elements. Throws if the path is unset or null or not a list or contains values not convertible to string.
path
the path to the list value.
returns
the list at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to a list of strings
def getTemporal(path: String): TemporalAmount

Gets a value as a java.time.temporal.TemporalAmount.
Gets a value as a java.time.temporal.TemporalAmount. This method will first try get get the value as a java.time.Duration, and if unsuccessful, then as a java.time.Period. This means that values like "5m" will be parsed as 5 minutes rather than 5 months
path
path expression
returns
the temporal value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BadValue if value cannot be parsed as a TemporalAmount
ConfigException.Missing if value is absent or null
ConfigException.WrongType if value is not convertible to Long or String
def getValue(path: String): AbstractConfigValue

Gets the value at the given path, unless the value is a null value or missing, in which case it throws just like the other getters.
Gets the value at the given path, unless the value is a null value or missing, in which case it throws just like the other getters. Use get on the Config#root object (or other object in the tree) if you want an unprocessed value.
path
path expression
returns
the value at the requested path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.Missing if value is absent or null
def hasPath(pathExpression: String): Boolean

Checks whether a value is present and non-null at the given path.
Checks whether a value is present and non-null at the given path. This differs in two ways from Map.containsKey as implemented by ConfigObject: it looks for a path expression, not a key; and it returns false for null values, while containsKey returns true indicating that the object contains a null value for the key.
If a path exists according to #hasPath, then #getValue will never throw an exception. However, the typed getters, such as #getInt, will still throw if the value is not convertible to the requested type.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
returns
true if a non-null value is present at the path

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BadPath if the path expression is invalid
def hasPathOrNull(path: String): Boolean

Checks whether a value is present at the given path, even if the value is null.
Checks whether a value is present at the given path, even if the value is null. Most of the getters on Config will throw if you try to get a null value, so if you plan to call #getValue, #getInt, or another getter you may want to use plain #hasPath rather than this method.
To handle all three cases (unset, null, and a non-null value) the code might look like:
```
if (config.hasPathOrNull(path)) {
  if (config.getIsNull(path)) {
    // handle null setting
  } else {
    // get and use non-null setting
  }
} else {
  // handle entirely unset path
}
```
However, the usual thing is to allow entirely unset paths to be a bug that throws an exception (because you set a default in your reference.conf), so in that case it's OK to call #getIsNull without checking hasPathOrNull first.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
path
the path expression
returns
true if a value is present at the path, even if the value is null

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException.BadPath if the path expression is invalid
final def hashCode(): Int

Definition Classes
SimpleConfig → AnyRef → Any
def isEmpty: Boolean

Returns true if the Config's root object contains no key-value pairs.
Returns true if the Config's root object contains no key-value pairs.
returns
true if the configuration is empty

Definition Classes
SimpleConfig → Config
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isResolved: Boolean

Checks whether the config is completely resolved.
Checks whether the config is completely resolved. After a successful call to resolve() it will be completely resolved, but after calling resolve(ConfigResolveOptions) with allowUnresolved set in the options, it may or may not be completely resolved. A newly-loaded config may or may not be completely resolved depending on whether there were substitutions present in the file.
returns
true if there are no unresolved substitutions remaining in this configuration.

Definition Classes
SimpleConfig → Config
Since
1.2.0
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def origin: ConfigOrigin

Gets the origin of the Config, which may be a file, or a file with a line number, or just a descriptive phrase.
Gets the origin of the Config, which may be a file, or a file with a line number, or just a descriptive phrase.
returns
the origin of the Config for use in error messages

Definition Classes
SimpleConfig → Config
def resolve(options: ConfigResolveOptions): SimpleConfig

Like resolve() but allows you to specify non-default options.
Like resolve() but allows you to specify non-default options.
options
resolve options
returns
the resolved Config (may be only partially resolved if options are set to allow unresolved)

Definition Classes
SimpleConfig → Config
def resolve(): SimpleConfig

Returns a replacement config with all substitutions (the ${foo.bar} syntax, see HOCON spec for resolved.
Returns a replacement config with all substitutions (the ${foo.bar} syntax, see HOCON spec for resolved. Substitutions are looked up using this Config as the root object, that is, a substitution ${foo.bar} will be replaced with the result of getValue("foo.bar").
This method uses ConfigResolveOptions#defaults, there is another variant resolve(ConfigResolveOptions) which lets you specify non-default options.
A given Config must be resolved before using it to retrieve config values, but ideally should be resolved one time for your entire stack of fallbacks (see Config#withFallback). Otherwise, some substitutions that could have resolved with all fallbacks available may not resolve, which will be potentially confusing for your application's users.
resolve should be invoked on root config objects, rather than on a subtree (a subtree is the result of something like config.getConfig("foo")). The problem with resolve on a subtree is that substitutions are relative to the root of the config and the subtree will have no way to get values from the root. For example, if you did config.getConfig("foo").resolve on the below config file, it would not work:
```
common-value = 10
foo {
  whatever = ${common-value}
}
```
Many methods on ConfigFactory such as ConfigFactory.load() automatically resolve the loaded Config on the loaded stack of config files.
Resolving an already-resolved config is a harmless no-op, but again, it is best to resolve an entire stack of fallbacks (such as all your config files combined) rather than resolving each one individually.
returns
an immutable object with substitutions resolved

Definition Classes
SimpleConfig → Config
Exceptions thrown
ConfigException some other config exception if there are other problems
ConfigException.UnresolvedSubstitution if any substitutions refer to nonexistent paths
def resolveWith(source: Config, options: ConfigResolveOptions): SimpleConfig

Like resolveWith(Config) but allows you to specify non-default options.
Like resolveWith(Config) but allows you to specify non-default options.
source
source configuration to pull values from
options
resolve options
returns
the resolved Config (may be only partially resolved if options are set to allow unresolved)

Definition Classes
SimpleConfig → Config
Since
1.2.0
def resolveWith(source: Config): SimpleConfig

Like resolve() except that substitution values are looked up in the given source, rather than in this instance.
Like resolve() except that substitution values are looked up in the given source, rather than in this instance. This is a special-purpose method which doesn't make sense to use in most cases; it's only needed if you're constructing some sort of app-specific custom approach to configuration. The more usual approach if you have a source of substitution values would be to merge that source into your config stack using Config#withFallback and then resolve.
Note that this method does NOT look in this instance for substitution values. If you want to do that, you could either merge this instance into your value source using Config#withFallback, or you could resolve multiple times with multiple sources (using ConfigResolveOptions#setAllowUnresolved so the partial resolves don't fail).
source
configuration to pull values from
returns
an immutable object with substitutions resolved

Definition Classes
SimpleConfig → Config
Since
1.2.0
Exceptions thrown
ConfigException some other config exception if there are other problems
ConfigException.UnresolvedSubstitution if any substitutions refer to paths which are not in the source
def root: AbstractConfigObject

Gets the Config as a tree of ConfigObject.
Gets the Config as a tree of ConfigObject. This is a constant-time operation (it is not proportional to the number of values in the Config).
returns
the root object in the configuration

Definition Classes
SimpleConfig → Config
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toFallbackValue: AbstractConfigObject

Definition Classes
SimpleConfig → MergeableValue
def toString(): String

Definition Classes
SimpleConfig → 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( ... )
def withFallback(other: ConfigMergeable): SimpleConfig

Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.
Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.
This associative operation may be used to combine configurations from multiple sources (such as multiple configuration files).
The semantics of merging are described in the spec for HOCON. Merging typically occurs when either the same object is created twice in the same file, or two config files are both loaded. For example:
```
foo = { a: 42 }
foo = { b: 43 }
```
Here, the two objects are merged as if you had written:
```
foo = { a: 42, b: 43 }
```
Only ConfigObject and Config instances do anything in this method (they need to merge the fallback keys into themselves). All other values just return the original value, since they automatically override any fallback. This means that objects do not merge "across" non-objects; if you write object.withFallback(nonObject).withFallback(otherObject), then otherObjectwill simply be ignored. This is an intentional part of how merging works, because non-objects such as strings and integers replace (rather than merging with) any prior value:
```
foo = { a: 42 }
foo = 10
```
Here, the number 10 "wins" and the value of foo would be simply 10. Again, for details see the spec.
other
an object whose keys should be used as fallbacks, if the keys are not present in this one
returns
a new object (or the original one, if the fallback doesn't get used)

Definition Classes
SimpleConfig → Config → ConfigMergeable
def withOnlyPath(pathExpression: String): SimpleConfig

Clone the config with only the given path (and its children) retained; all sibling paths are removed.
Clone the config with only the given path (and its children) retained; all sibling paths are removed.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
returns
a copy of the config minus all paths except the one specified

Definition Classes
SimpleConfig → Config
def withValue(pathExpression: String, v: ConfigValue): SimpleConfig

Returns a Config based on this one, but with the given path set to the given value.
Returns a Config based on this one, but with the given path set to the given value. Does not modify this instance (since it's immutable). If the path already has a value, that value is replaced. To remove a value, use withoutPath.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
returns
the new instance with the new map entry

Definition Classes
SimpleConfig → Config
def withoutPath(pathExpression: String): SimpleConfig

Clone the config with the given path removed.
Clone the config with the given path removed.
Note that path expressions have a syntax and sometimes require quoting (see ConfigUtil$.joinPath(elements:String*)* and ConfigUtil#splitPath).
returns
a copy of the config minus the specified path

Definition Classes
SimpleConfig → Config

Related Docs: object SimpleConfig | package impl

final class SimpleConfig extends Config with MergeableValue with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def atKey(key: String): SimpleConfig

def atPath(path: String): Config

def checkValid(reference: Config, restrictToPaths: String*): Unit

def clone(): AnyRef

val confObj: AbstractConfigObject

def entrySet: Set[Entry[String, ConfigValue]]

final def eq(arg0: AnyRef): Boolean

final def equals(other: Any): Boolean

def finalize(): Unit

def getAnyRef(path: String): AnyRef

def getAnyRefList(path: String): List[_ <: AnyRef]

def getBoolean(path: String): Boolean

def getBooleanList(path: String): List[Boolean]

def getBytes(path: String): Long

def getBytesList(path: String): List[Long]

final def getClass(): Class[_]

def getConfig(path: String): SimpleConfig

def getConfigList(path: String): List[_ <: Config]

def getDouble(path: String): Double

def getDoubleList(path: String): List[Double]

def getDuration(path: String): Duration

def getDuration(path: String, unit: TimeUnit): Long

def getDurationList(path: String): List[Duration]

def getDurationList(path: String, unit: TimeUnit): List[Long]

def getEnum[T <: Enum[T]](enumClass: Class[T], path: String): T

def getEnumList[T <: Enum[T]](enumClass: Class[T], path: String): List[T]

def getInt(path: String): Int

def getIntList(path: String): List[Integer]

def getIsNull(path: String): Boolean

def getList(path: String): ConfigList

def getLong(path: String): Long

def getLongList(path: String): List[Long]

def getMemorySize(path: String): ConfigMemorySize

def getMemorySizeList(path: String): List[ConfigMemorySize]

def getNumber(path: String): Number

def getNumberList(path: String): List[Number]

def getObject(path: String): AbstractConfigObject

def getObjectList(path: String): List[ConfigObject]

def getPeriod(path: String): Period

def getString(path: String): String

def getStringList(path: String): List[String]

def getTemporal(path: String): TemporalAmount

def getValue(path: String): AbstractConfigValue

def hasPath(pathExpression: String): Boolean

def hasPathOrNull(path: String): Boolean

final def hashCode(): Int

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

def isResolved: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def origin: ConfigOrigin

def resolve(options: ConfigResolveOptions): SimpleConfig

def resolve(): SimpleConfig

def resolveWith(source: Config, options: ConfigResolveOptions): SimpleConfig

def resolveWith(source: Config): SimpleConfig

def root: AbstractConfigObject

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

def toFallbackValue: AbstractConfigObject

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withFallback(other: ConfigMergeable): SimpleConfig

def withOnlyPath(pathExpression: String): SimpleConfig

def withValue(pathExpression: String, v: ConfigValue): SimpleConfig

def withoutPath(pathExpression: String): SimpleConfig

Inherited from Serializable

Inherited from MergeableValue

Inherited from Config

Inherited from ConfigMergeable