Package org.commonmark.renderer.text

Class TextContentRenderer

java.lang.Object

org.commonmark.renderer.text.TextContentRenderer

All Implemented Interfaces:

Renderer

public class TextContentRenderer
extends Object
implements Renderer

Renders nodes to plain text content with minimal markup-like additions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextContentRenderer.Builder	Builder for configuring a TextContentRenderer.
private class	TextContentRenderer.RendererContext
static interface	TextContentRenderer.TextContentRendererExtension	Extension for TextContentRenderer.

Field Summary

Fields

Modifier and Type	Field	Description
private final LineBreakRendering	lineBreakRendering
private final List<TextContentNodeRendererFactory>	nodeRendererFactories

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TextContentRenderer(TextContentRenderer.Builder builder)

Method Summary

Modifier and Type	Method	Description
static TextContentRenderer.Builder	builder()	Create a new builder for configuring a TextContentRenderer.
String	render(Node node)	Render the tree of nodes to string.
void	render(Node node, Appendable output)	Render the tree of nodes to output.

Methods inherited from class java.lang.Object

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

Field Details

lineBreakRendering

private final LineBreakRendering lineBreakRendering

nodeRendererFactories

private final List<TextContentNodeRendererFactory> nodeRendererFactories

Constructor Details

TextContentRenderer

private TextContentRenderer(TextContentRenderer.Builder builder)

Method Details

builder

public static TextContentRenderer.Builder builder()

Create a new builder for configuring a TextContentRenderer.

Returns:

a builder

render

public void render(Node node,
 Appendable output)

Description copied from interface: Renderer

Render the tree of nodes to output.

Specified by:

render in interface Renderer

Parameters:

node - the root node

output - output for rendering

render

public String render(Node node)

Description copied from interface: Renderer

Render the tree of nodes to string.

Specified by:

render in interface Renderer

Parameters:

node - the root node

Returns:

the rendered string