Module org.commonmark

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 Object

Builder for configuring a MarkdownRenderer. See methods for default configuration.

Field Summary

Fields

Modifier and Type	Field	Description
private String	lineSeparator
private final List<MarkdownNodeRendererFactory>	nodeRendererFactories

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MarkdownRenderer	build()
MarkdownRenderer.Builder	extensions(Iterable<? extends Extension> extensions)
MarkdownRenderer.Builder	lineSeparator(String lineSeparator)	Set the line separator (line terminator) that the writer should use.
MarkdownRenderer.Builder	nodeRendererFactory(MarkdownNodeRendererFactory nodeRendererFactory)	Add a factory for instantiating a node renderer (done when rendering).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lineSeparator

private String lineSeparator

nodeRendererFactories

private final List<MarkdownNodeRendererFactory> nodeRendererFactories

Constructor Details

Builder

public Builder()

Method Details

build

public MarkdownRenderer build()

Returns:

the configured MarkdownRenderer

lineSeparator

public MarkdownRenderer.Builder lineSeparator(String lineSeparator)

Set the line separator (line terminator) that the writer should use. The default is a newline (\n) on all systems.

Parameters:

lineSeparator -

Returns:

this

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(Iterable<? extends Extension> extensions)

Parameters:

extensions - extensions to use on this renderer

Returns:

this