Uses of Class
org.commonmark.node.Node
Packages that use Node
Package
Description
AST node types (see
Node) and visitors (see AbstractVisitor)Parsing input text to AST nodes (see
Parser)Experimental APIs to use for extensions.
HTML rendering (see
HtmlRenderer)Markdown rendering (see
MarkdownRenderer)Plain text rendering with minimal markup (see
TextContentRenderer)-
Uses of Node in org.commonmark.ext.autolink.internal
Methods in org.commonmark.ext.autolink.internal that return NodeModifier and TypeMethodDescriptionprivate static NodeAutolinkPostProcessor.insertNode(Node node, Node insertAfterNode) Methods in org.commonmark.ext.autolink.internal with parameters of type Node -
Uses of Node in org.commonmark.ext.footnotes
Subclasses of Node in org.commonmark.ext.footnotesModifier and TypeClassDescriptionclassA footnote definition, e.g.:classA footnote reference, e.g.class -
Uses of Node in org.commonmark.ext.footnotes.internal
Fields in org.commonmark.ext.footnotes.internal declared as NodeModifier and TypeFieldDescriptionprivate final NodeFootnoteHtmlNodeRenderer.ShallowReferenceVisitor.parentFields in org.commonmark.ext.footnotes.internal with type parameters of type NodeModifier and TypeFieldDescriptionFootnoteHtmlNodeRenderer.ShallowReferenceVisitor.consumerprivate final Map<Node,FootnoteHtmlNodeRenderer.ReferencedDefinition> FootnoteHtmlNodeRenderer.referencedDefinitionsDefinitions that were referenced, in order in which they should be rendered.private final Map<Node,FootnoteHtmlNodeRenderer.ReferenceInfo> FootnoteHtmlNodeRenderer.referencesInformation about references that should be rendered as footnotes.Methods in org.commonmark.ext.footnotes.internal that return types with arguments of type NodeModifier and TypeMethodDescriptionFootnoteHtmlNodeRenderer.getNodeTypes()FootnoteMarkdownNodeRenderer.getNodeTypes()Methods in org.commonmark.ext.footnotes.internal with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidFootnoteHtmlNodeRenderer.beforeRoot(Node rootNode) FootnoteHtmlNodeRenderer.registerReference(Node node, String label) voidvoidprivate voidFootnoteHtmlNodeRenderer.renderBackrefs(Node def, FootnoteHtmlNodeRenderer.ReferencedDefinition referencedDefinition) private voidFootnoteHtmlNodeRenderer.renderChildren(Node parent) private voidFootnoteMarkdownNodeRenderer.renderChildren(Node parent) private voidFootnoteHtmlNodeRenderer.renderDefinition(Node def, FootnoteHtmlNodeRenderer.ReferencedDefinition referencedDefinition) private voidFootnoteHtmlNodeRenderer.renderReference(Node node, FootnoteHtmlNodeRenderer.ReferenceInfo referenceInfo) Constructors in org.commonmark.ext.footnotes.internal with parameters of type NodeModifierConstructorDescriptionprivateShallowReferenceVisitor(Node parent, Consumer<Node> consumer) Constructor parameters in org.commonmark.ext.footnotes.internal with type arguments of type NodeModifierConstructorDescriptionprivateShallowReferenceVisitor(Node parent, Consumer<Node> consumer) -
Uses of Node in org.commonmark.ext.front.matter
Subclasses of Node in org.commonmark.ext.front.matterModifier and TypeClassDescriptionclassclassclassMethods in org.commonmark.ext.front.matter with parameters of type NodeModifier and TypeMethodDescriptionReads the YAML front matter metadata, if the Markdown document has the front matter and the extension usesYamlSubsetParser(default).static StringYamlFrontMatterVisitor.readRawContent(Node document) Reads the raw content of the front matter, if the Markdown document has the front matter and the extension usesRawContentParser. -
Uses of Node in org.commonmark.ext.front.matter.internal
Methods in org.commonmark.ext.front.matter.internal that return types with arguments of type NodeMethods in org.commonmark.ext.front.matter.internal with parameters of type Node -
Uses of Node in org.commonmark.ext.gfm.alerts
Subclasses of Node in org.commonmark.ext.gfm.alertsModifier and TypeClassDescriptionclassAlert block for highlighting important information using[!TYPE]syntax.classInline content container for the optional custom title of anAlert. -
Uses of Node in org.commonmark.ext.gfm.alerts.internal
Methods in org.commonmark.ext.gfm.alerts.internal that return types with arguments of type NodeMethods in org.commonmark.ext.gfm.alerts.internal with parameters of type NodeModifier and TypeMethodDescriptionvoidprotected final voidAlertNodeRenderer.renderChildren(Node parent) Renders the children of a parent node, excludingAlertTitlenodes.protected voidAlertHtmlNodeRenderer.renderNode(Node node) protected voidAlertMarkdownNodeRenderer.renderNode(Node node) protected abstract voidAlertNodeRenderer.renderNode(Node node) Renders a single node.protected voidAlertTextContentNodeRenderer.renderNode(Node node) -
Uses of Node in org.commonmark.ext.gfm.strikethrough
Subclasses of Node in org.commonmark.ext.gfm.strikethroughModifier and TypeClassDescriptionclassA strikethrough node containing text and other inline nodes as children. -
Uses of Node in org.commonmark.ext.gfm.strikethrough.internal
Methods in org.commonmark.ext.gfm.strikethrough.internal that return types with arguments of type NodeMethods in org.commonmark.ext.gfm.strikethrough.internal with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidvoidprivate voidStrikethroughHtmlNodeRenderer.renderChildren(Node parent) private voidStrikethroughMarkdownNodeRenderer.renderChildren(Node parent) private voidStrikethroughTextContentNodeRenderer.renderChildren(Node parent) -
Uses of Node in org.commonmark.ext.gfm.tables
Subclasses of Node in org.commonmark.ext.gfm.tablesModifier and TypeClassDescriptionclassclassBody part of aTableBlockcontainingTableRows.classTable cell of aTableRowcontaining inline nodes.classHead part of aTableBlockcontainingTableRows.class -
Uses of Node in org.commonmark.ext.gfm.tables.internal
Methods in org.commonmark.ext.gfm.tables.internal that return types with arguments of type NodeMethods in org.commonmark.ext.gfm.tables.internal with parameters of type NodeModifier and TypeMethodDescriptionTableHtmlNodeRenderer.getAttributes(Node node, String tagName) voidprivate voidTableHtmlNodeRenderer.renderChildren(Node parent) private voidTableMarkdownNodeRenderer.renderChildren(Node parent) private voidTableTextContentNodeRenderer.renderChildren(Node parent) -
Uses of Node in org.commonmark.ext.heading.anchor.internal
Methods in org.commonmark.ext.heading.anchor.internal with parameters of type Node -
Uses of Node in org.commonmark.ext.image.attributes
Subclasses of Node in org.commonmark.ext.image.attributesModifier and TypeClassDescriptionclassA node containing text and other inline nodes as children. -
Uses of Node in org.commonmark.ext.image.attributes.internal
Methods in org.commonmark.ext.image.attributes.internal with parameters of type Node -
Uses of Node in org.commonmark.ext.ins
Subclasses of Node in org.commonmark.ext.insModifier and TypeClassDescriptionclassAn ins node containing text and other inline nodes as children. -
Uses of Node in org.commonmark.ext.ins.internal
Methods in org.commonmark.ext.ins.internal that return types with arguments of type NodeMethods in org.commonmark.ext.ins.internal with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidvoidprivate voidInsHtmlNodeRenderer.renderChildren(Node parent) private voidInsMarkdownNodeRenderer.renderChildren(Node parent) private voidInsTextContentNodeRenderer.renderChildren(Node parent) -
Uses of Node in org.commonmark.ext.task.list.items
Subclasses of Node in org.commonmark.ext.task.list.itemsModifier and TypeClassDescriptionclassA marker node indicating that a list item contains a task. -
Uses of Node in org.commonmark.ext.task.list.items.internal
Methods in org.commonmark.ext.task.list.items.internal that return NodeMethods in org.commonmark.ext.task.list.items.internal that return types with arguments of type NodeMethods in org.commonmark.ext.task.list.items.internal with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidprivate voidTaskListItemHtmlNodeRenderer.renderChildren(Node parent) private voidTaskListItemMarkdownNodeRenderer.renderChildren(Node parent) -
Uses of Node in org.commonmark.internal
Fields in org.commonmark.internal with type parameters of type NodeMethods in org.commonmark.internal that return NodeModifier and TypeMethodDescriptionprivate NodeInlineParserImpl.parseCloseBracket()Try to match close bracket against an opening in the delimiter stack.private NodeInlineParserImpl.parseLineBreak()private NodeInlineParserImpl.parseLinkOrImage(Bracket opener, Position beforeClose) private NodeInlineParserImpl.parseOpenBracket()Add open bracket to delimiter stack and add a text node to block's children.private NodeInlineParserImpl.parseText()Parse the next character as plain text, and possibly more if the following characters are non-special.private NodeInlineParserImpl.replaceBracket(Bracket opener, Node node, boolean includeMarker) private NodeInlineParserImpl.wrapBracket(Bracket opener, Node wrapperNode, boolean includeMarker) Methods in org.commonmark.internal that return types with arguments of type NodeModifier and TypeMethodDescriptionInlineParserImpl.parseDelimiters(DelimiterProcessor delimiterProcessor, char delimiterChar) Attempt to parse delimiters like emphasis, strong emphasis or custom delimiters.InlineParserImpl.parseInline()Parse the next inline element in subject, advancing our position.InlineParserImpl.parseLinkMarker()If next character is[, add a bracket to the stack.Methods in org.commonmark.internal with parameters of type NodeModifier and TypeMethodDescriptionprivate voidInlineParserImpl.mergeChildTextNodes(Node node) private voidInlineParserImpl.mergeTextNodesInclusive(Node parent, Deque<Node> parents) private intInlineParserImpl.nestingDepthOfSiblings(Node first, Node end) voidInlineParserImpl.parse(SourceLines lines, Node block) Parse content in block into inline children, appending them to the block node.private voidInlineParserImpl.recordNestingDepth(Node node, int depth) Remember how deeply nested a node we just created is, so that anything wrapping it later sees the depth it contributes: an enclosing delimiter pair looks it up viaInlineParserImpl.nestingDepthOfSiblings(org.commonmark.node.Node, org.commonmark.node.Node)(it needs the depth of a range of nodes), an enclosing bracket via the running maximum onBracket.contentNestingDepth(it needs the depth of all content since the bracket was opened, so it can avoid looking at the nodes at all).private NodeInlineParserImpl.replaceBracket(Bracket opener, Node node, boolean includeMarker) private NodeInlineParserImpl.wrapBracket(Bracket opener, Node wrapperNode, boolean includeMarker) Method parameters in org.commonmark.internal with type arguments of type NodeModifier and TypeMethodDescriptionprivate voidInlineParserImpl.mergeTextNodesInclusive(Node parent, Deque<Node> parents) -
Uses of Node in org.commonmark.internal.inline
Fields in org.commonmark.internal.inline declared as NodeModifier and TypeFieldDescriptionprivate final NodeLinkResultImpl.nodeprivate final NodeParsedInlineImpl.nodeMethods in org.commonmark.internal.inline that return NodeConstructors in org.commonmark.internal.inline with parameters of type NodeModifierConstructorDescriptionLinkResultImpl(LinkResultImpl.Type type, Node node, Position position) ParsedInlineImpl(Node node, Position position) -
Uses of Node in org.commonmark.internal.renderer
Fields in org.commonmark.internal.renderer with type parameters of type NodeModifier and TypeFieldDescriptionprivate final Map<Class<? extends Node>,NodeRenderer> NodeRendererMap.renderersMethods in org.commonmark.internal.renderer with parameters of type Node -
Uses of Node in org.commonmark.node
Subclasses of Node in org.commonmark.nodeModifier and TypeClassDescriptionclassBlock nodes such as paragraphs, list blocks, code blocks etc.classA block quote, e.g.:classA bullet list, e.g.:classInline code span, e.g.:classA block that extensions can subclass to define custom blocks (not part of the core specification).classA node that extensions can subclass to define custom nodes (not part of the core specification).classThe root block of a document, containing the top-level blocks.classEmphasis, e.g.:classA fenced code block, e.g.:classA hard line break, e.g.:classA heading, e.g.:classHTML blockclassInline HTML element.classAn image, e.g.:classAn indented code block, e.g.:classA link with a destination and an optional title; the link text is in child nodes.classA link reference definition, e.g.:classA list block likeBulletListorOrderedList.classA child of aListBlock, containing other blocks (e.g.classAn ordered list, e.g.:classA paragraph block, contains inline nodes such asTextclassA soft line break (as opposed to aHardLineBreak), e.g.classStrong emphasis, e.g.:classA text node, e.g.classA thematic break, e.g.Fields in org.commonmark.node declared as NodeModifier and TypeFieldDescriptionprivate final NodeNodes.NodeIterable.endprivate final NodeNodes.NodeIterator.endprivate final NodeNodes.NodeIterable.firstprivate NodeNode.firstChildprivate NodeNode.lastChildprivate NodeNode.nextprivate NodeNodes.NodeIterator.nodeprivate NodeNode.parentprivate NodeNode.prevMethods in org.commonmark.node that return NodeModifier and TypeMethodDescriptionNode.getFirstChild()Node.getLastChild()Node.getNext()Node.getParent()Node.getPrevious()Nodes.NodeIterator.next()Methods in org.commonmark.node that return types with arguments of type NodeModifier and TypeMethodDescriptionThe nodes between (not including) start and end.Nodes.NodeIterable.iterator()Methods in org.commonmark.node with parameters of type NodeModifier and TypeMethodDescriptionvoidListItem.appendChild(Node child) Deprecated.voidNode.appendChild(Node child) The nodes between (not including) start and end.voidNode.insertAfter(Node sibling) Inserts thesiblingnode afterthisnode.voidNode.insertBefore(Node sibling) Inserts thesiblingnode beforethisnode.voidNode.prependChild(Node child) protected voidprotected voidprotected voidAbstractVisitor.visitChildren(Node parent) Visit the child nodes.Method parameters in org.commonmark.node with type arguments of type NodeConstructors in org.commonmark.node with parameters of type NodeModifierConstructorDescriptionprivateNodeIterable(Node first, Node end) privateNodeIterator(Node first, Node end) -
Uses of Node in org.commonmark.parser
Methods in org.commonmark.parser that return NodeModifier and TypeMethodDescriptionParse the specified input text into a tree of nodes.Parser.parseReader(Reader input) Parse the specified reader into a tree of nodes.private NodeParser.postProcess(Node document) Methods in org.commonmark.parser with parameters of type NodeModifier and TypeMethodDescriptionvoidInlineParser.parse(SourceLines lines, Node node) private NodeParser.postProcess(Node document) -
Uses of Node in org.commonmark.parser.beta
Methods in org.commonmark.parser.beta with parameters of type NodeModifier and TypeMethodDescriptionstatic ParsedInlinestatic LinkResultLinkResult.replaceWith(Node node, Position position) Replace the link with a node.static LinkResultLinkResult.wrapTextIn(Node node, Position position) Wrap the link text in a node. -
Uses of Node in org.commonmark.renderer
Methods in org.commonmark.renderer that return types with arguments of type NodeMethods in org.commonmark.renderer with parameters of type NodeModifier and TypeMethodDescriptiondefault voidCalled after the root node is rendered, to do any final processing at the end.default voidNodeRenderer.beforeRoot(Node rootNode) Called before the root node is rendered, to do any initial processing at the start.voidRender the specified node.Render the tree of nodes to string.voidRenderer.render(Node node, Appendable output) Render the tree of nodes to output. -
Uses of Node in org.commonmark.renderer.html
Methods in org.commonmark.renderer.html that return types with arguments of type NodeMethods in org.commonmark.renderer.html with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidHtmlRenderer.RendererContext.beforeRoot(Node node) Let extensions modify the HTML tag attributes.HtmlRenderer.RendererContext.extendAttributes(Node node, String tagName, Map<String, String> attributes) voidvoidRender the specified node and its children using the configured renderers.voidHtmlRenderer.render(Node node, Appendable output) voidprivate voidvoidSet the attributes for a HTML tag of the specified node by modifying the provided map.private voidHtmlRenderer.RendererContext.setCustomAttributes(Node node, String tagName, Map<String, String> attrs) protected voidCoreHtmlNodeRenderer.visitChildren(Node parent) -
Uses of Node in org.commonmark.renderer.markdown
Methods in org.commonmark.renderer.markdown that return types with arguments of type NodeMethods in org.commonmark.renderer.markdown with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidRender the specified node and its children using the configured renderers.voidMarkdownRenderer.render(Node node, Appendable output) voidprotected voidCoreMarkdownNodeRenderer.visitChildren(Node parent) private voidCoreMarkdownNodeRenderer.writeLinkLike(String title, String destination, Node node, String opener) -
Uses of Node in org.commonmark.renderer.text
Methods in org.commonmark.renderer.text that return types with arguments of type NodeMethods in org.commonmark.renderer.text with parameters of type NodeModifier and TypeMethodDescriptionvoidvoidRender the specified node and its children using the configured renderers.voidTextContentRenderer.render(Node node, Appendable output) voidprotected voidCoreTextContentNodeRenderer.visitChildren(Node parent) private void
ListBlock.setTight(boolean)instead.