Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	HtmlRenderer.Builder Builder for configuring an `HtmlRenderer`.
public static interface	HtmlRenderer.HtmlRendererExtension Extension for `HtmlRenderer`.
private class	HtmlRenderer.RendererContext

Modifier and Type	Field and Description
private final List<AttributeProviderFactory>	attributeProviderFactories
private final boolean	escapeHtml
private final List<HtmlNodeRendererFactory>	nodeRendererFactories
private final boolean	percentEncodeUrls
private final boolean	sanitizeUrls
private final String	softbreak
private final UrlSanitizer	urlSanitizer

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

Method Summary

Modifier and Type	Method and Description
public static HtmlRenderer.Builder	Returns: a builder builder() Create a new builder for configuring an `HtmlRenderer`.
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

attributeProviderFactories	back to summary
private final List<AttributeProviderFactory> attributeProviderFactories

escapeHtml	back to summary
private final boolean escapeHtml

nodeRendererFactories	back to summary
private final List<HtmlNodeRendererFactory> nodeRendererFactories

percentEncodeUrls	back to summary
private final boolean percentEncodeUrls

sanitizeUrls	back to summary
private final boolean sanitizeUrls

softbreak	back to summary
private final String softbreak

urlSanitizer	back to summary
private final UrlSanitizer urlSanitizer

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

Method Detail

builder back to summary

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

public static HtmlRenderer.Builder builder()

Create a new builder for configuring an HtmlRenderer.

Returns:HtmlRenderer.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.html back to summary

public Class HtmlRenderer.Builder

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.commonmark.renderer.html.HtmlRenderer.Builder

Builder for configuring an HtmlRenderer. See methods for default configuration.

Field Summary

Modifier and Type	Field and Description
private List<AttributeProviderFactory>	attributeProviderFactories
private boolean	escapeHtml
private List<HtmlNodeRendererFactory>	nodeRendererFactories
private boolean	percentEncodeUrls
private boolean	sanitizeUrls
private String	softbreak
private UrlSanitizer	urlSanitizer

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public HtmlRenderer.Builder	Returns: `this` attributeProviderFactory(AttributeProviderFactory the attribute provider factory to add attributeProviderFactory) Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags.
public HtmlRenderer	build() Returns: the configured `HtmlRenderer`
public HtmlRenderer.Builder	Returns: `this` escapeHtml(boolean true for escaping, false for preserving raw HTML escapeHtml) Whether `HtmlInline` and `HtmlBlock` should be escaped, defaults to `false`.
public HtmlRenderer.Builder	extensions(Iterable<? extends Extension> extensions to use on this HTML renderer extensions) Returns: `this`
public HtmlRenderer.Builder	Returns: `this` nodeRendererFactory(HtmlNodeRendererFactory the factory for creating a node renderer nodeRendererFactory) Add a factory for instantiating a node renderer (done when rendering).
public HtmlRenderer.Builder	Returns: `this` percentEncodeUrls(boolean true to percent-encode, false for leaving as-is percentEncodeUrls) Whether URLs of link or images should be percent-encoded, defaults to `false`.
public HtmlRenderer.Builder	Returns: `this` sanitizeUrls(boolean true for sanitization, false for preserving raw attribute sanitizeUrls) Whether `Image` src and `Link` href should be sanitized, defaults to `false`.
public HtmlRenderer.Builder	Returns: `this` softbreak(String HTML for softbreak softbreak) The HTML to use for rendering a softbreak, defaults to `"\n"` (meaning the rendered result doesn't have a line break).
public HtmlRenderer.Builder	Returns: `this` urlSanitizer(UrlSanitizer Filterer used to filter `Image` src and `Link`. urlSanitizer) `UrlSanitizer` used to filter URL's if `sanitizeUrls` is true.

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

Field Detail

attributeProviderFactories	back to summary
private List<AttributeProviderFactory> attributeProviderFactories

escapeHtml	back to summary
private boolean escapeHtml

nodeRendererFactories	back to summary
private List<HtmlNodeRendererFactory> nodeRendererFactories

percentEncodeUrls	back to summary
private boolean percentEncodeUrls

sanitizeUrls	back to summary
private boolean sanitizeUrls

softbreak	back to summary
private String softbreak

urlSanitizer	back to summary
private UrlSanitizer urlSanitizer

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

attributeProviderFactory back to summary

attributeProviderFactory	back to summary
public HtmlRenderer.Builder attributeProviderFactory(AttributeProviderFactory attributeProviderFactory) Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags. Parameters attributeProviderFactory:AttributeProviderFactory the attribute provider factory to add Returns:HtmlRenderer.Builder `this`

public HtmlRenderer.Builder attributeProviderFactory(AttributeProviderFactory attributeProviderFactory)

Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags.

Parameters

attributeProviderFactory:AttributeProviderFactory: the attribute provider factory to add

Returns:HtmlRenderer.Builder

this

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

escapeHtml back to summary

escapeHtml	back to summary
public HtmlRenderer.Builder escapeHtml(boolean escapeHtml) Whether `HtmlInline` and `HtmlBlock` should be escaped, defaults to `false`. Note that `HtmlInline` is only a tag itself, not the text between an opening tag and a closing tag. So markup in the text will be parsed as normal and is not affected by this option. Parameters escapeHtml:boolean true for escaping, false for preserving raw HTML Returns:HtmlRenderer.Builder `this`

public HtmlRenderer.Builder escapeHtml(boolean escapeHtml)

Whether HtmlInline and HtmlBlock should be escaped, defaults to false.

Note that HtmlInline is only a tag itself, not the text between an opening tag and a closing tag. So markup in the text will be parsed as normal and is not affected by this option.

Parameters

escapeHtml:boolean: true for escaping, false for preserving raw HTML

Returns:HtmlRenderer.Builder

this

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

nodeRendererFactory back to summary

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

public HtmlRenderer.Builder nodeRendererFactory(HtmlNodeRendererFactory 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:HtmlNodeRendererFactory: the factory for creating a node renderer

Returns:HtmlRenderer.Builder

this

percentEncodeUrls back to summary

percentEncodeUrls	back to summary
public HtmlRenderer.Builder percentEncodeUrls(boolean percentEncodeUrls) Whether URLs of link or images should be percent-encoded, defaults to `false`. If enabled, the following is done: Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20") Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURI in JS) Unreserved characters such as "a" are preserved Other characters such umlauts are percent-encoded Parameters percentEncodeUrls:boolean true to percent-encode, false for leaving as-is Returns:HtmlRenderer.Builder `this`

public HtmlRenderer.Builder percentEncodeUrls(boolean percentEncodeUrls)

Whether URLs of link or images should be percent-encoded, defaults to false.

If enabled, the following is done:

Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20")
Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURI in JS)
Unreserved characters such as "a" are preserved
Other characters such umlauts are percent-encoded

Parameters

percentEncodeUrls:boolean: true to percent-encode, false for leaving as-is

Returns:HtmlRenderer.Builder

this

sanitizeUrls back to summary

sanitizeUrls	back to summary
public HtmlRenderer.Builder sanitizeUrls(boolean sanitizeUrls) Whether `Image` src and `Link` href should be sanitized, defaults to `false`. Parameters sanitizeUrls:boolean true for sanitization, false for preserving raw attribute Returns:HtmlRenderer.Builder `this` Since 0.14.0

public HtmlRenderer.Builder sanitizeUrls(boolean sanitizeUrls)

Whether Image src and Link href should be sanitized, defaults to false.

Parameters

sanitizeUrls:boolean: true for sanitization, false for preserving raw attribute

Returns:HtmlRenderer.Builder

this

Since

0.14.0

softbreak back to summary

softbreak	back to summary
public HtmlRenderer.Builder softbreak(String softbreak) The HTML to use for rendering a softbreak, defaults to `"\n"` (meaning the rendered result doesn't have a line break). Set it to `"<br>"` (or `"<br />"` to make them hard breaks. Set it to `" "` to ignore line wrapping in the source. Parameters softbreak:String HTML for softbreak Returns:HtmlRenderer.Builder `this`

public HtmlRenderer.Builder softbreak(String softbreak)

The HTML to use for rendering a softbreak, defaults to "\n" (meaning the rendered result doesn't have a line break).

Set it to "<br>" (or "<br />" to make them hard breaks.

Set it to " " to ignore line wrapping in the source.

Parameters

softbreak:String: HTML for softbreak

Returns:HtmlRenderer.Builder

this

urlSanitizer back to summary

urlSanitizer	back to summary
public HtmlRenderer.Builder urlSanitizer(UrlSanitizer urlSanitizer) `UrlSanitizer` used to filter URL's if `sanitizeUrls` is true. Parameters urlSanitizer:UrlSanitizer Filterer used to filter `Image` src and `Link`. Returns:HtmlRenderer.Builder `this` Since 0.14.0

public HtmlRenderer.Builder urlSanitizer(UrlSanitizer urlSanitizer)

UrlSanitizer used to filter URL's if sanitizeUrls is true.

Parameters

urlSanitizer:UrlSanitizer: Filterer used to filter Image src and Link.

Returns:HtmlRenderer.Builder

this

Since

0.14.0

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

public Interface HtmlRenderer.HtmlRendererExtension

Known Direct Implementers: jdk.internal.org.commonmark.ext.gfm.tables.TablesExtension

Extension for HtmlRenderer.

Method Summary

Modifier and Type	Method and Description
public void	extend(HtmlRenderer.Builder rendererBuilder)

Method Detail

extend	back to summary
public void extend(HtmlRenderer.Builder rendererBuilder)

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

private Class HtmlRenderer.RendererContext

Class Inheritance

extends Object
implements HtmlNodeRendererContext, AttributeProviderContext

java.lang.Object
jdk.internal.org.commonmark.renderer.html.HtmlRenderer.RendererContext

All Implemented Interfaces

jdk.internal.org.commonmark.renderer.html.AttributeProviderContext, jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext

Field Summary

Modifier and Type	Field and Description
private final List<AttributeProvider>	attributeProviders
private final HtmlWriter	htmlWriter
private final NodeRendererMap	nodeRendererMap

Constructor Summary

Access	Constructor and Description
private	RendererContext(HtmlWriter htmlWriter)

Method Summary

Modifier and Type	Method and Description
public String	encodeUrl(String url) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.encodeUrl.
public Map<String, String>	extendAttributes(Node node, String tagName, Map<String, String> attributes) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.extendAttributes. Let extensions modify the HTML tag attributes.
public String	getSoftbreak() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getSoftbreak.
public HtmlWriter	getWriter() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getWriter.
public void	render(Node node) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.render. Render the specified node and its children using the configured renderers.
private void	setCustomAttributes(Node node, String tagName, Map<String, String> attrs)
public boolean	shouldEscapeHtml() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.shouldEscapeHtml.
public boolean	shouldSanitizeUrls() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.shouldSanitizeUrls.
public UrlSanitizer	urlSanitizer() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.urlSanitizer.

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

Field Detail

attributeProviders	back to summary
private final List<AttributeProvider> attributeProviders

htmlWriter	back to summary
private final HtmlWriter htmlWriter

nodeRendererMap	back to summary
private final NodeRendererMap nodeRendererMap

Constructor Detail

RendererContext	back to summary
private RendererContext(HtmlWriter htmlWriter)

Method Detail

encodeUrl	back to summary
public String encodeUrl(String url) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.encodeUrl. Annotations @Override

encodeUrl

back to summary

public String encodeUrl(String url)

Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.encodeUrl.

Annotations

@Override

extendAttributes	back to summary
public Map<String, String> extendAttributes(Node node, String tagName, Map<String, String> attributes) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.extendAttributes. Doc from jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.extendAttributes. Let extensions modify the HTML tag attributes. Annotations @Override

extendAttributes

back to summary

public Map<String, String> extendAttributes(Node node, String tagName, Map<String, String> attributes)

Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.extendAttributes.

Doc from jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.extendAttributes.

Let extensions modify the HTML tag attributes.

Annotations

@Override

getSoftbreak	back to summary
public String getSoftbreak() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getSoftbreak. Annotations @Override

getSoftbreak

back to summary

public String getSoftbreak()

Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getSoftbreak.

Annotations

@Override

getWriter	back to summary
public HtmlWriter getWriter() Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getWriter. Annotations @Override

getWriter

back to summary

public HtmlWriter getWriter()

Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.getWriter.

Annotations

@Override

render	back to summary
public void render(Node node) Implements jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.render. Doc from jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.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.html.HtmlNodeRendererContext.render.

Doc from jdk.internal.org.commonmark.renderer.html.HtmlNodeRendererContext.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