Package org.commonmark.renderer.html
Class HtmlRenderer
- java.lang.Object
-
- org.commonmark.renderer.html.HtmlRenderer
-
- All Implemented Interfaces:
Renderer
public class HtmlRenderer extends java.lang.Object implements Renderer
Renders a tree of nodes to HTML.Start with the
builder()
method to configure the renderer. Example:HtmlRenderer renderer = HtmlRenderer.builder().escapeHtml(true).build(); renderer.render(node);
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HtmlRenderer.Builder
Builder for configuring anHtmlRenderer
.static interface
HtmlRenderer.HtmlRendererExtension
Extension forHtmlRenderer
.private class
HtmlRenderer.RendererContext
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<AttributeProviderFactory>
attributeProviderFactories
private boolean
escapeHtml
private java.util.List<HtmlNodeRendererFactory>
nodeRendererFactories
private boolean
omitSingleParagraphP
private boolean
percentEncodeUrls
private boolean
sanitizeUrls
private java.lang.String
softbreak
private UrlSanitizer
urlSanitizer
-
Constructor Summary
Constructors Modifier Constructor Description private
HtmlRenderer(HtmlRenderer.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HtmlRenderer.Builder
builder()
Create a new builder for configuring anHtmlRenderer
.java.lang.String
render(Node node)
Render the tree of nodes to string.void
render(Node node, java.lang.Appendable output)
Render the tree of nodes to output.
-
-
-
Field Detail
-
softbreak
private final java.lang.String softbreak
-
escapeHtml
private final boolean escapeHtml
-
percentEncodeUrls
private final boolean percentEncodeUrls
-
omitSingleParagraphP
private final boolean omitSingleParagraphP
-
sanitizeUrls
private final boolean sanitizeUrls
-
urlSanitizer
private final UrlSanitizer urlSanitizer
-
attributeProviderFactories
private final java.util.List<AttributeProviderFactory> attributeProviderFactories
-
nodeRendererFactories
private final java.util.List<HtmlNodeRendererFactory> nodeRendererFactories
-
-
Constructor Detail
-
HtmlRenderer
private HtmlRenderer(HtmlRenderer.Builder builder)
-
-
Method Detail
-
builder
public static HtmlRenderer.Builder builder()
Create a new builder for configuring anHtmlRenderer
.- Returns:
- a builder
-
render
public void render(Node node, java.lang.Appendable output)
Description copied from interface:Renderer
Render the tree of nodes to output.
-
-