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

Modifier and Type	Field and Description
private final List<TextContentNodeRendererFactory>	nodeRendererFactories
private final boolean	stripNewlines

Access	Constructor and Description
private	TextContentRenderer(TextContentRenderer.Builder builder)

Method Summary

Modifier and Type	Method and Description
public static TextContentRenderer.Builder	Returns: a builder builder() Create a new builder for configuring a `TextContentRenderer`.
public void	render(Node node, Appendable output) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to output.
public String	render(Node node) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

nodeRendererFactories	back to summary
private final List<TextContentNodeRendererFactory> nodeRendererFactories

stripNewlines	back to summary
private final boolean stripNewlines

TextContentRenderer	back to summary
private TextContentRenderer(TextContentRenderer.Builder builder)

Method Detail

builder back to summary

builder	back to summary
public static TextContentRenderer.Builder builder() Create a new builder for configuring a `TextContentRenderer`. Returns:TextContentRenderer.Builder a builder

public static TextContentRenderer.Builder builder()

Create a new builder for configuring a TextContentRenderer.

Returns:TextContentRenderer.Builder: a builder

render	back to summary
public void render(Node node, Appendable output) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Doc from jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to output. Annotations @Override

render

back to summary

public void render(Node node, Appendable output)

Implements jdk.internal.org.commonmark.renderer.Renderer.render.

Doc from jdk.internal.org.commonmark.renderer.Renderer.render.

Render the tree of nodes to output.

Annotations

@Override

render	back to summary
public String render(Node node) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Doc from jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to string. Annotations @Override

render

back to summary

public String render(Node node)

Implements jdk.internal.org.commonmark.renderer.Renderer.render.

Doc from jdk.internal.org.commonmark.renderer.Renderer.render.

Render the tree of nodes to string.

Annotations

@Override

jdk.internal.org.commonmark.renderer.text back to summary

public Class TextContentRenderer.Builder

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.commonmark.renderer.text.TextContentRenderer.Builder

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

Field Summary

Modifier and Type	Field and Description
private List<TextContentNodeRendererFactory>	nodeRendererFactories
private boolean	stripNewlines

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public TextContentRenderer	build() Returns: the configured `TextContentRenderer`
public TextContentRenderer.Builder	extensions(Iterable<? extends Extension> extensions to use on this text content renderer extensions) Returns: `this`
public TextContentRenderer.Builder	Returns: `this` nodeRendererFactory(TextContentNodeRendererFactory the factory for creating a node renderer nodeRendererFactory) Add a factory for instantiating a node renderer (done when rendering).
public TextContentRenderer.Builder	Returns: `this` stripNewlines(boolean true for stripping new lines and render text as "single line", false for keeping all line breaks stripNewlines) Set the value of flag for stripping new lines.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

nodeRendererFactories	back to summary
private List<TextContentNodeRendererFactory> nodeRendererFactories

stripNewlines	back to summary
private boolean stripNewlines

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public TextContentRenderer build() Returns:TextContentRenderer the configured `TextContentRenderer`

extensions	back to summary
public TextContentRenderer.Builder extensions(Iterable<? extends Extension> extensions) Parameters extensions:Iterable<? extends Extension> extensions to use on this text content renderer Returns:TextContentRenderer.Builder `this`

nodeRendererFactory back to summary

nodeRendererFactory	back to summary
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:TextContentNodeRendererFactory the factory for creating a node renderer Returns:TextContentRenderer.Builder `this`

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:TextContentNodeRendererFactory: the factory for creating a node renderer

Returns:TextContentRenderer.Builder

this

stripNewlines back to summary

stripNewlines	back to summary
public TextContentRenderer.Builder stripNewlines(boolean stripNewlines) Set the value of flag for stripping new lines. Parameters stripNewlines:boolean true for stripping new lines and render text as "single line", false for keeping all line breaks Returns:TextContentRenderer.Builder `this`

public TextContentRenderer.Builder stripNewlines(boolean stripNewlines)

Set the value of flag for stripping new lines.

Parameters

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

Returns:TextContentRenderer.Builder

this

jdk.internal.org.commonmark.renderer.text back to summary

private Class TextContentRenderer.RendererContext

Class Inheritance

extends Object
implements TextContentNodeRendererContext

java.lang.Object
jdk.internal.org.commonmark.renderer.text.TextContentRenderer.RendererContext

All Implemented Interfaces

jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext

Field Summary

Modifier and Type	Field and Description
private final NodeRendererMap	nodeRendererMap
private final TextContentWriter	textContentWriter

Constructor Summary

Access	Constructor and Description
private	RendererContext(TextContentWriter textContentWriter)

Method Summary

Modifier and Type	Method and Description
public TextContentWriter	getWriter() Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.getWriter.
public void	render(Node node) Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.render. Render the specified node and its children using the configured renderers.
public boolean	stripNewlines() Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.stripNewlines.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

nodeRendererMap	back to summary
private final NodeRendererMap nodeRendererMap

textContentWriter	back to summary
private final TextContentWriter textContentWriter

Constructor Detail

RendererContext	back to summary
private RendererContext(TextContentWriter textContentWriter)

Method Detail

getWriter	back to summary
public TextContentWriter getWriter() Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.getWriter. Annotations @Override

getWriter

back to summary

public TextContentWriter getWriter()

Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.getWriter.

Annotations

@Override

render	back to summary
public void render(Node node) Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.render. Doc from jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.render. Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop. Annotations @Override

render

back to summary

public void render(Node node)

Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.render.

Doc from jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.render.

Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop.

Annotations

@Override

stripNewlines	back to summary
public boolean stripNewlines() Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.stripNewlines. Annotations @Override

stripNewlines

back to summary

public boolean stripNewlines()

Implements jdk.internal.org.commonmark.renderer.text.TextContentNodeRendererContext.stripNewlines.

Annotations

@Override

public Class TextContentRenderer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TextContentRenderer.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextContentRenderer.RendererContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface TextContentRenderer.TextContentRendererExtension

Method Summary

Method Detail