ConfigList
Subtype of
[1,2,3] syntax.
[[ConfigValue]] representing a list value, as in JSON's[1,2,3] syntax.
ConfigList implements java.util.List so you can
use it like a regular Java list. Or call
list elements into plain Java values.
use it like a regular Java list. Or call
[[#unwrapped]] to unwrap thelist elements into plain Java values.
Like all
makes it threadsafe and you never have to create "defensive copies." The
mutator methods from
[[ConfigValue]] subtypes, ConfigList is immutable. Thismakes it threadsafe and you never have to create "defensive copies." The
mutator methods from
java.util.List all throwjava.lang.UnsupportedOperationException.The
[[ConfigValue#valueType]] method on a list returns[[ConfigValueType#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.
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.
trait ConfigValue
trait ConfigMergeable
trait List[ConfigValue]
trait Collection[ConfigValue]
trait Iterable[ConfigValue]
class Object
trait Matchable
class Any
class SimpleConfigList
Value members
Methods
Inherited methods
Places the value inside a
[[Config]] at the given key. See also[[ConfigValue#atPath]].- Value Params
- key
-
key to store this value at.
- Returns
-
a Config instance containing this value at the given key.
- Inhertied from
- ConfigValue
The
[[ConfigValueType]] of the value; matches the JSON type schema.- Returns
-
value's type
- Inhertied from
- ConfigValue
Places the value inside a
[[Config]] at the given path. See also[[ConfigValue#atKey]].- Value Params
- path
-
path to store this value at.
- Returns
-
a Config instance containing this value at the given
path. - Inhertied from
- ConfigValue
The origin of the value (file, line number, etc.), for debugging and
error messages.
error messages.
- Returns
-
where the value came from
- Inhertied from
- ConfigValue
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.
(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.
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 Params
- options
-
the rendering options
- Returns
-
the rendered value
- Inhertied from
- ConfigValue
Renders the config value as a HOCON string. This method is primarily
intended for debugging, so it tries to add helpful comments and
whitespace.
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.
(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()).
render(ConfigRenderOptions.defaults()).
- Returns
-
the rendered value
- Inhertied from
- ConfigValue