AbstractConfigObject
Related Docs:
object AbstractConfigObject
| package impl
Gets a ConfigValue at the given key, or returns null if there is
no value.
Gets a ConfigValue at the given key, or returns null if there is
no value. The returned ConfigValue may have
ConfigValueType#NULL or any other type, and the passed-in key
must be a key in this object (rather than a path expression).
key to look up
the value at the key or null if none
Super-expensive full traversal to see if descendant is anywhere underneath this container.
Super-expensive full traversal to see if descendant is anywhere underneath this container.
Replace a child of this value.
Replace a child of this value. CAUTION if replacement is null, delete the child, which may also delete the parent, or make the parent into a non-container.
Recursively unwraps the object, returning a map from String to whatever plain Java values are unwrapped from the object's values.
Recursively unwraps the object, returning a map from String to whatever plain Java values are unwrapped from the object's values.
a java.util.Map containing plain Java objects
Clone the object with only the given key (and its children) retained; all sibling keys are removed.
Clone the object with only the given key (and its children) retained; all sibling keys are removed.
key to keep
a copy of the object minus all keys except the one specified
Returns a ConfigObject based on this one, but with the given key
set to the given value.
Returns a ConfigObject based on this one, but with the given key
set to the given value. Does not modify this instance (since it's
immutable). If the key already has a value, that value is replaced. To
remove a value, use ConfigObject#withoutKey.
key to add
value at the new key
the new instance with the new map entry
Clone the object with the given key removed.
Clone the object with the given key removed.
key to remove
a copy of the object minus the specified key
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.
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
This is used when including one file in another; the included file is relativized to the path it's included into in the parent file.
This is used when including one file in another; the included file is
relativized to the path it's included into in the parent file. The point
is that if you include a file at foo.bar in the parent, and the included
file as a substitution ${a.b.c}, the included substitution now needs to
be ${foo.bar.a.b.c} because we resolve substitutions globally only after
parsing everything.
value relativized to the given path or the same value if nothing to do
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
Called only by ResolveContext.resolve().
Called only by ResolveContext.resolve().
state of the current resolve
where to look up values
a new value if there were changes, or this if no changes
Converts this object to a Config instance, enabling you to use
path expressions to find values in the object.
Converts this object to a Config instance, enabling you to use
path expressions to find values in the object. This is a constant-time
operation (it is not proportional to the size of the object).
a Config with this object as its root
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.
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