laika.api.builder
Members list
Type members
Classlikes
A filter that might deactivate or activate some of the bundles based on user configuration.
A filter that might deactivate or activate some of the bundles based on user configuration.
Value parameters
- acceptRawContent
-
indicates that the users accepts the inclusion of raw content in text markup
- strict
-
indicates that text markup should be interpreted as defined by its specification, without any extensions
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Base API for specifying configuration options that apply to all kinds of operations (Parser, Renderer and Transformer).
Base API for specifying configuration options that apply to all kinds of operations (Parser, Renderer and Transformer).
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait ParserBuilderOpsclass ParserBuildertrait TransformerBuilderOps[FMT]class TransformerBuilder[FMT]trait RendererBuilderOps[FMT]class RendererBuilder[FMT]Show all
Represents the configuration for an operation based on extension bundles and several flags.
Represents the configuration for an operation based on extension bundles and several flags.
Provides convenient access to the result of merging the defined bundles and adding fallback options wherever necessary.
Value parameters
- bundleFilter
-
a filter that might deactivate some of the bundles based on user configuration
- bundles
-
all extension bundles defined by this operation
- configBuilder
-
a builder for assembling values for the base configuration as
- failOnMessages
-
the filter to apply to runtime messages that should cause the transformation to fail
- renderFormatted
-
indicates whether rendering should include any formatting (line breaks or indentation)
- renderMessages
-
the filter to apply to runtime messages that should be rendered in the output
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RenderConfigclass Objecttrait Matchableclass AnyShow all
Provides OperationConfig instances and a utility for merging bundles.
Provides OperationConfig instances and a utility for merging bundles.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
OperationConfig.type
Builder API for Parser instances.
Builder API for Parser instances.
Allows to add ExtensionBundles and the strict
and withRawContent
flags.
Attributes
- Supertypes
API for specifying configuration options that apply to all kinds of operations that contain a parsing step (Parser and Transformer).
API for specifying configuration options that apply to all kinds of operations that contain a parsing step (Parser and Transformer).
Attributes
- Supertypes
- Known subtypes
Represents the subset of OperationConfig relevant for renderers.
Represents the subset of OperationConfig relevant for renderers.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class OperationConfig
Builder API for Renderer instances.
Builder API for Renderer instances.
Allows to add ExtensionBundles, to override the renderer for specific elements and other options.
Type parameters
- FMT
-
the formatter API to use which varies depending on the renderer
Attributes
- Supertypes
API for specifying configuration options that apply to all kinds of operations that contain a rendering step (Renderer and Transformer).
API for specifying configuration options that apply to all kinds of operations that contain a rendering step (Renderer and Transformer).
Attributes
- Supertypes
- Known subtypes
Builder API for Transformer instances.
Builder API for Transformer instances.
Allows to add ExtensionBundles, to register AST rewrite rules, to override the renderer for specific elements and other options.
Type parameters
- FMT
-
the formatter API to use which varies depending on the renderer
Attributes
- Supertypes
-
trait TransformerBuilderOps[FMT]trait RendererBuilderOps[FMT]trait ParserBuilderOpstrait CommonBuilderOpsclass Objecttrait Matchableclass AnyShow all
API for specifying configuration options that apply to all kinds of operations that contain both, a parsing and a rendering step (only Transform API).
API for specifying configuration options that apply to all kinds of operations that contain both, a parsing and a rendering step (only Transform API).
Attributes
- Supertypes
-
trait RendererBuilderOps[FMT]trait ParserBuilderOpstrait CommonBuilderOpsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class TransformerBuilder[FMT]
Builder API for Renderer instances.
Builder API for Renderer instances.
Allows to add ExtensionBundles, to override the renderer for specific elements and other options.
Type parameters
- FMT
-
the formatter API to use which varies depending on the renderer
- PP
-
the type of the post processor
Attributes
- Supertypes
Builder API for Transformer instances.
Builder API for Transformer instances.
Allows to add ExtensionBundles, to register AST rewrite rules, to override the renderer for specific elements and other options.
Type parameters
- FMT
-
the formatter API to use which varies depending on the renderer
- PP
-
the type of the post processor
Attributes
- Supertypes
-
trait TransformerBuilderOps[FMT]trait RendererBuilderOps[FMT]trait ParserBuilderOpstrait CommonBuilderOpsclass Objecttrait Matchableclass AnyShow all