Config

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).

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).

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.

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.)

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 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).

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.

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.

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.

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.

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.

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.

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.

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, TimeUnit).

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.

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).

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.

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).

Gets a list value (with any element type) as a ConfigList, which implements java.util.List. Throws if the path is unset or null.

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).

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.

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.

Gets a list, converting each value in the list to a memory size, using the same rules as #getMemorySize.

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.

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.

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.

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.

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

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.

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).

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).

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

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.

Gets the origin of the Config, which may be a file, or a file with a line number, or just a descriptive phrase.

Like resolve() but allows you to specify non-default options.

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.

Like resolveWith(Config) but allows you to specify non-default options.

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).

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

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 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).

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).