sconfig
API
Generated with
sconfig/org.ekrich.config/ConfigObject

ConfigObject

org.ekrich.config.ConfigObject
trait ConfigObject extends ConfigValue, Map[String, ConfigValue]

Subtype of ConfigValue representing an object (AKA dictionary or map) value, as in JSON's curly brace { "a" : 42 } syntax.

An object may also be viewed as a Config by calling ConfigObject#toConfig.

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 java.util.Map all throw java.lang.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(String*) and ConfigUtil.splitPath(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 ConfigObject#get returns Java's null then the key was not present in the parsed file (or wherever this value tree came from). If get("key") returns a ConfigValue with type ConfigValueType#NULL then the key was set to null explicitly in the config file.

Do not implement interface 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.

Attributes

Graph
Supertypes
trait Map[String, ConfigValue]
trait ConfigValue
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Abstract methods

override def get(key: Any): ConfigValue

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

Attributes

Returns

the value at the key or null if none

Definition Classes
Map
def toConfig: Config

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).

Attributes

Returns

a Config with this object as its root

override def unwrapped: Map[String, AnyRef]

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.

Attributes

Returns

a java.util.Map containing plain Java objects

Definition Classes
override def withFallback(other: ConfigMergeable): ConfigObject

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 = 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

Attributes

Returns

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

Definition Classes
def withOnlyKey(key: String): ConfigObject

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

Attributes

Returns

a copy of the object minus all keys except the one specified

override def withOrigin(origin: ConfigOrigin): ConfigObject

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

Attributes

Returns

the new ConfigValue with the given origin

Since

1.3.0

Definition Classes
def withValue(key: String, value: ConfigValue): ConfigObject

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

Attributes

Returns

the new instance with the new map entry

def withoutKey(key: String): ConfigObject

Clone the object with the given key removed.

Clone the object with the given key removed.

Value parameters

key

key to remove

Attributes

Returns

a copy of the object minus the specified key

Inherited methods

def atKey(key: String): Config

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.

Attributes

Returns

a Config instance containing this value at the given key.

Inherited from:
ConfigValue
def atPath(path: String): Config

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.

Attributes

Returns

a Config instance containing this value at the given path.

Inherited from:
ConfigValue
def clear(): Unit

Attributes

Inherited from:
Map
def compute(x$0: String, x$1: BiFunction[_ >: String <: <FromJavaObject>, _ >: ConfigValue <: <FromJavaObject>, _ <: ConfigValue]): V

Attributes

Inherited from:
Map
def computeIfAbsent(x$0: String, x$1: Function[_ >: String <: <FromJavaObject>, _ <: ConfigValue]): V

Attributes

Inherited from:
Map
def computeIfPresent(x$0: String, x$1: BiFunction[_ >: String <: <FromJavaObject>, _ >: ConfigValue <: <FromJavaObject>, _ <: ConfigValue]): V

Attributes

Inherited from:
Map
def containsKey(x$0: <FromJavaObject>): Boolean

Attributes

Inherited from:
Map
def containsValue(x$0: <FromJavaObject>): Boolean

Attributes

Inherited from:
Map
def entrySet(): Set[Entry[K, V]]

Attributes

Inherited from:
Map
def forEach(x$0: BiConsumer[_ >: String <: <FromJavaObject>, _ >: ConfigValue <: <FromJavaObject>]): Unit

Attributes

Inherited from:
Map
def getOrDefault(x$0: <FromJavaObject>, x$1: ConfigValue): V

Attributes

Inherited from:
Map
def isEmpty(): Boolean

Attributes

Inherited from:
Map
def keySet(): Set[K]

Attributes

Inherited from:
Map
def merge(x$0: String, x$1: ConfigValue, x$2: BiFunction[_ >: ConfigValue <: <FromJavaObject>, _ >: ConfigValue <: <FromJavaObject>, _ <: ConfigValue]): V

Attributes

Inherited from:
Map
def origin: ConfigOrigin

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.

Attributes

Returns

where the value came from

Inherited from:
ConfigValue
def put(x$0: String, x$1: ConfigValue): V

Attributes

Inherited from:
Map
def putAll(x$0: Map[_ <: String, _ <: ConfigValue]): Unit

Attributes

Inherited from:
Map
def putIfAbsent(x$0: String, x$1: ConfigValue): V

Attributes

Inherited from:
Map
def remove(x$0: <FromJavaObject>, x$1: <FromJavaObject>): Boolean

Attributes

Inherited from:
Map
def remove(x$0: <FromJavaObject>): V

Attributes

Inherited from:
Map
def render(options: ConfigRenderOptions): String

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

Attributes

Returns

the rendered value

Inherited from:
ConfigValue
def render: 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.

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()).

Attributes

Returns

the rendered value

Inherited from:
ConfigValue
def replace(x$0: String, x$1: ConfigValue): V

Attributes

Inherited from:
Map
def replace(x$0: String, x$1: ConfigValue, x$2: ConfigValue): Boolean

Attributes

Inherited from:
Map
def replaceAll(x$0: BiFunction[_ >: String <: <FromJavaObject>, _ >: ConfigValue <: <FromJavaObject>, _ <: ConfigValue]): Unit

Attributes

Inherited from:
Map
def size(): Int

Attributes

Inherited from:
Map
def valueType: ConfigValueType

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

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

Attributes

Returns

value's type

Inherited from:
ConfigValue
def values(): Collection[V]

Attributes

Inherited from:
Map
Generated with