Typesafe Config 1.4.3 · com.typesafe.config.ConfigValue

Method Summary

Modifier and Type	Method and Description
public Config	Returns: a `Config` instance containing this value at the given key. atKey(String key to store this value at. key) Places the value inside a `Config` at the given key.
public Config	Returns: a `Config` instance containing this value at the given path. atPath(String path to store this value at. path) Places the value inside a `Config` at the given path.
public ConfigOrigin	Returns: where the value came from origin() The origin of the value (file, line number, etc.), for debugging and error messages.
public String	Returns: the rendered value render() Renders the config value as a HOCON string.
public String	Returns: the rendered value render(ConfigRenderOptions the rendering options options) Renders the config value to a string, using the provided options.
public Object	Returns: a plain Java value corresponding to this ConfigValue unwrapped() Returns the value as a plain Java boxed value, that is, a `String`, `Number`, `Boolean`, `Map<String,Object>`, `List<Object>`, or `null`, matching the `valueType()` of this `ConfigValue`.
public ConfigValueType	Returns: value's type valueType() The `ConfigValueType` of the value; matches the JSON type schema.
public ConfigValue	withFallback(ConfigMergeable an object whose keys should be used as fallbacks, if the keys are not present in this one other) Redeclares com.typesafe.config.ConfigMergeable.withFallback. Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.
public ConfigValue	Returns: the new ConfigValue with the given origin withOrigin(ConfigOrigin the origin set on the returned value origin) Returns a `ConfigValue` based on this one, but with the given origin.

Method Detail

atKey back to summary

atKey	back to summary
public Config atKey(String key) Places the value inside a `Config` at the given key. See also `ConfigValue#atPath(String)`. Parameters key:String key to store this value at. Returns:Config a `Config` instance containing this value at the given key.

public Config atKey(String key)

Places the value inside a Config at the given key. See also ConfigValue#atPath(String).

Parameters

key:String: key to store this value at.

Returns:Config

a Config instance containing this value at the given key.

atPath back to summary

atPath	back to summary
public Config atPath(String path) Places the value inside a `Config` at the given path. See also `ConfigValue#atKey(String)`. Parameters path:String path to store this value at. Returns:Config a `Config` instance containing this value at the given path.

public Config atPath(String path)

Places the value inside a Config at the given path. See also ConfigValue#atKey(String).

Parameters

path:String: path to store this value at.

Returns:Config

a Config instance containing this value at the given path.

origin	back to summary
public ConfigOrigin origin() The origin of the value (file, line number, etc.), for debugging and error messages. Returns:ConfigOrigin where the value came from

origin

back to summary

public ConfigOrigin origin()

The origin of the value (file, line number, etc.), for debugging and error messages.

Returns:ConfigOrigin: where the value came from

render back to summary

render	back to summary
public String render() 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:String the rendered value

public String render()

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:String: the rendered value

render back to summary

render	back to summary
public String render(ConfigRenderOptions 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. Parameters options:ConfigRenderOptions the rendering options Returns:String the rendered value

public String render(ConfigRenderOptions options)

Renders the config value to a string, using the provided options.

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.

Parameters

options:ConfigRenderOptions: the rendering options

Returns:String

the rendered value

unwrapped back to summary

unwrapped	back to summary
public Object unwrapped() Returns the value as a plain Java boxed value, that is, a `String`, `Number`, `Boolean`, `Map<String,Object>`, `List<Object>`, or `null`, matching the `valueType()` of this `ConfigValue`. If the value is a `ConfigObject` or `ConfigList`, it is recursively unwrapped. Returns:Object a plain Java value corresponding to this ConfigValue

public Object unwrapped()

Returns the value as a plain Java boxed value, that is, a String, Number, Boolean, Map<String,Object>, List<Object>, or null, matching the valueType() of this ConfigValue. If the value is a ConfigObject or ConfigList, it is recursively unwrapped.

Returns:Object: a plain Java value corresponding to this ConfigValue

valueType back to summary

valueType	back to summary
public ConfigValueType valueType() The `ConfigValueType` of the value; matches the JSON type schema. Returns:ConfigValueType value's type

public ConfigValueType valueType()

The ConfigValueType of the value; matches the JSON type schema.

Returns:ConfigValueType: value's type

withFallback back to summary

withFallback	back to summary
public ConfigValue withFallback(ConfigMergeable other) Redeclares com.typesafe.config.ConfigMergeable.withFallback. Doc from com.typesafe.config.ConfigMergeable.withFallback. 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. Parameters other:ConfigMergeable an object whose keys should be used as fallbacks, if the keys are not present in this one Returns:ConfigValue a new object (or the original one, if the fallback doesn't get used) Annotations @Override

public ConfigValue withFallback(ConfigMergeable other)

Redeclares com.typesafe.config.ConfigMergeable.withFallback.

Doc from com.typesafe.config.ConfigMergeable.withFallback.

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.

Parameters

other:ConfigMergeable: an object whose keys should be used as fallbacks, if the keys are not present in this one

Returns:ConfigValue

a new object (or the original one, if the fallback doesn't get used)

Annotations

@Override

withOrigin back to summary

withOrigin	back to summary
public ConfigValue withOrigin(ConfigOrigin 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. Parameters origin:ConfigOrigin the origin set on the returned value Returns:ConfigValue the new ConfigValue with the given origin Since 1.3.0

public ConfigValue withOrigin(ConfigOrigin 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.

Parameters

origin:ConfigOrigin: the origin set on the returned value

Returns:ConfigValue

the new ConfigValue with the given origin

Since

1.3.0

public Interface ConfigValue

Method Summary

Method Detail