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.

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

Abstract Value Members

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

  2. abstract def markupConfigHeader: 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.

  3. abstract def templateConfigHeader: Parser[ConfigParser]

    The parser for configuration headers in template documents.

    The parser for configuration headers in template 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

  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. def forStrictMode: ConfigProvider

    Returns a new config provider for strict mode that disables all extensions for text markup documents which should run only features of the original markup spec.

    Returns a new config provider for strict mode that disables all extensions for text markup documents which should run only features of the original markup spec. Templates and configuration files remain unaffected.

  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. 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