sconfig
API
Generated with
sconfig/org.ekrich.config/org.ekrich.config.impl/AbstractConfigObject

AbstractConfigObject

org.ekrich.config.impl.AbstractConfigObject
See theAbstractConfigObject companion object
abstract class AbstractConfigObject(_origin: ConfigOrigin) extends AbstractConfigValue, ConfigObject, Container

Attributes

Companion
object
Graph
Supertypes
trait Container
trait ConfigObject
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): AbstractConfigValue

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
ConfigObject -> Map
override def render(sb: StringBuilder, indent: Int, atRoot: Boolean, options: ConfigRenderOptions): Unit

Attributes

Definition Classes
override def withOnlyKey(key: String): AbstractConfigObject

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

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

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

Definition Classes
override def withoutKey(key: String): AbstractConfigObject

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

Definition Classes

Concrete methods

override def clear(): Unit

Attributes

Definition Classes
Map
override def constructDelayedMerge(origin: ConfigOrigin, stack: List[AbstractConfigValue]): AbstractConfigValue

Attributes

Definition Classes
override def mergedWithObject(fallback: AbstractConfigObject): AbstractConfigObject

Attributes

Definition Classes
override def newCopy(origin: ConfigOrigin): AbstractConfigObject

Attributes

Definition Classes
override def put(arg0: String, arg1: ConfigValue): ConfigValue

Attributes

Definition Classes
Map
override def putAll(arg0: Map[_ <: String, _ <: ConfigValue]): Unit

Attributes

Definition Classes
Map
override def relativized(prefix: Path): AbstractConfigObject

This is used when including one file in another; the included file is relativized to the path it's included into in the parent file. The point is that if you include a file at foo.bar in the parent, and the included file as a substitution ${a.b.c}, the included substitution now needs to be ${foo.bar.a.b.c} because we resolve substitutions globally only after parsing everything.

This is used when including one file in another; the included file is relativized to the path it's included into in the parent file. The point is that if you include a file at foo.bar in the parent, and the included file as a substitution ${a.b.c}, the included substitution now needs to be ${foo.bar.a.b.c} because we resolve substitutions globally only after parsing everything.

Attributes

Returns

value relativized to the given path or the same value if nothing to do

Definition Classes
override def remove(arg0: Any): ConfigValue

Attributes

Definition Classes
Map
override def resolveSubstitutions(context: ResolveContext, source: ResolveSource): ResolveResult[_ <: AbstractConfigObject]

Called only by ResolveContext.resolve().

Called only by ResolveContext.resolve().

Value parameters

context

state of the current resolve

source

where to look up values

Attributes

Returns

a new value if there were changes, or this if no changes

Definition Classes
override def toConfig: SimpleConfig

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

Definition Classes
override def toFallbackValue: AbstractConfigObject

Attributes

Definition Classes
override 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

Definition Classes
override def withFallback(mergeable: ConfigMergeable): AbstractConfigObject

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
override def withOrigin(origin: ConfigOrigin): AbstractConfigObject

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

Inherited methods

override def atKey(key: String): SimpleConfig

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.

Definition Classes
Inherited from:
AbstractConfigValue
override def atPath(pathExpression: String): SimpleConfig

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.

Definition Classes
Inherited from:
AbstractConfigValue
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
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Inherited from:
AbstractConfigValue
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 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.

Attributes

Inherited from:
Container
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Inherited from:
AbstractConfigValue
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
override def origin: SimpleConfigOrigin

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

Definition Classes
Inherited from:
AbstractConfigValue
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
final override 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

Definition Classes
Inherited from:
AbstractConfigValue
final override 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

Definition Classes
Inherited from:
AbstractConfigValue
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 replaceChild(child: AbstractConfigValue, replacement: AbstractConfigValue): AbstractConfigValue

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.

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.

Attributes

Inherited from:
Container
def size(): Int

Attributes

Inherited from:
Map
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Inherited from:
AbstractConfigValue
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
Inherited from:
ConfigObject
def values(): Collection[V]

Attributes

Inherited from:
Map
Generated with