Package org.commonmark.renderer.text

Class TextContentRenderer.Builder

java.lang.Object

org.commonmark.renderer.text.TextContentRenderer.Builder

Enclosing class:

TextContentRenderer

public static class TextContentRenderer.Builder
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private LineBreakRendering	lineBreakRendering
private java.util.List<TextContentNodeRendererFactory>	nodeRendererFactories

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextContentRenderer	build()
TextContentRenderer.Builder	extensions(java.lang.Iterable<? extends Extension> extensions)
TextContentRenderer.Builder	lineBreakRendering(LineBreakRendering lineBreakRendering)	Configure how line breaks (newlines) are rendered, see LineBreakRendering.
TextContentRenderer.Builder	nodeRendererFactory(TextContentNodeRendererFactory nodeRendererFactory)	Add a factory for instantiating a node renderer (done when rendering).
TextContentRenderer.Builder	stripNewlines(boolean stripNewlines)	Deprecated. Use lineBreakRendering(LineBreakRendering) with LineBreakRendering.STRIP instead

Methods inherited from class java.lang.Object

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

Field Detail

nodeRendererFactories

private java.util.List<TextContentNodeRendererFactory> nodeRendererFactories

lineBreakRendering

private LineBreakRendering lineBreakRendering

Constructor Detail

Builder

public Builder()

Method Detail

build

public TextContentRenderer build()

Returns:

the configured TextContentRenderer

lineBreakRendering

public TextContentRenderer.Builder lineBreakRendering(LineBreakRendering lineBreakRendering)

Configure how line breaks (newlines) are rendered, see LineBreakRendering. The default is LineBreakRendering.COMPACT.

Parameters:

lineBreakRendering - the mode to use

Returns:

this

stripNewlines

@Deprecated
public TextContentRenderer.Builder stripNewlines(boolean stripNewlines)

Deprecated.

Use lineBreakRendering(LineBreakRendering) with LineBreakRendering.STRIP instead

Set the value of flag for stripping new lines.

Parameters:

stripNewlines - true for stripping new lines and render text as "single line", false for keeping all line breaks

Returns:

this

nodeRendererFactory

public TextContentRenderer.Builder nodeRendererFactory(TextContentNodeRendererFactory 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 TextContentRenderer.Builder extensions(java.lang.Iterable<? extends Extension> extensions)

Parameters:

extensions - extensions to use on this text content renderer

Returns:

this