laika-core
API
Generated with
laika-core/laika/laika.api/laika.api.builder

laika.api.builder

package laika.api.builder

Members list

Type members

Classlikes

case class BundleFilter(strict: Boolean, acceptRawContent: Boolean)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait CommonBuilderOps

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 Object
trait Matchable
class Any
Known subtypes
class TransformerBuilder[FMT]
trait RendererBuilderOps[FMT]
class RendererBuilder[FMT]
class TwoPhaseRendererBuilder[FMT, PP]
Show all
case class OperationConfig(bundles: Seq[ExtensionBundle], bundleFilter: BundleFilter, configBuilder: ConfigBuilder, failOnMessages: MessageFilter, renderMessages: MessageFilter, renderFormatted: Boolean) extends RenderConfig

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 Serializable
trait Product
trait Equals
trait RenderConfig
class Object
trait Matchable
class Any
Show all
object OperationConfig

Provides OperationConfig instances and a utility for merging bundles.

Provides OperationConfig instances and a utility for merging bundles.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
class ParserBuilder(format: MarkupFormat, val config: OperationConfig) extends ParserBuilderOps

Builder API for Parser instances.

Builder API for Parser instances.

Allows to add ExtensionBundles and the strict and withRawContent flags.

Attributes

Supertypes
class Object
trait Matchable
class Any
trait ParserBuilderOps extends CommonBuilderOps

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
class Object
trait Matchable
class Any
Known subtypes
class TransformerBuilder[FMT]
trait RenderConfig

Represents the subset of OperationConfig relevant for renderers.

Represents the subset of OperationConfig relevant for renderers.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class RendererBuilder[FMT](val renderFormat: RenderFormat[FMT], val config: OperationConfig, skipRewritePhase: Boolean) extends RendererBuilderOps[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

Attributes

Supertypes
trait RendererBuilderOps[FMT]
class Object
trait Matchable
class Any
trait RendererBuilderOps[FMT] extends CommonBuilderOps

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
class Object
trait Matchable
class Any
Known subtypes
class RendererBuilder[FMT]
class TransformerBuilder[FMT]
class TwoPhaseRendererBuilder[FMT, PP]
class TransformerBuilder[FMT](markupFormat: MarkupFormat, val renderFormat: RenderFormat[FMT], val config: OperationConfig) extends TransformerBuilderOps[FMT]

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 RendererBuilderOps[FMT]
class Object
trait Matchable
class Any
Show all
trait TransformerBuilderOps[FMT] extends ParserBuilderOps, RendererBuilderOps[FMT]

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]
class Object
trait Matchable
class Any
Show all
Known subtypes
class TransformerBuilder[FMT]
class TwoPhaseRendererBuilder[FMT, PP](val twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP], val config: OperationConfig) extends RendererBuilderOps[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
trait RendererBuilderOps[FMT]
class Object
trait Matchable
class Any
class TwoPhaseTransformerBuilder[FMT, PP](val markupFormat: MarkupFormat, val twoPhaseRenderFormat: TwoPhaseRenderFormat[FMT, PP], val config: OperationConfig) extends TransformerBuilderOps[FMT]

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 RendererBuilderOps[FMT]
class Object
trait Matchable
class Any
Show all
Generated with