trait ConfigParser extends AnyRef

A parser for obtaining a Config instance from a HOCON string.

The HOCON format expected by this parsers is specified at https://github.com/lightbend/config/blob/master/HOCON.md

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def includes: Seq[IncludeResource]

    Extracts all unresolved requested includes the parsed configuration contains, including those nested inside other objects.

    Extracts all unresolved requested includes the parsed configuration contains, including those nested inside other objects.

    Since the pure core module does not support effectful IO, this hook can be used by a higher level API to resolve includes and pass them to the resolve method.

  2. abstract def resolve(origin: Origin = Origin.root, fallback: Config = EmptyConfig, includes: IncludeMap = ConfigParser.includesNotSupported): Either[ConfigError, Config]

    Parses and resolves the parsed HOCON input.

    Parses and resolves the parsed HOCON input. This includes the resolving of substitution references and the merging of concatenated objects, arrays and strings.

    Failures may be caused by both, the parser and resolver step.

    The specified origin will be attached to every field. Origins can be used to distinguish values from a specific Config instance from those which were inherited from a fallback, which might be relevant in scenarios where relative paths need to be resolved for example.

    The specified fallback will be used for resolving keys which are not present in the configuration created by this parser.

    If an entire object is requested in the resulting Config instance, the keys will be merged from this parser with those present in the fallback. Simple values on the other hand will always override values with the same key in the fallback.

    The specified includes contain all resources that could be loaded based on the requested resources exposed by the includes property. Keeping the actual loading separate allows the resource loading step to be separate and in a module designed for effectful operations.

  3. abstract def unresolved: Either[ConfigError, ObjectBuilderValue]

    The unresolved result of the parser which can be used for processing inclusions that will be resolved in the context of the hosting configuration.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped