Package org.commonmark.renderer.markdown
Class MarkdownRenderer.Builder
- java.lang.Object
-
- org.commonmark.renderer.markdown.MarkdownRenderer.Builder
-
- Enclosing class:
- MarkdownRenderer
public static class MarkdownRenderer.Builder extends java.lang.Object
Builder for configuring aMarkdownRenderer
. See methods for default configuration.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<MarkdownNodeRendererFactory>
nodeRendererFactories
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MarkdownRenderer
build()
MarkdownRenderer.Builder
extensions(java.lang.Iterable<? extends Extension> extensions)
MarkdownRenderer.Builder
nodeRendererFactory(MarkdownNodeRendererFactory nodeRendererFactory)
Add a factory for instantiating a node renderer (done when rendering).
-
-
-
Field Detail
-
nodeRendererFactories
private final java.util.List<MarkdownNodeRendererFactory> nodeRendererFactories
-
-
Method Detail
-
build
public MarkdownRenderer build()
- Returns:
- the configured
MarkdownRenderer
-
nodeRendererFactory
public MarkdownRenderer.Builder nodeRendererFactory(MarkdownNodeRendererFactory nodeRendererFactory)
Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)
- Parameters:
nodeRendererFactory
- the factory for creating a node renderer- Returns:
this
-
extensions
public MarkdownRenderer.Builder extensions(java.lang.Iterable<? extends Extension> extensions)
- Parameters:
extensions
- extensions to use on this renderer- Returns:
this
-
-