trait ReplaceableMergeStack extends Container
Implemented by a merge stack (ConfigDelayedMerge, ConfigDelayedMergeObject) that replaces itself during substitution resolution in order to implement "look backwards only" semantics.
- Alphabetic
- By Inheritance
- ReplaceableMergeStack
- Container
- ConfigValue
- ConfigMergeable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def atKey(key: String): Config
Places the value inside a Config at the given key.
Places the value inside a Config at the given key. See also ConfigValue#atPath.
- key
key to store this value at.
- returns
a
Configinstance containing this value at the given key.
- Definition Classes
- ConfigValue
- abstract def atPath(path: String): Config
Places the value inside a Config at the given path.
Places the value inside a Config at the given path. See also ConfigValue#atKey.
- path
path to store this value at.
- returns
a
Configinstance containing this value at the given path.
- Definition Classes
- ConfigValue
- abstract def hasDescendant(descendant: AbstractConfigValue): Boolean
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.
- Definition Classes
- Container
- abstract def makeReplacement(context: ResolveContext, skipping: Int): AbstractConfigValue
Make a replacement for this object skipping the given number of elements which are lower in merge priority.
- abstract 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.
- returns
where the value came from
- Definition Classes
- ConfigValue
- abstract 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.
- options
the rendering options
- returns
the rendered value
- Definition Classes
- ConfigValue
- abstract def render: String
Renders the config value as a HOCON 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.
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
- ConfigValue
- abstract def replaceChild(child: AbstractConfigValue, replacement: AbstractConfigValue): AbstractConfigValue
Replace a child of this value.
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.
- Definition Classes
- Container
- abstract def unwrapped: AnyRef
Returns the value as a plain Java boxed value, that is, a
String,Number,Boolean,Map[String, Object],List[Object], ornull, matching the #valueType of thisConfigValue.Returns the value as a plain Java boxed value, that is, a
String,Number,Boolean,Map[String, Object],List[Object], ornull, matching the #valueType of thisConfigValue. If the value is a ConfigObject or ConfigList, it is recursively unwrapped.- returns
a plain Java value corresponding to this ConfigValue
- Definition Classes
- ConfigValue
- abstract def valueType: ConfigValueType
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
- ConfigValue
- abstract def withFallback(other: ConfigMergeable): ConfigValue
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), thenotherObjectwill 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 = 10Here, the number 10 "wins" and the value of
foowould be simply 10. Again, for details see the spec.- 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
- ConfigValue → ConfigMergeable
- abstract def withOrigin(origin: ConfigOrigin): ConfigValue
Returns a
ConfigValuebased on this one, but with the given origin.Returns a
ConfigValuebased 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.- origin
the origin set on the returned value
- returns
the new ConfigValue with the given origin
- Definition Classes
- ConfigValue
- Since
1.3.0
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)