ConfigList
Related Doc:
package config
Places the value inside a Config at the given key.
Places the value inside a Config at the given key. See also
ConfigValue#atPath.
key to store this value at.
a Config instance containing this value at the given key.
Places the value inside a Config at the given path.
Places the value inside a Config at the given path. See also
ConfigValue#atKey.
path to store this value at.
a Config instance containing this value at the given
path.
The origin of the value (file, line number, etc.), for debugging and error messages.
The origin of the value (file, line number, etc.), for debugging and error messages.
where the value came from
Renders the config value to a string, using the provided options.
Renders the config value to a string, using the provided options.
If the config value has not been resolved (see Config.resolve()]]), it's possible that it can't be rendered as valid HOCON. In that case the rendering should still be useful for debugging but you might not be able to parse it. If the value has been resolved, it will always be parseable.
If the config value has been resolved and the options disable all HOCON-specific features (such as comments), the rendering will be valid JSON. If you enable HOCON-only features such as comments, the rendering will not be valid JSON.
the rendering options
the rendered value
Renders the config value as a HOCON string.
Renders the config value as a HOCON string. This method is primarily intended for debugging, so it tries to add helpful comments and whitespace.
If the config value has not been resolved (see Config.resolve()), it's possible that it can't be rendered as valid HOCON. In that case the rendering should still be useful for debugging but you might not be able to parse it. If the value has been resolved, it will always be parseable.
This method is equivalent to
render(ConfigRenderOptions.defaults()).
the rendered value
Recursively unwraps the list, returning a list of plain Java values such as Integer or String or whatever is in the list.
Recursively unwraps the list, returning a list of plain Java values such as Integer or String or whatever is in the list.
a java.util.List containing plain Java objects
The ConfigValueType of the value; matches the JSON type schema.
The ConfigValueType of the value; matches the JSON type schema.
value's type
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 = 10Here, the number 10 "wins" and the value of foo would be
simply 10. Again, for details see the spec.
an object whose keys should be used as fallbacks, if the keys are not present in this one
a new object (or the original one, if the fallback doesn't get used)
Returns a ConfigValue based on this one, but with the given
origin.
Returns a ConfigValue based on this one, but with the given
origin. This is useful when you are parsing a new format of file or setting
comments for a single ConfigValue.
the origin set on the returned value
the new ConfigValue with the given origin
1.3.0
Subtype of
ConfigValuerepresenting a list value, as in JSON's[1,2,3]syntax.ConfigListimplementsjava.util.Listso you can use it like a regular Java list. Or call#unwrappedto unwrap the list elements into plain Java values.Like all
ConfigValuesubtypes,ConfigListis immutable. This makes it threadsafe and you never have to create "defensive copies." The mutator methods fromjava.util.Listall throwjava.lang.UnsupportedOperationException.The
ConfigValue#valueTypemethod on a list returnsConfigValueType#LIST.Do not implement
ConfigList; it should only be implemented by the config library. Arbitrary implementations will not work because the library internals assume a specific concrete implementation. Also, this interface is likely to grow new methods over time, so third-party implementations will break.