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

SerializedConfigValue

org.ekrich.config.impl.SerializedConfigValue
See theSerializedConfigValue companion object
class SerializedConfigValue() extends AbstractConfigValue, Externalizable

Attributes

Companion
object
Graph
Supertypes
trait Externalizable
trait Serializable
trait ConfigValue
class Object
trait Matchable
class Any
Show all

Members list

Value members

Constructors

def this(value: ConfigValue)
def this(conf: Config)

Concrete methods

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
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
override def newCopy(origin: ConfigOrigin): AbstractConfigValue

Attributes

Definition Classes
override def readExternal(in: ObjectInput): Unit

Attributes

Definition Classes
Externalizable
final 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
override def unwrapped: AnyRef

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

Attributes

Returns

a plain Java value corresponding to this ConfigValue

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 writeExternal(out: ObjectOutput): Unit

Attributes

Definition Classes
Externalizable

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

Attributes

Inherited from:
AbstractConfigValue
def resolveSubstitutions(context: ResolveContext, source: ResolveSource): ResolveResult[_ <: AbstractConfigValue]

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

Inherited from:
AbstractConfigValue
override def toFallbackValue: AbstractConfigValue

Attributes

Definition Classes
Inherited from:
AbstractConfigValue
override def withFallback(mergeable: ConfigMergeable): AbstractConfigValue

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

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 from:
AbstractConfigValue

Inherited fields

val _origin: ConfigOrigin

Attributes

Inherited from:
AbstractConfigValue
Generated with