A B C D E F G H I L M N O P R S T U V W

A

AbstractBlockParser - Class in org.commonmark.parser.block

AbstractBlockParser() - Constructor for class org.commonmark.parser.block.AbstractBlockParser

AbstractBlockParserFactory - Class in org.commonmark.parser.block

AbstractBlockParserFactory() - Constructor for class org.commonmark.parser.block.AbstractBlockParserFactory

AbstractVisitor - Class in org.commonmark.node

Abstract visitor that visits all children by default.

AbstractVisitor() - Constructor for class org.commonmark.node.AbstractVisitor

accept(Visitor) - Method in class org.commonmark.node.BlockQuote

accept(Visitor) - Method in class org.commonmark.node.BulletList

accept(Visitor) - Method in class org.commonmark.node.Code

accept(Visitor) - Method in class org.commonmark.node.CustomBlock

accept(Visitor) - Method in class org.commonmark.node.CustomNode

accept(Visitor) - Method in class org.commonmark.node.Document

accept(Visitor) - Method in class org.commonmark.node.Emphasis

accept(Visitor) - Method in class org.commonmark.node.FencedCodeBlock

accept(Visitor) - Method in class org.commonmark.node.HardLineBreak

accept(Visitor) - Method in class org.commonmark.node.Heading

accept(Visitor) - Method in class org.commonmark.node.HtmlBlock

accept(Visitor) - Method in class org.commonmark.node.HtmlInline

accept(Visitor) - Method in class org.commonmark.node.Image

accept(Visitor) - Method in class org.commonmark.node.IndentedCodeBlock

accept(Visitor) - Method in class org.commonmark.node.Link

accept(Visitor) - Method in class org.commonmark.node.LinkReferenceDefinition

accept(Visitor) - Method in class org.commonmark.node.ListItem

accept(Visitor) - Method in class org.commonmark.node.Node

accept(Visitor) - Method in class org.commonmark.node.OrderedList

accept(Visitor) - Method in class org.commonmark.node.Paragraph

accept(Visitor) - Method in class org.commonmark.node.SoftLineBreak

accept(Visitor) - Method in class org.commonmark.node.StrongEmphasis

accept(Visitor) - Method in class org.commonmark.node.Text

accept(Visitor) - Method in class org.commonmark.node.ThematicBreak

addAll(List<SourceSpan>) - Method in class org.commonmark.node.SourceSpans

addAllFrom(Iterable<? extends Node>) - Method in class org.commonmark.node.SourceSpans

addLine(SourceLine) - Method in class org.commonmark.parser.block.AbstractBlockParser

addLine(SourceLine) - Method in interface org.commonmark.parser.block.BlockParser

addLine(SourceLine) - Method in class org.commonmark.parser.SourceLines

addSourceSpan(SourceSpan) - Method in class org.commonmark.node.Node

Add a source span to the end of the list.

addSourceSpan(SourceSpan) - Method in class org.commonmark.parser.block.AbstractBlockParser

addSourceSpan(SourceSpan) - Method in interface org.commonmark.parser.block.BlockParser

Add a source span of the currently parsed block.

append(String) - Method in class org.commonmark.renderer.html.HtmlWriter

appendChild(Node) - Method in class org.commonmark.node.Node

atColumn(int) - Static method in class org.commonmark.parser.block.BlockContinue

atColumn(int) - Method in class org.commonmark.parser.block.BlockStart

atIndex(int) - Static method in class org.commonmark.parser.block.BlockContinue

atIndex(int) - Method in class org.commonmark.parser.block.BlockStart

AttributeProvider - Interface in org.commonmark.renderer.html

Extension point for adding/changing attributes on HTML tags for a node.

AttributeProviderContext - Interface in org.commonmark.renderer.html

The context for attribute providers.

AttributeProviderFactory - Interface in org.commonmark.renderer.html

Factory for instantiating new attribute providers when rendering is done.

attributeProviderFactory(AttributeProviderFactory) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

B

between(Node, Node) - Static method in class org.commonmark.node.Nodes

The nodes between (not including) start and end.

Block - Class in org.commonmark.node

Block nodes such as paragraphs, list blocks, code blocks etc.

Block() - Constructor for class org.commonmark.node.Block

BlockContinue - Class in org.commonmark.parser.block

Result object for continuing parsing of a block, see static methods for constructors.

BlockContinue() - Constructor for class org.commonmark.parser.block.BlockContinue

BlockParser - Interface in org.commonmark.parser.block

Parser for a specific block node.

BlockParserFactory - Interface in org.commonmark.parser.block

Parser factory for a block node for determining when a block starts.

BlockQuote - Class in org.commonmark.node

BlockQuote() - Constructor for class org.commonmark.node.BlockQuote

BlockStart - Class in org.commonmark.parser.block

Result object for starting parsing of a block, see static methods for constructors.

BlockStart() - Constructor for class org.commonmark.parser.block.BlockStart

build() - Method in class org.commonmark.parser.Parser.Builder

build() - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

build() - Method in class org.commonmark.renderer.text.TextContentRenderer.Builder

builder() - Static method in class org.commonmark.parser.Parser

Create a new builder for configuring a Parser.

Builder() - Constructor for class org.commonmark.parser.Parser.Builder

builder() - Static method in class org.commonmark.renderer.html.HtmlRenderer

Create a new builder for configuring an HtmlRenderer.

Builder() - Constructor for class org.commonmark.renderer.html.HtmlRenderer.Builder

builder() - Static method in class org.commonmark.renderer.text.TextContentRenderer

Create a new builder for configuring an TextContentRenderer.

Builder() - Constructor for class org.commonmark.renderer.text.TextContentRenderer.Builder

BulletList - Class in org.commonmark.node

BulletList() - Constructor for class org.commonmark.node.BulletList

C

canClose() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

canContain(Block) - Method in class org.commonmark.parser.block.AbstractBlockParser

canContain(Block) - Method in interface org.commonmark.parser.block.BlockParser

canHaveLazyContinuationLines() - Method in class org.commonmark.parser.block.AbstractBlockParser

canHaveLazyContinuationLines() - Method in interface org.commonmark.parser.block.BlockParser

Return true if the block can have lazy continuation lines.

canOpen() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

closeBlock() - Method in class org.commonmark.parser.block.AbstractBlockParser

closeBlock() - Method in interface org.commonmark.parser.block.BlockParser

Code - Class in org.commonmark.node

Code() - Constructor for class org.commonmark.node.Code

Code(String) - Constructor for class org.commonmark.node.Code

colon() - Method in class org.commonmark.renderer.text.TextContentWriter

context - Variable in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

context - Variable in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

CoreHtmlNodeRenderer - Class in org.commonmark.renderer.html

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

CoreHtmlNodeRenderer(HtmlNodeRendererContext) - Constructor for class org.commonmark.renderer.html.CoreHtmlNodeRenderer

CoreTextContentNodeRenderer - Class in org.commonmark.renderer.text

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

CoreTextContentNodeRenderer(TextContentNodeRendererContext) - Constructor for class org.commonmark.renderer.text.CoreTextContentNodeRenderer

create(InlineParserContext) - Method in interface org.commonmark.parser.InlineParserFactory

create(AttributeProviderContext) - Method in interface org.commonmark.renderer.html.AttributeProviderFactory

Create a new attribute provider.

create(HtmlNodeRendererContext) - Method in interface org.commonmark.renderer.html.HtmlNodeRendererFactory

Create a new node renderer for the specified rendering context.

create(TextContentNodeRendererContext) - Method in interface org.commonmark.renderer.text.TextContentNodeRendererFactory

Create a new node renderer for the specified rendering context.

CustomBlock - Class in org.commonmark.node

CustomBlock() - Constructor for class org.commonmark.node.CustomBlock

customBlockParserFactory(BlockParserFactory) - Method in class org.commonmark.parser.Parser.Builder

Adds a custom block parser factory.

customDelimiterProcessor(DelimiterProcessor) - Method in class org.commonmark.parser.Parser.Builder

Adds a custom delimiter processor.

CustomNode - Class in org.commonmark.node

CustomNode() - Constructor for class org.commonmark.node.CustomNode

D

DefaultUrlSanitizer - Class in org.commonmark.renderer.html

Allows http, https and mailto protocols for url.

DefaultUrlSanitizer() - Constructor for class org.commonmark.renderer.html.DefaultUrlSanitizer

DefaultUrlSanitizer(Collection<String>) - Constructor for class org.commonmark.renderer.html.DefaultUrlSanitizer

Delimited - Interface in org.commonmark.node

A node that uses delimiters in the source form (e.g.

DelimiterProcessor - Interface in org.commonmark.parser.delimiter

Custom delimiter processor for additional delimiters besides _ and *.

DelimiterRun - Interface in org.commonmark.parser.delimiter

A delimiter run is one or more of the same delimiter character, e.g.

Document - Class in org.commonmark.node

Document() - Constructor for class org.commonmark.node.Document

E

Emphasis - Class in org.commonmark.node

Emphasis() - Constructor for class org.commonmark.node.Emphasis

Emphasis(String) - Constructor for class org.commonmark.node.Emphasis

empty() - Static method in class org.commonmark.node.SourceSpans

empty() - Static method in class org.commonmark.parser.SourceLines

enabledBlockTypes(Set<Class<? extends Block>>) - Method in class org.commonmark.parser.Parser.Builder

Describe the list of markdown features the parser will recognize and parse.

encodeUrl(String) - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

equals(Object) - Method in class org.commonmark.node.SourceSpan

escapeHtml(boolean) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

extend(Parser.Builder) - Method in interface org.commonmark.parser.Parser.ParserExtension

extend(HtmlRenderer.Builder) - Method in interface org.commonmark.renderer.html.HtmlRenderer.HtmlRendererExtension

extend(TextContentRenderer.Builder) - Method in interface org.commonmark.renderer.text.TextContentRenderer.TextContentRendererExtension

extendAttributes(Node, String, Map<String, String>) - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

Let extensions modify the HTML tag attributes.

Extension - Interface in org.commonmark

Base interface for a parser/renderer extension.

extensions(Iterable<? extends Extension>) - Method in class org.commonmark.parser.Parser.Builder

extensions(Iterable<? extends Extension>) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

extensions(Iterable<? extends Extension>) - Method in class org.commonmark.renderer.text.TextContentRenderer.Builder

F

FencedCodeBlock - Class in org.commonmark.node

FencedCodeBlock() - Constructor for class org.commonmark.node.FencedCodeBlock

finished() - Static method in class org.commonmark.parser.block.BlockContinue

G

getActiveBlockParser() - Method in interface org.commonmark.parser.block.ParserState

getBlock() - Method in interface org.commonmark.parser.block.BlockParser

getBulletMarker() - Method in class org.commonmark.node.BulletList

getCloser() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

getClosers(int) - Method in interface org.commonmark.parser.delimiter.DelimiterRun

Get the closing delimiter nodes for the specified length of delimiters.

getClosingCharacter() - Method in interface org.commonmark.parser.delimiter.DelimiterProcessor

getClosingDelimiter() - Method in interface org.commonmark.node.Delimited

getClosingDelimiter() - Method in class org.commonmark.node.Emphasis

getClosingDelimiter() - Method in class org.commonmark.node.StrongEmphasis

getColumn() - Method in interface org.commonmark.parser.block.ParserState

The column is the position within the line after tab characters have been processed as 4-space tab stops.

getColumnIndex() - Method in class org.commonmark.node.SourceSpan

getContent() - Method in class org.commonmark.parser.SourceLine

getContent() - Method in class org.commonmark.parser.SourceLines

getCustomDelimiterProcessors() - Method in interface org.commonmark.parser.InlineParserContext

getDelimiter() - Method in class org.commonmark.node.OrderedList

getDestination() - Method in class org.commonmark.node.Image

getDestination() - Method in class org.commonmark.node.Link

getDestination() - Method in class org.commonmark.node.LinkReferenceDefinition

getFenceChar() - Method in class org.commonmark.node.FencedCodeBlock

getFenceIndent() - Method in class org.commonmark.node.FencedCodeBlock

getFenceLength() - Method in class org.commonmark.node.FencedCodeBlock

getFirstChild() - Method in class org.commonmark.node.Node

getIndent() - Method in interface org.commonmark.parser.block.ParserState

getIndex() - Method in interface org.commonmark.parser.block.ParserState

getInfo() - Method in class org.commonmark.node.FencedCodeBlock

getLabel() - Method in class org.commonmark.node.LinkReferenceDefinition

getLastChild() - Method in class org.commonmark.node.Node

getLength() - Method in class org.commonmark.node.SourceSpan

getLevel() - Method in class org.commonmark.node.Heading

getLine() - Method in interface org.commonmark.parser.block.ParserState

getLineIndex() - Method in class org.commonmark.node.SourceSpan

getLines() - Method in class org.commonmark.parser.SourceLines

getLinkReferenceDefinition(String) - Method in interface org.commonmark.parser.InlineParserContext

Look up a LinkReferenceDefinition for a given label.

getLiteral() - Method in class org.commonmark.node.Code

getLiteral() - Method in class org.commonmark.node.FencedCodeBlock

getLiteral() - Method in class org.commonmark.node.HtmlBlock

getLiteral() - Method in class org.commonmark.node.HtmlInline

getLiteral() - Method in class org.commonmark.node.IndentedCodeBlock

getLiteral() - Method in class org.commonmark.node.Text

getMatchedBlockParser() - Method in interface org.commonmark.parser.block.MatchedBlockParser

getMinLength() - Method in interface org.commonmark.parser.delimiter.DelimiterProcessor

Minimum number of delimiter characters that are needed to activate this.

getNext() - Method in class org.commonmark.node.Node

getNextNonSpaceIndex() - Method in interface org.commonmark.parser.block.ParserState

getNodeTypes() - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

getNodeTypes() - Method in interface org.commonmark.renderer.NodeRenderer

getNodeTypes() - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

getOpener() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

getOpeners(int) - Method in interface org.commonmark.parser.delimiter.DelimiterRun

Get the opening delimiter nodes for the specified length of delimiters.

getOpeningCharacter() - Method in interface org.commonmark.parser.delimiter.DelimiterProcessor

getOpeningDelimiter() - Method in interface org.commonmark.node.Delimited

getOpeningDelimiter() - Method in class org.commonmark.node.Emphasis

getOpeningDelimiter() - Method in class org.commonmark.node.StrongEmphasis

getParagraphLines() - Method in interface org.commonmark.parser.block.MatchedBlockParser

Returns the current paragraph lines if the matched block is a paragraph.

getParent() - Method in class org.commonmark.node.Block

getParent() - Method in class org.commonmark.node.Node

getPrevious() - Method in class org.commonmark.node.Node

getSoftbreak() - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

getSourceSpan() - Method in class org.commonmark.parser.SourceLine

getSourceSpans() - Method in class org.commonmark.node.Node

getSourceSpans() - Method in class org.commonmark.node.SourceSpans

getSourceSpans() - Method in class org.commonmark.parser.SourceLines

getStartNumber() - Method in class org.commonmark.node.OrderedList

getTitle() - Method in class org.commonmark.node.Image

getTitle() - Method in class org.commonmark.node.Link

getTitle() - Method in class org.commonmark.node.LinkReferenceDefinition

getWriter() - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

getWriter() - Method in interface org.commonmark.renderer.text.TextContentNodeRendererContext

H

HardLineBreak - Class in org.commonmark.node

HardLineBreak() - Constructor for class org.commonmark.node.HardLineBreak

hashCode() - Method in class org.commonmark.node.SourceSpan

Heading - Class in org.commonmark.node

Heading() - Constructor for class org.commonmark.node.Heading

HtmlBlock - Class in org.commonmark.node

HTML block

HtmlBlock() - Constructor for class org.commonmark.node.HtmlBlock

HtmlInline - Class in org.commonmark.node

Inline HTML element.

HtmlInline() - Constructor for class org.commonmark.node.HtmlInline

HtmlNodeRendererContext - Interface in org.commonmark.renderer.html

HtmlNodeRendererFactory - Interface in org.commonmark.renderer.html

Factory for instantiating new node renderers when rendering is done.

HtmlRenderer - Class in org.commonmark.renderer.html

Renders a tree of nodes to HTML.

HtmlRenderer.Builder - Class in org.commonmark.renderer.html

Builder for configuring an HtmlRenderer.

HtmlRenderer.HtmlRendererExtension - Interface in org.commonmark.renderer.html

Extension for HtmlRenderer.

HtmlWriter - Class in org.commonmark.renderer.html

HtmlWriter(Appendable) - Constructor for class org.commonmark.renderer.html.HtmlWriter

I

Image - Class in org.commonmark.node

Image() - Constructor for class org.commonmark.node.Image

Image(String, String) - Constructor for class org.commonmark.node.Image

IncludeSourceSpans - Enum in org.commonmark.parser

Whether to include SourceSpan or not while parsing, see Parser.Builder.includeSourceSpans(IncludeSourceSpans).

includeSourceSpans(IncludeSourceSpans) - Method in class org.commonmark.parser.Parser.Builder

Whether to calculate SourceSpan for Node.

IndentedCodeBlock - Class in org.commonmark.node

IndentedCodeBlock() - Constructor for class org.commonmark.node.IndentedCodeBlock

InlineParser - Interface in org.commonmark.parser

Parser for inline content (text, links, emphasized text, etc).

InlineParserContext - Interface in org.commonmark.parser

Context for inline parsing.

InlineParserFactory - Interface in org.commonmark.parser

Factory for custom inline parser.

inlineParserFactory(InlineParserFactory) - Method in class org.commonmark.parser.Parser.Builder

Overrides the parser used for inline markdown processing.

insertAfter(Node) - Method in class org.commonmark.node.Node

insertBefore(Node) - Method in class org.commonmark.node.Node

isBlank() - Method in interface org.commonmark.parser.block.ParserState

isContainer() - Method in class org.commonmark.parser.block.AbstractBlockParser

isContainer() - Method in interface org.commonmark.parser.block.BlockParser

Return true if the block that is parsed is a container (contains other blocks), or false if it's a leaf.

isEmpty() - Method in class org.commonmark.parser.SourceLines

isTight() - Method in class org.commonmark.node.ListBlock

L

length() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

line() - Method in class org.commonmark.renderer.html.HtmlWriter

line() - Method in class org.commonmark.renderer.text.TextContentWriter

Link - Class in org.commonmark.node

A link with a destination and an optional title; the link text is in child nodes.

Link() - Constructor for class org.commonmark.node.Link

Link(String, String) - Constructor for class org.commonmark.node.Link

LinkReferenceDefinition - Class in org.commonmark.node

A link reference definition, e.g.:

LinkReferenceDefinition() - Constructor for class org.commonmark.node.LinkReferenceDefinition

LinkReferenceDefinition(String, String, String) - Constructor for class org.commonmark.node.LinkReferenceDefinition

ListBlock - Class in org.commonmark.node

ListBlock() - Constructor for class org.commonmark.node.ListBlock

ListItem - Class in org.commonmark.node

ListItem() - Constructor for class org.commonmark.node.ListItem

M

MatchedBlockParser - Interface in org.commonmark.parser.block

Open block parser that was last matched during the continue phase.

N

Node - Class in org.commonmark.node

The base class of all CommonMark AST nodes (Block and inlines).

Node() - Constructor for class org.commonmark.node.Node

NodeRenderer - Interface in org.commonmark.renderer

A renderer for a set of node types.

nodeRendererFactory(HtmlNodeRendererFactory) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

Add a factory for instantiating a node renderer (done when rendering).

nodeRendererFactory(TextContentNodeRendererFactory) - Method in class org.commonmark.renderer.text.TextContentRenderer.Builder

Add a factory for instantiating a node renderer (done when rendering).

Nodes - Class in org.commonmark.node

Utility class for working with multiple Nodes.

none() - Static method in class org.commonmark.parser.block.BlockContinue

none() - Static method in class org.commonmark.parser.block.BlockStart

O

of(int, int, int) - Static method in class org.commonmark.node.SourceSpan

of(BlockParser...) - Static method in class org.commonmark.parser.block.BlockStart

of(CharSequence, SourceSpan) - Static method in class org.commonmark.parser.SourceLine

of(SourceLine) - Static method in class org.commonmark.parser.SourceLines

of(List<SourceLine>) - Static method in class org.commonmark.parser.SourceLines

OrderedList - Class in org.commonmark.node

OrderedList() - Constructor for class org.commonmark.node.OrderedList

org.commonmark - package org.commonmark

Root package of commonmark-java org.commonmark.parser for parsing input text to AST nodes org.commonmark.node for AST node types and visitors org.commonmark.renderer.html for HTML rendering

org.commonmark.node - package org.commonmark.node

AST node types (see Node) and visitors (see AbstractVisitor)

org.commonmark.parser - package org.commonmark.parser

Parsing input text to AST nodes (see Parser)

org.commonmark.parser.block - package org.commonmark.parser.block

Types for extending block parsing

org.commonmark.parser.delimiter - package org.commonmark.parser.delimiter

org.commonmark.renderer - package org.commonmark.renderer

org.commonmark.renderer.html - package org.commonmark.renderer.html

HTML rendering (see HtmlRenderer)

org.commonmark.renderer.text - package org.commonmark.renderer.text

Text content rendering (see TextContentRenderer)

originalLength() - Method in interface org.commonmark.parser.delimiter.DelimiterRun

P

Paragraph - Class in org.commonmark.node

A paragraph block, contains inline nodes such as Text

Paragraph() - Constructor for class org.commonmark.node.Paragraph

parse(SourceLines, Node) - Method in interface org.commonmark.parser.InlineParser

parse(String) - Method in class org.commonmark.parser.Parser

Parse the specified input text into a tree of nodes.

parseInlines(InlineParser) - Method in class org.commonmark.parser.block.AbstractBlockParser

parseInlines(InlineParser) - Method in interface org.commonmark.parser.block.BlockParser

Parser - Class in org.commonmark.parser

Parses input text to a tree of nodes.

Parser.Builder - Class in org.commonmark.parser

Builder for configuring a Parser.

Parser.ParserExtension - Interface in org.commonmark.parser

Extension for Parser.

parseReader(Reader) - Method in class org.commonmark.parser.Parser

Parse the specified reader into a tree of nodes.

ParserState - Interface in org.commonmark.parser.block

State of the parser that is used in block parsers.

percentEncodeUrls(boolean) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

postProcessor(PostProcessor) - Method in class org.commonmark.parser.Parser.Builder

PostProcessor - Interface in org.commonmark.parser

prependChild(Node) - Method in class org.commonmark.node.Node

process(DelimiterRun, DelimiterRun) - Method in interface org.commonmark.parser.delimiter.DelimiterProcessor

Process the delimiter runs.

process(Node) - Method in interface org.commonmark.parser.PostProcessor

R

raw(String) - Method in class org.commonmark.renderer.html.HtmlWriter

render(Node) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

render(Node) - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

Render the specified node and its children using the configured renderers.

render(Node, Appendable) - Method in class org.commonmark.renderer.html.HtmlRenderer

render(Node) - Method in class org.commonmark.renderer.html.HtmlRenderer

render(Node) - Method in interface org.commonmark.renderer.NodeRenderer

Render the specified node.

render(Node, Appendable) - Method in interface org.commonmark.renderer.Renderer

Render the tree of nodes to output.

render(Node) - Method in interface org.commonmark.renderer.Renderer

Render the tree of nodes to string.

render(Node) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

render(Node) - Method in interface org.commonmark.renderer.text.TextContentNodeRendererContext

Render the specified node and its children using the configured renderers.

render(Node, Appendable) - Method in class org.commonmark.renderer.text.TextContentRenderer

render(Node) - Method in class org.commonmark.renderer.text.TextContentRenderer

Renderer - Interface in org.commonmark.renderer

replaceActiveBlockParser() - Method in class org.commonmark.parser.block.BlockStart

S

sanitizeImageUrl(String) - Method in class org.commonmark.renderer.html.DefaultUrlSanitizer

sanitizeImageUrl(String) - Method in interface org.commonmark.renderer.html.UrlSanitizer

Sanitize a url for use in the src attribute of a Image.

sanitizeLinkUrl(String) - Method in class org.commonmark.renderer.html.DefaultUrlSanitizer

sanitizeLinkUrl(String) - Method in interface org.commonmark.renderer.html.UrlSanitizer

Sanitize a url for use in the href attribute of a Link.

sanitizeUrls(boolean) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

setAttributes(Node, String, Map<String, String>) - Method in interface org.commonmark.renderer.html.AttributeProvider

Set the attributes for a HTML tag of the specified node by modifying the provided map.

setBulletMarker(char) - Method in class org.commonmark.node.BulletList

setDelimiter(String) - Method in class org.commonmark.node.Emphasis

setDelimiter(char) - Method in class org.commonmark.node.OrderedList

setDelimiter(String) - Method in class org.commonmark.node.StrongEmphasis

setDestination(String) - Method in class org.commonmark.node.Image

setDestination(String) - Method in class org.commonmark.node.Link

setDestination(String) - Method in class org.commonmark.node.LinkReferenceDefinition

setFenceChar(char) - Method in class org.commonmark.node.FencedCodeBlock

setFenceIndent(int) - Method in class org.commonmark.node.FencedCodeBlock

setFenceLength(int) - Method in class org.commonmark.node.FencedCodeBlock

setInfo(String) - Method in class org.commonmark.node.FencedCodeBlock

setLabel(String) - Method in class org.commonmark.node.LinkReferenceDefinition

setLevel(int) - Method in class org.commonmark.node.Heading

setLiteral(String) - Method in class org.commonmark.node.Code

setLiteral(String) - Method in class org.commonmark.node.FencedCodeBlock

setLiteral(String) - Method in class org.commonmark.node.HtmlBlock

setLiteral(String) - Method in class org.commonmark.node.HtmlInline

setLiteral(String) - Method in class org.commonmark.node.IndentedCodeBlock

setLiteral(String) - Method in class org.commonmark.node.Text

setParent(Node) - Method in class org.commonmark.node.Block

setParent(Node) - Method in class org.commonmark.node.Node

setSourceSpans(List<SourceSpan>) - Method in class org.commonmark.node.Node

Replace the current source spans with the provided list.

setStartNumber(int) - Method in class org.commonmark.node.OrderedList

setTight(boolean) - Method in class org.commonmark.node.ListBlock

setTitle(String) - Method in class org.commonmark.node.Image

setTitle(String) - Method in class org.commonmark.node.Link

setTitle(String) - Method in class org.commonmark.node.LinkReferenceDefinition

shouldEscapeHtml() - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

shouldSanitizeUrls() - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

softbreak(String) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

SoftLineBreak - Class in org.commonmark.node

SoftLineBreak() - Constructor for class org.commonmark.node.SoftLineBreak

SourceLine - Class in org.commonmark.parser

A line or part of a line from the input source.

SourceLines - Class in org.commonmark.parser

A set of lines (SourceLine) from the input source.

SourceLines() - Constructor for class org.commonmark.parser.SourceLines

SourceSpan - Class in org.commonmark.node

A source span references a snippet of text from the source input.

SourceSpans - Class in org.commonmark.node

A list of source spans that can be added to.

SourceSpans() - Constructor for class org.commonmark.node.SourceSpans

stripNewlines() - Method in interface org.commonmark.renderer.text.TextContentNodeRendererContext

stripNewlines(boolean) - Method in class org.commonmark.renderer.text.TextContentRenderer.Builder

Set the value of flag for stripping new lines.

StrongEmphasis - Class in org.commonmark.node

StrongEmphasis() - Constructor for class org.commonmark.node.StrongEmphasis

StrongEmphasis(String) - Constructor for class org.commonmark.node.StrongEmphasis

substring(int, int) - Method in class org.commonmark.parser.SourceLine

T

tag(String) - Method in class org.commonmark.renderer.html.HtmlWriter

tag(String, Map<String, String>) - Method in class org.commonmark.renderer.html.HtmlWriter

tag(String, Map<String, String>, boolean) - Method in class org.commonmark.renderer.html.HtmlWriter

Text - Class in org.commonmark.node

Text() - Constructor for class org.commonmark.node.Text

Text(String) - Constructor for class org.commonmark.node.Text

text(String) - Method in class org.commonmark.renderer.html.HtmlWriter

TextContentNodeRendererContext - Interface in org.commonmark.renderer.text

TextContentNodeRendererFactory - Interface in org.commonmark.renderer.text

Factory for instantiating new node renderers when rendering is done.

TextContentRenderer - Class in org.commonmark.renderer.text

TextContentRenderer.Builder - Class in org.commonmark.renderer.text

Builder for configuring an TextContentRenderer.

TextContentRenderer.TextContentRendererExtension - Interface in org.commonmark.renderer.text

Extension for TextContentRenderer.

TextContentWriter - Class in org.commonmark.renderer.text

TextContentWriter(Appendable) - Constructor for class org.commonmark.renderer.text.TextContentWriter

ThematicBreak - Class in org.commonmark.node

ThematicBreak() - Constructor for class org.commonmark.node.ThematicBreak

toString() - Method in class org.commonmark.node.Node

toString() - Method in class org.commonmark.node.SourceSpan

toStringAttributes() - Method in class org.commonmark.node.Image

toStringAttributes() - Method in class org.commonmark.node.Link

toStringAttributes() - Method in class org.commonmark.node.Node

toStringAttributes() - Method in class org.commonmark.node.Text

tryContinue(ParserState) - Method in interface org.commonmark.parser.block.BlockParser

tryStart(ParserState, MatchedBlockParser) - Method in interface org.commonmark.parser.block.BlockParserFactory

U

unlink() - Method in class org.commonmark.node.Node

urlSanitizer() - Method in interface org.commonmark.renderer.html.HtmlNodeRendererContext

urlSanitizer(UrlSanitizer) - Method in class org.commonmark.renderer.html.HtmlRenderer.Builder

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

UrlSanitizer - Interface in org.commonmark.renderer.html

Sanitizes urls for img and a elements by whitelisting protocols.

V

valueOf(String) - Static method in enum org.commonmark.parser.IncludeSourceSpans

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.commonmark.parser.IncludeSourceSpans

Returns an array containing the constants of this enum type, in the order they are declared.

visit(BlockQuote) - Method in class org.commonmark.node.AbstractVisitor

visit(BulletList) - Method in class org.commonmark.node.AbstractVisitor

visit(Code) - Method in class org.commonmark.node.AbstractVisitor

visit(Document) - Method in class org.commonmark.node.AbstractVisitor

visit(Emphasis) - Method in class org.commonmark.node.AbstractVisitor

visit(FencedCodeBlock) - Method in class org.commonmark.node.AbstractVisitor

visit(HardLineBreak) - Method in class org.commonmark.node.AbstractVisitor

visit(Heading) - Method in class org.commonmark.node.AbstractVisitor

visit(ThematicBreak) - Method in class org.commonmark.node.AbstractVisitor

visit(HtmlInline) - Method in class org.commonmark.node.AbstractVisitor

visit(HtmlBlock) - Method in class org.commonmark.node.AbstractVisitor

visit(Image) - Method in class org.commonmark.node.AbstractVisitor

visit(IndentedCodeBlock) - Method in class org.commonmark.node.AbstractVisitor

visit(Link) - Method in class org.commonmark.node.AbstractVisitor

visit(ListItem) - Method in class org.commonmark.node.AbstractVisitor

visit(OrderedList) - Method in class org.commonmark.node.AbstractVisitor

visit(Paragraph) - Method in class org.commonmark.node.AbstractVisitor

visit(SoftLineBreak) - Method in class org.commonmark.node.AbstractVisitor

visit(StrongEmphasis) - Method in class org.commonmark.node.AbstractVisitor

visit(Text) - Method in class org.commonmark.node.AbstractVisitor

visit(LinkReferenceDefinition) - Method in class org.commonmark.node.AbstractVisitor

visit(CustomBlock) - Method in class org.commonmark.node.AbstractVisitor

visit(CustomNode) - Method in class org.commonmark.node.AbstractVisitor

visit(BlockQuote) - Method in interface org.commonmark.node.Visitor

visit(BulletList) - Method in interface org.commonmark.node.Visitor

visit(Code) - Method in interface org.commonmark.node.Visitor

visit(Document) - Method in interface org.commonmark.node.Visitor

visit(Emphasis) - Method in interface org.commonmark.node.Visitor

visit(FencedCodeBlock) - Method in interface org.commonmark.node.Visitor

visit(HardLineBreak) - Method in interface org.commonmark.node.Visitor

visit(Heading) - Method in interface org.commonmark.node.Visitor

visit(ThematicBreak) - Method in interface org.commonmark.node.Visitor

visit(HtmlInline) - Method in interface org.commonmark.node.Visitor

visit(HtmlBlock) - Method in interface org.commonmark.node.Visitor

visit(Image) - Method in interface org.commonmark.node.Visitor

visit(IndentedCodeBlock) - Method in interface org.commonmark.node.Visitor

visit(Link) - Method in interface org.commonmark.node.Visitor

visit(ListItem) - Method in interface org.commonmark.node.Visitor

visit(OrderedList) - Method in interface org.commonmark.node.Visitor

visit(Paragraph) - Method in interface org.commonmark.node.Visitor

visit(SoftLineBreak) - Method in interface org.commonmark.node.Visitor

visit(StrongEmphasis) - Method in interface org.commonmark.node.Visitor

visit(Text) - Method in interface org.commonmark.node.Visitor

visit(LinkReferenceDefinition) - Method in interface org.commonmark.node.Visitor

visit(CustomBlock) - Method in interface org.commonmark.node.Visitor

visit(CustomNode) - Method in interface org.commonmark.node.Visitor

visit(Document) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Heading) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Paragraph) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(BlockQuote) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(BulletList) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(FencedCodeBlock) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(HtmlBlock) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(ThematicBreak) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(IndentedCodeBlock) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Link) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(ListItem) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(OrderedList) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Image) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Emphasis) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(StrongEmphasis) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Text) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Code) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(HtmlInline) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(SoftLineBreak) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(HardLineBreak) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visit(Document) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(BlockQuote) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(BulletList) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Code) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(FencedCodeBlock) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(HardLineBreak) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Heading) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(ThematicBreak) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(HtmlInline) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(HtmlBlock) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Image) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(IndentedCodeBlock) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Link) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(ListItem) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(OrderedList) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Paragraph) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(SoftLineBreak) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visit(Text) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

visitChildren(Node) - Method in class org.commonmark.node.AbstractVisitor

Visit the child nodes.

visitChildren(Node) - Method in class org.commonmark.renderer.html.CoreHtmlNodeRenderer

visitChildren(Node) - Method in class org.commonmark.renderer.text.CoreTextContentNodeRenderer

Visitor - Interface in org.commonmark.node

Node visitor.

W

whitespace() - Method in class org.commonmark.renderer.text.TextContentWriter

write(String) - Method in class org.commonmark.renderer.text.TextContentWriter

write(char) - Method in class org.commonmark.renderer.text.TextContentWriter

writeStripped(String) - Method in class org.commonmark.renderer.text.TextContentWriter

A B C D E F G H I L M N O P R S T U V W