- Companion:
- object
Value members
Abstract methods
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).
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).
- Value parameters:
- key
key to look up
- Returns:
the value at the key or null if none
- Definition Classes
- ConfigObject -> Map
- Definition Classes
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.
- Value parameters:
- key
key to keep
- Returns:
a copy of the object minus all keys except the one specified
- Definition Classes
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]]
.
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]]
.
- Value parameters:
- key
key to add
- value
value at the new key
- Returns:
the new instance with the new map entry
- Definition Classes
Concrete methods
- Definition Classes
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.
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.
- Returns:
value relativized to the given path or the same value if nothing to do
- Definition Classes
Called only by ResolveContext.resolve().
Called only by ResolveContext.resolve().
- Value parameters:
- context
state of the current resolve
- source
where to look up values
- Returns:
a new value if there were changes, or this if no changes
- Definition Classes
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).
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).
- Returns:
a
[[Config]]
with this object as its root- Definition Classes
The [[ConfigValueType]]
of the value; matches the JSON type schema.
The [[ConfigValueType]]
of the value; matches the JSON type schema.
- Returns:
value's type
- Definition Classes
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
otherObject
will 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.
- Value parameters:
- 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
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.
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.
- Value parameters:
- origin
the origin set on the returned value
- Returns:
the new ConfigValue with the given origin
- Since:
1.3.0
- Definition Classes
Inherited methods
Places the value inside a [[Config]]
at the given key. See also
ConfigValue#atPath.
Places the value inside a [[Config]]
at the given key. See also
ConfigValue#atPath.
- Value parameters:
- key
key to store this value at.
- Returns:
a
Config
instance containing this value at the given key.- Definition Classes
- Inherited from:
- AbstractConfigValue
Places the value inside a [[Config]]
at the given path. See also
ConfigValue#atKey.
Places the value inside a [[Config]]
at the given path. See also
ConfigValue#atKey.
- Value parameters:
- path
path to store this value at.
- Returns:
a
Config
instance containing this value at the given path.- Definition Classes
- Inherited from:
- AbstractConfigValue
- Inherited from:
- Map
- Inherited from:
- Map
- Inherited from:
- Map
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
x
of typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is usually necessary to override hashCode
to ensure that
objects which are "equal" (o1.equals(o2)
returns true
) hash to the same scala.Int.
(o1.hashCode.equals(o2.hashCode)
).
- Value parameters:
- that
the object to compare against this object for equality.
- Returns:
true
if the receiver object is equivalent to the argument;false
otherwise.- Definition Classes
- AbstractConfigValue -> Any
- Inherited from:
- AbstractConfigValue
- Inherited from:
- Map
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.
- Inherited from:
- Container
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet
not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
.
However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals
method.
- Returns:
the hash code value for this object.
- Definition Classes
- AbstractConfigValue -> Any
- Inherited from:
- AbstractConfigValue
- Inherited from:
- Map
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.
- Returns:
where the value came from
- Definition Classes
- Inherited from:
- AbstractConfigValue
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.
- Value parameters:
- options
the rendering options
- Returns:
the rendered value
- Definition Classes
- Inherited from:
- AbstractConfigValue
Renders the config value as a HOCON string. This method is primarily intended for debugging, so it tries to add helpful comments and whitespace.
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())
.
- Returns:
the rendered value
- Definition Classes
- Inherited from:
- AbstractConfigValue
- Inherited from:
- Map
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.
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.
- Inherited from:
- Container
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
- Returns:
a string representation of the object.
- Definition Classes
- AbstractConfigValue -> Any
- Inherited from:
- AbstractConfigValue
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.
- Returns:
a
java.util.Map
containing plain Java objects- Definition Classes
- Inherited from:
- ConfigObject