Modifier and Type	Class and Description
public static class	Parser.Builder Builder for configuring a `Parser`.
public static interface	Parser.ParserExtension Extension for `Parser`.

Access	Constructor and Description
private	Parser(Parser.Builder builder)

Modifier and Type	Method and Description
public static Parser.Builder	Returns: a builder builder() Create a new builder for configuring a `Parser`.
private DocumentParser	createDocumentParser()
public Node	Returns: the root node parse(String the text to parse - must not be null input) Parse the specified input text into a tree of nodes.
public Node	Returns: the root node parseReader(Reader the reader to parse - must not be null input) Parse the specified reader into a tree of nodes.
private Node	postProcess(Node document)

blockParserFactories	back to summary
private final List<BlockParserFactory> blockParserFactories

delimiterProcessors	back to summary
private final List<DelimiterProcessor> delimiterProcessors

includeSourceSpans	back to summary
private final IncludeSourceSpans includeSourceSpans

inlineParserFactory	back to summary
private final InlineParserFactory inlineParserFactory

postProcessors	back to summary
private final List<PostProcessor> postProcessors

Parser	back to summary
private Parser(Parser.Builder builder)

builder	back to summary
public static Parser.Builder builder() Create a new builder for configuring a `Parser`. Returns:Parser.Builder a builder

createDocumentParser	back to summary
private DocumentParser createDocumentParser()

parse	back to summary
public Node parse(String input) Parse the specified input text into a tree of nodes. This method is thread-safe (a new parser state is used for each invocation). Parameters input:String the text to parse - must not be null Returns:Node the root node

parseReader	back to summary
public Node parseReader(Reader input) throws IOException Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader. `Parser parser = Parser.builder().build(); try (InputStreamReader reader = new InputStreamReader(new FileInputStream("file.md"), StandardCharsets.UTF_8)) { Node document = parser.parseReader(reader); // ... }` Note that if you have a file with a byte order mark (BOM), you need to skip it before handing the reader to this library. There's existing classes that do that, e.g. see `BOMInputStream` in Commons IO. This method is thread-safe (a new parser state is used for each invocation). Parameters input:Reader the reader to parse - must not be null Returns:Node the root node Exceptions IOException: when reading throws an exception

postProcess	back to summary
private Node postProcess(Node document)

jdk.internal.org.commonmark.parser back to summary

public Class Parser.Builder

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.commonmark.parser.Parser.Builder

Builder for configuring a Parser.

Field Summary

Modifier and Type	Field and Description
private final List<BlockParserFactory>	blockParserFactories
private final List<DelimiterProcessor>	delimiterProcessors
private Set<Class<? extends Block>>	enabledBlockTypes
private IncludeSourceSpans	includeSourceSpans
private InlineParserFactory	inlineParserFactory
private final List<PostProcessor>	postProcessors

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public Parser	build() Returns: the configured `Parser`
public Parser.Builder	Returns: `this` customBlockParserFactory(BlockParserFactory a block parser factory implementation blockParserFactory) Adds a custom block parser factory.
public Parser.Builder	Returns: `this` customDelimiterProcessor(DelimiterProcessor a delimiter processor implementation delimiterProcessor) Adds a custom delimiter processor.
public Parser.Builder	Returns: `this` enabledBlockTypes(Set<Class<? extends Block>> A list of block nodes the parser will parse. If this list is empty, the parser will not recognize any CommonMark core features. enabledBlockTypes) Describe the list of markdown features the parser will recognize and parse.
public Parser.Builder	extensions(Iterable<? extends Extension> extensions to use on this parser extensions) Returns: `this`
private InlineParserFactory	getInlineParserFactory()
public Parser.Builder	Returns: `this` includeSourceSpans(IncludeSourceSpans which kind of source spans should be included includeSourceSpans) Whether to calculate `org.commonmark.node.SourceSpan` for `Node`.
public Parser.Builder	Returns: `this` inlineParserFactory(InlineParserFactory an inline parser factory implementation inlineParserFactory) Overrides the parser used for inline markdown processing.
public Parser.Builder	postProcessor(PostProcessor postProcessor)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

blockParserFactories	back to summary
private final List<BlockParserFactory> blockParserFactories

delimiterProcessors	back to summary
private final List<DelimiterProcessor> delimiterProcessors

enabledBlockTypes	back to summary
private Set<Class<? extends Block>> enabledBlockTypes

includeSourceSpans	back to summary
private IncludeSourceSpans includeSourceSpans

inlineParserFactory	back to summary
private InlineParserFactory inlineParserFactory

postProcessors	back to summary
private final List<PostProcessor> postProcessors

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public Parser build() Returns:Parser the configured `Parser`

customBlockParserFactory back to summary

customBlockParserFactory	back to summary
public Parser.Builder customBlockParserFactory(BlockParserFactory blockParserFactory) Adds a custom block parser factory. Note that custom factories are applied before the built-in factories. This is so that extensions can change how some syntax is parsed that would otherwise be handled by built-in factories. "With great power comes great responsibility." Parameters blockParserFactory:BlockParserFactory a block parser factory implementation Returns:Parser.Builder `this`

public Parser.Builder customBlockParserFactory(BlockParserFactory blockParserFactory)

Adds a custom block parser factory.

Note that custom factories are applied before the built-in factories. This is so that extensions can change how some syntax is parsed that would otherwise be handled by built-in factories. "With great power comes great responsibility."

Parameters

blockParserFactory:BlockParserFactory: a block parser factory implementation

Returns:Parser.Builder

this

customDelimiterProcessor back to summary

customDelimiterProcessor	back to summary
public Parser.Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor) Adds a custom delimiter processor. Note that multiple delimiter processors with the same characters can be added, as long as they have a different minimum length. In that case, the processor with the shortest matching length is used. Adding more than one delimiter processor with the same character and minimum length is invalid. Parameters delimiterProcessor:DelimiterProcessor a delimiter processor implementation Returns:Parser.Builder `this`

public Parser.Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor)

Adds a custom delimiter processor.

Note that multiple delimiter processors with the same characters can be added, as long as they have a different minimum length. In that case, the processor with the shortest matching length is used. Adding more than one delimiter processor with the same character and minimum length is invalid.

Parameters

delimiterProcessor:DelimiterProcessor: a delimiter processor implementation

Returns:Parser.Builder

this

enabledBlockTypes back to summary

enabledBlockTypes	back to summary
public Parser.Builder enabledBlockTypes(Set<Class<? extends Block>> enabledBlockTypes) Describe the list of markdown features the parser will recognize and parse. By default, CommonMark will recognize and parse the following set of "block" elements: `Heading` (`#`) `HtmlBlock` (`<html></html>`) `ThematicBreak` (Horizontal Rule) (`---`) `FencedCodeBlock` (```) `IndentedCodeBlock` `BlockQuote` (`>`) `ListBlock` (Ordered / Unordered List) (`1. / *`) To parse only a subset of the features listed above, pass a list of each feature's associated `Block` class. E.g., to only parse headings and lists: `Parser.builder().enabledBlockTypes(new HashSet<>(Arrays.asList(Heading.class, ListBlock.class)));` Parameters enabledBlockTypes:Set<Class<? extends Block>> A list of block nodes the parser will parse. If this list is empty, the parser will not recognize any CommonMark core features. Returns:Parser.Builder `this`

public Parser.Builder enabledBlockTypes(Set<Class<? extends Block>> enabledBlockTypes)

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

By default, CommonMark will recognize and parse the following set of "block" elements:

Heading (#)
HtmlBlock (<html></html>)
ThematicBreak (Horizontal Rule) (---)
FencedCodeBlock (```)
IndentedCodeBlock
BlockQuote (>)
ListBlock (Ordered / Unordered List) (1. / *)

To parse only a subset of the features listed above, pass a list of each feature's associated Block class.

E.g., to only parse headings and lists:

    Parser.builder().enabledBlockTypes(new HashSet<>(Arrays.asList(Heading.class, ListBlock.class)));

Parameters

enabledBlockTypes:Set<Class<? extends Block>>: A list of block nodes the parser will parse. If this list is empty, the parser will not recognize any CommonMark core features.

Returns:Parser.Builder

this

extensions	back to summary
public Parser.Builder extensions(Iterable<? extends Extension> extensions) Parameters extensions:Iterable<? extends Extension> extensions to use on this parser Returns:Parser.Builder `this`

getInlineParserFactory	back to summary
private InlineParserFactory getInlineParserFactory()

includeSourceSpans back to summary

includeSourceSpans	back to summary
public Parser.Builder includeSourceSpans(IncludeSourceSpans includeSourceSpans) Whether to calculate `org.commonmark.node.SourceSpan` for `Node`. By default, source spans are disabled. Parameters includeSourceSpans:IncludeSourceSpans which kind of source spans should be included Returns:Parser.Builder `this` Since 0.16.0

public Parser.Builder includeSourceSpans(IncludeSourceSpans includeSourceSpans)

Whether to calculate org.commonmark.node.SourceSpan for Node.

By default, source spans are disabled.

Parameters

includeSourceSpans:IncludeSourceSpans: which kind of source spans should be included

Returns:Parser.Builder

this

Since

0.16.0

inlineParserFactory back to summary

inlineParserFactory	back to summary
public Parser.Builder inlineParserFactory(InlineParserFactory inlineParserFactory) Overrides the parser used for inline markdown processing. Provide an implementation of InlineParserFactory which provides a custom inline parser to modify how the following are parsed: bold (*) italic () strikethrough (~~) backtick quote (`) link ([title](http://)) image (![alt](http://)) Note that if this method is not called or the inline parser factory is set to null, then the default implementation will be used. Parameters inlineParserFactory:InlineParserFactory an inline parser factory implementation Returns:Parser.Builder `this`

public Parser.Builder inlineParserFactory(InlineParserFactory inlineParserFactory)

Overrides the parser used for inline markdown processing.

Provide an implementation of InlineParserFactory which provides a custom inline parser to modify how the following are parsed: bold (**) italic (*) strikethrough (~~) backtick quote (`) link ([title](http://)) image (![alt](http://))

Note that if this method is not called or the inline parser factory is set to null, then the default implementation will be used.

Parameters

inlineParserFactory:InlineParserFactory: an inline parser factory implementation

Returns:Parser.Builder

this

postProcessor	back to summary
public Parser.Builder postProcessor(PostProcessor postProcessor)

public Class Parser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Parser.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Parser.ParserExtension

Method Summary

Method Detail