Top Description Inners Fields Constructors Methods
com.vladsch.flexmark.parser

public Class Parser

extends Object
implements IParse
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.IParse
Imports
com.vladsch.flexmark.ast.util.ReferenceRepository, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.block.BlockPreProcessorFactory, .CustomBlockParserFactory, .ParagraphPreProcessorFactory, com.vladsch.flexmark.parser.delimiter.DelimiterProcessor, com.vladsch.flexmark.parser.internal.DocumentParser, .InlineParserImpl, .LinkRefProcessorData, .PostProcessorManager, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.builder.BuilderBase, com.vladsch.flexmark.util.data.*, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.util.sequence.BasedSequence, .ReplacedBasedSequence, com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInHandler, org.jetbrains.annotations.NotNull, .Nullable, java.io.IOException, .Reader, java.util.*

Parses input text to a tree of nodes.

Start with the builder method, configure the parser and build it. Example:

Parser parser = Parser.builder().build();
Node document = parser.parse("input text");

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Parser.Builder

Builder for configuring a Parser.

public static interface
public static interface
Parser.ReferenceHoldingExtension

Should be implemented by all extensions that create a node repository or other references in the document.

Field Summary

Modifier and TypeField and Description
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
private final List<CustomBlockParserFactory>
private final List<List<BlockPreProcessorFactory>>
public static final DataKey<Integer>
public static final DataKey<Boolean>
private final BitSet
private final Map<Character, DelimiterProcessor>
public static final DataKey<Boolean>
public static final DataKey<Collection<Extension>>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Integer>
public static final DataKey<Boolean>
HTML_ALLOW_NAME_SPACE

Name spaces are allowed in HTML elements, default false for backward compatibility

public static final DataKey<Boolean>
public static final DataKey<Boolean>
HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS

Blank line interrupts HTML block when not in raw tag, otherwise only when closed

public static final DataKey<Boolean>
HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS_PARTIAL_TAG

blank line interrupts partially open tag ie.

public static final DataKey<Boolean>
HTML_BLOCK_DEEP_PARSE_FIRST_OPEN_TAG_ON_ONE_LINE

open tags must be contained on one line

public static final DataKey<Boolean>
HTML_BLOCK_DEEP_PARSE_INDENTED_CODE_INTERRUPTS

Indented code can interrupt HTML block

public static final DataKey<Boolean>
HTML_BLOCK_DEEP_PARSE_MARKDOWN_INTERRUPTS_CLOSED

Other markdown elements can interrupt a closed block without an intervening blank line

public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<List<String>>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
private final List<InlineParserExtensionFactory>
private final InlineParserFactory
public static final DataKey<Boolean>
private final LinkRefProcessorData
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Integer>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Integer>
public static final DataKey<Boolean>
public static final DataKey<String[]>
public static final DataKey<String>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Integer>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
private final @NotNull DataHolder
private final List<List<ParagraphPreProcessorFactory>>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<ParserEmulationProfile>
private final List<PostProcessorManager.PostProcessorDependencyStage>
public static final DataKey<Boolean>
public static final DataKey<ReferenceRepository>
public static final DataKey<KeepType>
public static final DataKey<List<SpecialLeadInHandler>>
private final BitSet
public static final DataKey<Boolean>
STRONG_WRAPS_EMPHASIS

STRONG_WRAPS_EMPHASIS default false, when true makes parsing CommonMark Spec 0.27 compliant

public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<Boolean>
public static final DataKey<String>
TRANSLATION_HTML_BLOCK_TAG_PATTERN

Used by formatter for translation parsing

public static final DataKey<String>
public static final DataKey<Boolean>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static MutableDataHolder

Returns:

mutable options
addExtensions
(MutableDataHolder
mutable options holding existing extensions
options
,
Extension...
extension to add
extensions
)

Add extension(s) to the extension list

public static Parser.Builder

Returns:

a builder
builder
()

Create a new builder for configuring a Parser.

public static Parser.Builder
public @NotNull DataHolder
getOptions()

Implements com.vladsch.flexmark.util.ast.IParse.getOptions.

Get Options for parsing

public @NotNull Document

Returns:

the root node
parse
(@NotNull BasedSequence
the text to parse
input
)

Parse the specified input text into a tree of nodes.

public @NotNull Document

Returns:

the root node
parse
(@NotNull String
the text to parse
input
)

Parse the specified input text into a tree of nodes.

public @NotNull Document

Returns:

the root node
parseReader
(@NotNull Reader
the reader to parse
input
)

Parse the specified reader into a tree of nodes.

private Document
public static MutableDataHolder

Returns:

mutable options
removeExtensions
(MutableDataHolder
mutable options holding existing extensions
options
,
Class<T>...
extension classes to remove
extensions
)

Remove extension(s) of given class from the extension list

public boolean
transferReferences(@NotNull Document document, @NotNull Document included, Boolean onlyIfUndefined)

public static <T extends Node> boolean
transferReferences(NodeRepository<T> destination, NodeRepository<T> included, boolean onlyIfUndefined)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait