trait ConfigProvider extends AnyRef
Responsible for providing the parsers for configuration files
and configuration headers in markup documents as part of an
ExtensionBundle
.
Laika has a built-in implementation of this API that parses
configuration as HOCON, but these can be overridden by adding
an instance of this trait to a ParserBundle
within an ExtensionBundle
.
- Alphabetic
- By Inheritance
- ConfigProvider
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def configDocument(input: String): ConfigParser
The parser for configuration files recognized in input directories.
The parser for configuration files recognized in input directories.
The returned
ConfigParser
will be resolved lazily with a fallback Config provided by the runtime. This deferred resolution is necessary as substitution references in configuration headers can refer to values defined in configuration files or programmatically. - abstract def configHeader: Parser[ConfigParser]
The parser for configuration headers in markup documents.
The parser for configuration headers in markup documents.
The parser is expected to fail if it does not recognize the fence before and after the configuration header. Otherwise it is expected to succeed, without parsing the actual string input from the configuration header. This will happen lazily when the
ConfigParser
will be resolved with a fallback Config provided by the runtime. This deferred resolution is necessary as substitution references in configuration headers can refer to values defined in configuration files or programmatically.
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]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @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
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()