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 classHtmlRenderer.BuilderBuilder for configuring anHtmlRenderer.static interfaceHtmlRenderer.HtmlRendererExtensionExtension forHtmlRenderer.private classHtmlRenderer.RendererContext
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<AttributeProviderFactory>attributeProviderFactoriesprivate booleanescapeHtmlprivate java.util.List<HtmlNodeRendererFactory>nodeRendererFactoriesprivate booleanomitSingleParagraphPprivate booleanpercentEncodeUrlsprivate booleansanitizeUrlsprivate java.lang.Stringsoftbreakprivate UrlSanitizerurlSanitizer
-
Constructor Summary
Constructors Modifier Constructor Description privateHtmlRenderer(HtmlRenderer.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HtmlRenderer.Builderbuilder()Create a new builder for configuring anHtmlRenderer.java.lang.Stringrender(Node node)Render the tree of nodes to string.voidrender(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:RendererRender the tree of nodes to output.
-
-