Package org.commonmark.renderer.markdown

Class CoreMarkdownNodeRenderer

java.lang.Object

org.commonmark.node.AbstractVisitor

org.commonmark.renderer.markdown.CoreMarkdownNodeRenderer

All Implemented Interfaces:

Visitor, NodeRenderer

public class CoreMarkdownNodeRenderer
extends AbstractVisitor
implements NodeRenderer

The node renderer that renders all the core nodes (comes last in the order of node renderers).

Note that while sometimes it would be easier to record what kind of syntax was used on parsing (e.g. ATX vs Setext heading), this renderer is intended to also work for documents that were created by directly creating Nodes instead. So in order to support that, it sometimes needs to do a bit more work.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CoreMarkdownNodeRenderer.BulletListHolder
private static class	CoreMarkdownNodeRenderer.LineBreakVisitor	Visits nodes to check if there are any soft or hard line breaks.
private static class	CoreMarkdownNodeRenderer.ListHolder
private static class	CoreMarkdownNodeRenderer.OrderedListHolder

Field Summary

Fields

Modifier and Type	Field	Description
protected final MarkdownNodeRendererContext	context
private final CharMatcher	linkDestinationEscapeInAngleBrackets
private final CharMatcher	linkDestinationNeedsAngleBrackets
private final CharMatcher	linkTitleEscapeInQuotes
private CoreMarkdownNodeRenderer.ListHolder	listHolder	If we're currently within a BulletList or OrderedList, this keeps the context of that list.
private final Pattern	orderedListMarkerPattern
private final AsciiMatcher	textEscape
private final CharMatcher	textEscapeInHeading
private final MarkdownWriter	writer

Constructor Summary

Constructors

Constructor	Description
CoreMarkdownNodeRenderer(MarkdownNodeRendererContext context)

Method Summary

Modifier and Type	Method	Description
private static boolean	contains(String s, CharMatcher charMatcher)
private static int	findMaxRunLength(String needle, String s)
private static List<String>	getLines(String literal)
Set<Class<? extends Node>>	getNodeTypes()
void	render(Node node)	Render the specified node.
private static String	repeat(String s, int count)
void	visit(BlockQuote blockQuote)
void	visit(BulletList bulletList)
void	visit(Code code)
void	visit(Document document)
void	visit(Emphasis emphasis)
void	visit(FencedCodeBlock codeBlock)
void	visit(HardLineBreak hardLineBreak)
void	visit(Heading heading)
void	visit(HtmlBlock htmlBlock)
void	visit(HtmlInline htmlInline)
void	visit(Image image)
void	visit(IndentedCodeBlock indentedCodeBlock)
void	visit(Link link)
void	visit(ListItem listItem)
void	visit(OrderedList orderedList)
void	visit(Paragraph paragraph)
void	visit(SoftLineBreak softLineBreak)
void	visit(StrongEmphasis strongEmphasis)
void	visit(Text text)
void	visit(ThematicBreak thematicBreak)
protected void	visitChildren(Node parent)	Visit the child nodes.
private void	writeLinkLike(String title, String destination, Node node, String opener)

Methods inherited from class org.commonmark.node.AbstractVisitor

visit, visit, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.commonmark.renderer.NodeRenderer

afterRoot, beforeRoot

Field Details

textEscape

private final AsciiMatcher textEscape

textEscapeInHeading

private final CharMatcher textEscapeInHeading

linkDestinationNeedsAngleBrackets

private final CharMatcher linkDestinationNeedsAngleBrackets

linkDestinationEscapeInAngleBrackets

private final CharMatcher linkDestinationEscapeInAngleBrackets

linkTitleEscapeInQuotes

private final CharMatcher linkTitleEscapeInQuotes

orderedListMarkerPattern

private final Pattern orderedListMarkerPattern

context

protected final MarkdownNodeRendererContext context

writer

private final MarkdownWriter writer

listHolder

private CoreMarkdownNodeRenderer.ListHolder listHolder

If we're currently within a BulletList or OrderedList, this keeps the context of that list. It has a parent field so that it can represent a stack (for nested lists).

Constructor Details

CoreMarkdownNodeRenderer

public CoreMarkdownNodeRenderer(MarkdownNodeRendererContext context)

Method Details

getNodeTypes

public Set<Class<? extends Node>> getNodeTypes()

Specified by:

getNodeTypes in interface NodeRenderer

Returns:

the types of nodes that this renderer handles

render

public void render(Node node)

Description copied from interface: NodeRenderer

Render the specified node.

Specified by:

render in interface NodeRenderer

Parameters:

node - the node to render, will be an instance of one of NodeRenderer.getNodeTypes()

visit

public void visit(Document document)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(ThematicBreak thematicBreak)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Heading heading)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(IndentedCodeBlock indentedCodeBlock)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(FencedCodeBlock codeBlock)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(HtmlBlock htmlBlock)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Paragraph paragraph)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(BlockQuote blockQuote)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(BulletList bulletList)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(OrderedList orderedList)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(ListItem listItem)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Code code)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Emphasis emphasis)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(StrongEmphasis strongEmphasis)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Link link)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Image image)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(HtmlInline htmlInline)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(HardLineBreak hardLineBreak)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(SoftLineBreak softLineBreak)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visit

public void visit(Text text)

Specified by:

visit in interface Visitor

Overrides:

visit in class AbstractVisitor

visitChildren

protected void visitChildren(Node parent)

Description copied from class: AbstractVisitor

Visit the child nodes.

Overrides:

visitChildren in class AbstractVisitor

Parameters:

parent - the parent node whose children should be visited

findMaxRunLength

private static int findMaxRunLength(String needle,
 String s)

contains

private static boolean contains(String s,
 CharMatcher charMatcher)

repeat

private static String repeat(String s,
 int count)

getLines

private static List<String> getLines(String literal)

writeLinkLike

private void writeLinkLike(String title,
 String destination,
 Node node,
 String opener)