public interface ConfigObject extends ConfigValue, Map<String,ConfigValue>
ConfigValue
representing an object (dictionary, map)
value, as in JSON's { "a" : 42 }
syntax.
ConfigObject
implements java.util.Map<String, ConfigValue>
so
you can use it like a regular Java map. Or call unwrapped()
to
unwrap the map to a map with plain Java values rather than
ConfigValue
.
Like all ConfigValue
subtypes, ConfigObject
is immutable.
This makes it threadsafe and you never have to create "defensive copies." The
mutator methods from Map
all throw
UnsupportedOperationException
.
The ConfigValue.valueType()
method on an object returns
ConfigValueType.OBJECT
.
In most cases you want to use the Config
interface rather than this
one. Call toConfig()
to convert a ConfigObject
to a
Config
.
The API for a ConfigObject
is in terms of keys, while the API for a
Config
is in terms of path expressions. Conceptually,
ConfigObject
is a tree of maps from keys to values, while a
Config
is a one-level map from paths to values.
Use ConfigUtil.joinPath(java.lang.String...)
and ConfigUtil.splitPath(java.lang.String)
to convert
between path expressions and individual path elements (keys).
A ConfigObject
may contain null values, which will have
ConfigValue.valueType()
equal to ConfigValueType.NULL
. If
get()
returns Java's null then the key was not present in the parsed
file (or wherever this value tree came from). If get()
returns a
ConfigValue
with type ConfigValueType#NULL
then the key was
set to null explicitly in the config file.
Do not implement ConfigObject
; 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.
Modifier and Type | Method and Description |
---|---|
ConfigValue |
get(Object key)
Gets a
ConfigValue at the given key, or returns null if there is
no value. |
Config |
toConfig()
Converts this object to a
Config instance, enabling you to use
path expressions to find values in the object. |
Map<String,Object> |
unwrapped()
Recursively unwraps the object, returning a map from String to whatever
plain Java values are unwrapped from the object's values.
|
ConfigObject |
withFallback(ConfigMergeable other)
Returns a new value computed by merging this value with another, with
keys in this value "winning" over the other one.
|
ConfigObject |
withOnlyKey(String key)
Clone the object with only the given key (and its children) retained; all
sibling keys are removed.
|
ConfigObject |
withoutKey(String key)
Clone the object with the given key removed.
|
origin, render, render, valueType
Config toConfig()
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).Config
with this object as its rootMap<String,Object> unwrapped()
unwrapped
in interface ConfigValue
Map
containing plain Java objectsConfigObject withFallback(ConfigMergeable other)
ConfigMergeable
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.
The semantics of merging are described in the spec for HOCON.
Note 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. Both non-objects, and any object
which has fallen back to a non-object, block subsequent fallbacks.
withFallback
in interface ConfigMergeable
withFallback
in interface ConfigValue
other
- an object whose keys should be used if the keys are not
present in this oneConfigValue get(Object key)
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.get
in interface Map<String,ConfigValue>
key
- key to look upConfigObject withOnlyKey(String key)
key
- key to keepConfigObject withoutKey(String key)
key
- key to remove