package hocon
- Alphabetic
- Public
- All
Type Members
-
case class
ArrayBuilderValue(values: Seq[ConfigBuilderValue]) extends ConfigBuilderValue with Product with Serializable
An array value with all its elements.
-
case class
BuilderField(key: Either[InvalidStringValue, Key], value: ConfigBuilderValue) extends Product with Serializable
A single field of an object value.
-
case class
ConcatPart(whitespace: String, value: ConfigBuilderValue) extends Product with Serializable
A single part of a concatenated value with the whitespace between this and the previous value preserved.
-
case class
ConcatValue(first: ConfigBuilderValue, rest: Seq[ConcatPart]) extends ConfigBuilderValue with Product with Serializable
A concatenated value (either all objects, all arrays, all simple values or invalid).
-
sealed
trait
ConfigBuilderValue extends Product with Serializable
The base trait of the interim configuration model (usually obtained from a HOCON parser).
The base trait of the interim configuration model (usually obtained from a HOCON parser).
This type is not exposed to public APIs as it will be translated to a final object structure later. It contains instances representing interim constructs like concatenated values or substitution variables which will not be present in the final model.
- case class IncludeAny(resourceId: StringBuilderValue, isRequired: Boolean = false) extends IncludeResource with Product with Serializable
- case class IncludeBuilderValue(resource: IncludeResource) extends ConfigBuilderValue with Product with Serializable
- case class IncludeClassPath(resourceId: StringBuilderValue, isRequired: Boolean = false) extends IncludeResource with Product with Serializable
- case class IncludeFile(resourceId: StringBuilderValue, isRequired: Boolean = false) extends IncludeResource with Product with Serializable
-
sealed
trait
IncludeResource extends AnyRef
Description of a resource to be included in the current configuration.
- case class IncludeUrl(resourceId: StringBuilderValue, isRequired: Boolean = false) extends IncludeResource with Product with Serializable
- case class InvalidBuilderValue(value: ConfigBuilderValue, failure: Failure) extends ConfigBuilderValue with Product with Serializable
- case class InvalidStringValue(value: String, failure: Failure) extends StringBuilderValue with Product with Serializable
-
case class
MergedValue(values: Seq[ConfigBuilderValue]) extends ConfigBuilderValue with Product with Serializable
A merged value with "last one wins" semantics for the provided values (objects will be merged instead).
-
case class
ObjectBuilderValue(values: Seq[BuilderField]) extends ConfigBuilderValue with Product with Serializable
An object value with all its fields.
-
case class
ResolvedBuilderValue(value: SimpleConfigValue) extends ConfigBuilderValue with Product with Serializable
A simple configuration value that does not need to be recursively resolved.
- sealed trait StringBuilderValue extends ConfigBuilderValue
-
case class
SubstitutionValue(ref: Key, optional: Boolean) extends ConfigBuilderValue with Product with Serializable
A substitution reference that may be marked as optional.
- case class ValidStringValue(value: String) extends StringBuilderValue with Product with Serializable
Value Members
- object BuilderField extends Serializable
-
object
ConfigResolver
Translates the interim configuration model (usually obtained from a HOCON parser) into the final object model.
Translates the interim configuration model (usually obtained from a HOCON parser) into the final object model. It turns a root
ObjectBuilderValue
into a rootObjectValue
.The translation step involves the following steps:
- Expand keys (e.g.
{ a.b.c = 7 }
will become{ a = { b = { c = 7 }}}
will become- Merge objects with a common base path - Merge concatenated values (e.g.
[1,2] [3,4][1,2,3,4]
- Resolve substitution variables (potentially using the provided fallback if not found in in the provided unresolved root)- Expand keys (e.g.
{ a.b.c = 7 }
will become{ a = { b = { c = 7 }}} - Merge objects with a common base path - Merge concatenated values (e.g.
[1,2] [3,4]will become
[1,2,3,4]- Resolve substitution variables (potentially using the provided fallback if not found in in the provided unresolved root)
-
object
HoconParsers
The parser implementation for the HOCON format.
The parser implementation for the HOCON format.
It currently supports the full spec as documented in https://github.com/lightbend/config/blob/master/HOCON.md.
-
object
SelfReference extends ConfigBuilderValue with Product with Serializable
A marker for a self reference, a reference to an earlier definition with the same key.
- object SubstitutionValue extends Serializable