com.vladsch.flexmark.parser

Class Parser

java.lang.Object

com.vladsch.flexmark.parser.Parser

All Implemented Interfaces:

com.vladsch.flexmark.IParse

public class Parser
extends Object
implements com.vladsch.flexmark.IParse

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 Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parser.Builder Builder for configuring a Parser.
static interface	Parser.ParserExtension Extension for Parser.
static interface	Parser.ReferenceHoldingExtension Should be implemented by all extensions that create a node repository or other references in the document.

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<Boolean>	ASTERISK_DELIMITER_PROCESSOR
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLANK_LINES_IN_AST
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_ALLOW_LEADING_SPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_IGNORE_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_TO_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	BLOCK_QUOTE_WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Integer>	CODE_BLOCK_INDENT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	CODE_CONTENT_BLOCK Deprecated. use FENCED_CODE_CONTENT_BLOCK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	CODE_SOFT_LINE_BREAKS
static com.vladsch.flexmark.util.options.DataKey<Iterable<Extension>>	EXTENSIONS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FENCED_CODE_BLOCK_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FENCED_CODE_CONTENT_BLOCK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HARD_LINE_BREAK_LIMIT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADING_CAN_INTERRUPT_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADING_NO_ATX_SPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADING_NO_EMPTY_HEADING_WITHOUT_SPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADING_NO_LEAD_SPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADING_PARSER
static com.vladsch.flexmark.util.options.DataKey<Integer>	HEADING_SETEXT_MARKER_LENGTH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_COMMENT_ONLY_FULL_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS Blank line interrupts HTML block when not in raw tag, otherwise only when closed
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS_PARTIAL_TAG blank line interrupts partially open tag ie.
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_FIRST_OPEN_TAG_ON_ONE_LINE open tags must be contained on one line
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_INDENTED_CODE_INTERRUPTS Indented code can interrupt HTML block
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_MARKDOWN_INTERRUPTS_CLOSED Other markdown elements can interrupt a closed block without an intervening blank line
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSE_NON_BLOCK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_DEEP_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_BLOCK_START_ONLY_ON_BLOCK_TAGS
static com.vladsch.flexmark.util.options.DataKey<List<String>>	HTML_BLOCK_TAGS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_COMMENT_BLOCKS_INTERRUPT_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HTML_FOR_TRANSLATOR
static com.vladsch.flexmark.util.options.DataKey<Boolean>	INDENTED_CODE_BLOCK_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	INDENTED_CODE_NO_TRAILING_BLANK_LINES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	INLINE_DELIMITER_DIRECTIONAL_PUNCTUATIONS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	INTELLIJ_DUMMY_IDENTIFIER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LINKS_ALLOW_MATCHED_PARENTHESES LINKS_ALLOW_MATCHED_PARENTHESES default true, when false makes parsing CommonMark Spec 0.27 compliant
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LIST_BLOCK_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_AUTO_LOOSE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_AUTO_LOOSE_ONE_LEVEL_LISTS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_BULLET_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Integer>	LISTS_CODE_INDENT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_DELIMITER_MISMATCH_TO_NEW_LIST
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_BULLET_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_NON_ONE_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_EMPTY_ORDERED_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_END_ON_DOUBLE_BLANK
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ITEM_CONTENT_AFTER_SUFFIX
static com.vladsch.flexmark.util.options.DataKey<Integer>	LISTS_ITEM_INDENT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ITEM_MARKER_SPACE
static com.vladsch.flexmark.util.options.DataKey<String[]>	LISTS_ITEM_MARKER_SUFFIXES
static com.vladsch.flexmark.util.options.DataKey<String>	LISTS_ITEM_PREFIX_CHARS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ITEM_TYPE_MISMATCH_TO_NEW_LIST
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ITEM_TYPE_MISMATCH_TO_SUB_LIST
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_BLANK_LINE_FOLLOWS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_CONTAINS_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_HAS_LOOSE_SUB_ITEM
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_HAS_NON_LIST_CHILDREN
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_HAS_TRAILING_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_LAST_ITEM_PREV_HAS_TRAILING_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_LOOSE_WHEN_PREV_HAS_TRAILING_BLANK_LINE
static com.vladsch.flexmark.util.options.DataKey<Integer>	LISTS_NEW_ITEM_CODE_INDENT
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_NUMBERED_ITEM_MARKER_SUFFIXED
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_ITEM_DOT_ONLY
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_LIST_MANUAL_START
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	MATCH_CLOSING_FENCE_CHARACTERS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	MATCH_NESTED_LINK_REFS_FIRST
static com.vladsch.flexmark.util.options.DataKey<Boolean>	PARSE_INNER_HTML_COMMENTS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	PARSE_JEKYLL_MACROS_IN_URLS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	PARSE_MULTI_LINE_IMAGE_URLS
static com.vladsch.flexmark.util.options.DataKey<ParserEmulationProfile>	PARSER_EMULATION_FAMILY Deprecated.
static com.vladsch.flexmark.util.options.DataKey<ParserEmulationProfile>	PARSER_EMULATION_PROFILE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	REFERENCE_PARAGRAPH_PRE_PROCESSOR
static com.vladsch.flexmark.util.options.DataKey<ReferenceRepository>	REFERENCES
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.KeepType>	REFERENCES_KEEP
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SPACE_IN_LINK_ELEMENTS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SPACE_IN_LINK_URLS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	STRONG_WRAPS_EMPHASIS STRONG_WRAPS_EMPHASIS default false, when true makes parsing CommonMark Spec 0.27 compliant
static com.vladsch.flexmark.util.options.DataKey<Boolean>	THEMATIC_BREAK_PARSER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	THEMATIC_BREAK_RELAXED_START
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TRACK_DOCUMENT_LINES
static com.vladsch.flexmark.util.options.DataKey<String>	TRANSLATION_HTML_BLOCK_TAG_PATTERN Used by formatter for translation parsing
static com.vladsch.flexmark.util.options.DataKey<String>	TRANSLATION_HTML_INLINE_TAG_PATTERN
static com.vladsch.flexmark.util.options.DataKey<Boolean>	UNDERSCORE_DELIMITER_PROCESSOR

Method Summary

Modifier and Type	Method and Description
static com.vladsch.flexmark.util.options.MutableDataHolder	addExtensions(com.vladsch.flexmark.util.options.MutableDataHolder options, Extension... extensions) Add extension(s) to the extension list
static Parser.Builder	builder() Create a new builder for configuring a Parser.
static Parser.Builder	builder(com.vladsch.flexmark.util.options.DataHolder options)
com.vladsch.flexmark.ast.Document	parse(com.vladsch.flexmark.util.sequence.BasedSequence input) Parse the specified input text into a tree of nodes.
com.vladsch.flexmark.ast.Document	parse(String input) Parse the specified input text into a tree of nodes.
com.vladsch.flexmark.ast.Document	parseReader(Reader input) Parse the specified reader into a tree of nodes.
static com.vladsch.flexmark.util.options.MutableDataHolder	removeExtensions(com.vladsch.flexmark.util.options.MutableDataHolder options, Class... extensions) Remove extension(s) of given class from the extension list
boolean	transferReferences(com.vladsch.flexmark.ast.Document document, com.vladsch.flexmark.ast.Document included)
static <T extends com.vladsch.flexmark.ast.Node> boolean	transferReferences(com.vladsch.flexmark.ast.NodeRepository<T> destination, com.vladsch.flexmark.ast.NodeRepository<T> included, boolean ifUndefined)
Parser	withOptions(com.vladsch.flexmark.util.options.DataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSIONS

public static final com.vladsch.flexmark.util.options.DataKey<Iterable<Extension>> EXTENSIONS

REFERENCES_KEEP

public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.KeepType> REFERENCES_KEEP

REFERENCES

public static final com.vladsch.flexmark.util.options.DataKey<ReferenceRepository> REFERENCES

ASTERISK_DELIMITER_PROCESSOR

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ASTERISK_DELIMITER_PROCESSOR

TRACK_DOCUMENT_LINES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> TRACK_DOCUMENT_LINES

BLOCK_QUOTE_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_PARSER

BLOCK_QUOTE_TO_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_TO_BLANK_LINE

BLOCK_QUOTE_IGNORE_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_IGNORE_BLANK_LINE

BLOCK_QUOTE_ALLOW_LEADING_SPACE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_ALLOW_LEADING_SPACE

BLOCK_QUOTE_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_INTERRUPTS_PARAGRAPH

BLOCK_QUOTE_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_INTERRUPTS_ITEM_PARAGRAPH

BLOCK_QUOTE_WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLOCK_QUOTE_WITH_LEAD_SPACES_INTERRUPTS_ITEM_PARAGRAPH

FENCED_CODE_BLOCK_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FENCED_CODE_BLOCK_PARSER

MATCH_CLOSING_FENCE_CHARACTERS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> MATCH_CLOSING_FENCE_CHARACTERS

FENCED_CODE_CONTENT_BLOCK

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FENCED_CODE_CONTENT_BLOCK

CODE_SOFT_LINE_BREAKS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> CODE_SOFT_LINE_BREAKS

CODE_CONTENT_BLOCK

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> CODE_CONTENT_BLOCK

Deprecated. use FENCED_CODE_CONTENT_BLOCK

HARD_LINE_BREAK_LIMIT

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HARD_LINE_BREAK_LIMIT

HEADING_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADING_PARSER

HEADING_SETEXT_MARKER_LENGTH

public static final com.vladsch.flexmark.util.options.DataKey<Integer> HEADING_SETEXT_MARKER_LENGTH

HEADING_NO_ATX_SPACE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADING_NO_ATX_SPACE

HEADING_NO_EMPTY_HEADING_WITHOUT_SPACE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADING_NO_EMPTY_HEADING_WITHOUT_SPACE

HEADING_NO_LEAD_SPACE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADING_NO_LEAD_SPACE

HEADING_CAN_INTERRUPT_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HEADING_CAN_INTERRUPT_ITEM_PARAGRAPH

HTML_BLOCK_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_PARSER

HTML_COMMENT_BLOCKS_INTERRUPT_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_COMMENT_BLOCKS_INTERRUPT_PARAGRAPH

HTML_FOR_TRANSLATOR

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_FOR_TRANSLATOR

INLINE_DELIMITER_DIRECTIONAL_PUNCTUATIONS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> INLINE_DELIMITER_DIRECTIONAL_PUNCTUATIONS

INDENTED_CODE_BLOCK_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> INDENTED_CODE_BLOCK_PARSER

INDENTED_CODE_NO_TRAILING_BLANK_LINES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> INDENTED_CODE_NO_TRAILING_BLANK_LINES

INTELLIJ_DUMMY_IDENTIFIER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> INTELLIJ_DUMMY_IDENTIFIER

MATCH_NESTED_LINK_REFS_FIRST

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> MATCH_NESTED_LINK_REFS_FIRST

PARSE_INNER_HTML_COMMENTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> PARSE_INNER_HTML_COMMENTS

PARSE_MULTI_LINE_IMAGE_URLS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> PARSE_MULTI_LINE_IMAGE_URLS

PARSE_JEKYLL_MACROS_IN_URLS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> PARSE_JEKYLL_MACROS_IN_URLS

SPACE_IN_LINK_URLS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SPACE_IN_LINK_URLS

SPACE_IN_LINK_ELEMENTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SPACE_IN_LINK_ELEMENTS

REFERENCE_PARAGRAPH_PRE_PROCESSOR

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> REFERENCE_PARAGRAPH_PRE_PROCESSOR

THEMATIC_BREAK_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> THEMATIC_BREAK_PARSER

THEMATIC_BREAK_RELAXED_START

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> THEMATIC_BREAK_RELAXED_START

UNDERSCORE_DELIMITER_PROCESSOR

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> UNDERSCORE_DELIMITER_PROCESSOR

BLANK_LINES_IN_AST

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> BLANK_LINES_IN_AST

STRONG_WRAPS_EMPHASIS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> STRONG_WRAPS_EMPHASIS

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

LINKS_ALLOW_MATCHED_PARENTHESES

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LINKS_ALLOW_MATCHED_PARENTHESES

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

LIST_BLOCK_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LIST_BLOCK_PARSER

PARSER_EMULATION_PROFILE

public static final com.vladsch.flexmark.util.options.DataKey<ParserEmulationProfile> PARSER_EMULATION_PROFILE

HTML_BLOCK_DEEP_PARSER

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSER

HTML_BLOCK_DEEP_PARSE_NON_BLOCK

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_NON_BLOCK

HTML_BLOCK_COMMENT_ONLY_FULL_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_COMMENT_ONLY_FULL_LINE

HTML_BLOCK_START_ONLY_ON_BLOCK_TAGS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_START_ONLY_ON_BLOCK_TAGS

HTML_BLOCK_TAGS

public static final com.vladsch.flexmark.util.options.DataKey<List<String>> HTML_BLOCK_TAGS

HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS

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

HTML_BLOCK_DEEP_PARSE_FIRST_OPEN_TAG_ON_ONE_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_FIRST_OPEN_TAG_ON_ONE_LINE

open tags must be contained on one line

HTML_BLOCK_DEEP_PARSE_MARKDOWN_INTERRUPTS_CLOSED

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_MARKDOWN_INTERRUPTS_CLOSED

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

HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS_PARTIAL_TAG

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_BLANK_LINE_INTERRUPTS_PARTIAL_TAG

blank line interrupts partially open tag ie. <TAG without a corresponding >

HTML_BLOCK_DEEP_PARSE_INDENTED_CODE_INTERRUPTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> HTML_BLOCK_DEEP_PARSE_INDENTED_CODE_INTERRUPTS

Indented code can interrupt HTML block

TRANSLATION_HTML_BLOCK_TAG_PATTERN

public static final com.vladsch.flexmark.util.options.DataKey<String> TRANSLATION_HTML_BLOCK_TAG_PATTERN

Used by formatter for translation parsing

TRANSLATION_HTML_INLINE_TAG_PATTERN

public static final com.vladsch.flexmark.util.options.DataKey<String> TRANSLATION_HTML_INLINE_TAG_PATTERN

PARSER_EMULATION_FAMILY

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<ParserEmulationProfile> PARSER_EMULATION_FAMILY

Deprecated.

LISTS_CODE_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<Integer> LISTS_CODE_INDENT

LISTS_ITEM_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<Integer> LISTS_ITEM_INDENT

LISTS_NEW_ITEM_CODE_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<Integer> LISTS_NEW_ITEM_CODE_INDENT

LISTS_ITEM_MARKER_SPACE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ITEM_MARKER_SPACE

LISTS_ITEM_MARKER_SUFFIXES

public static final com.vladsch.flexmark.util.options.DataKey<String[]> LISTS_ITEM_MARKER_SUFFIXES

LISTS_NUMBERED_ITEM_MARKER_SUFFIXED

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_NUMBERED_ITEM_MARKER_SUFFIXED

LISTS_AUTO_LOOSE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_AUTO_LOOSE

LISTS_AUTO_LOOSE_ONE_LEVEL_LISTS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_AUTO_LOOSE_ONE_LEVEL_LISTS

LISTS_LOOSE_WHEN_PREV_HAS_TRAILING_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_PREV_HAS_TRAILING_BLANK_LINE

LISTS_LOOSE_WHEN_LAST_ITEM_PREV_HAS_TRAILING_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_LAST_ITEM_PREV_HAS_TRAILING_BLANK_LINE

LISTS_LOOSE_WHEN_HAS_NON_LIST_CHILDREN

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_HAS_NON_LIST_CHILDREN

LISTS_LOOSE_WHEN_BLANK_LINE_FOLLOWS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_BLANK_LINE_FOLLOWS_ITEM_PARAGRAPH

LISTS_LOOSE_WHEN_HAS_LOOSE_SUB_ITEM

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_HAS_LOOSE_SUB_ITEM

LISTS_LOOSE_WHEN_HAS_TRAILING_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_HAS_TRAILING_BLANK_LINE

LISTS_LOOSE_WHEN_CONTAINS_BLANK_LINE

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_LOOSE_WHEN_CONTAINS_BLANK_LINE

LISTS_DELIMITER_MISMATCH_TO_NEW_LIST

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_DELIMITER_MISMATCH_TO_NEW_LIST

LISTS_END_ON_DOUBLE_BLANK

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_END_ON_DOUBLE_BLANK

LISTS_ITEM_TYPE_MISMATCH_TO_NEW_LIST

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ITEM_TYPE_MISMATCH_TO_NEW_LIST

LISTS_ITEM_TYPE_MISMATCH_TO_SUB_LIST

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ITEM_TYPE_MISMATCH_TO_SUB_LIST

LISTS_ORDERED_ITEM_DOT_ONLY

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_ITEM_DOT_ONLY

LISTS_ORDERED_LIST_MANUAL_START

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_LIST_MANUAL_START

LISTS_ITEM_CONTENT_AFTER_SUFFIX

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ITEM_CONTENT_AFTER_SUFFIX

LISTS_BULLET_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_BULLET_ITEM_INTERRUPTS_PARAGRAPH

LISTS_ORDERED_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_ITEM_INTERRUPTS_PARAGRAPH

LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH

LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_PARAGRAPH

LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_PARAGRAPH

LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_PARAGRAPH

LISTS_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_BULLET_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_NON_ONE_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_BULLET_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_BULLET_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_ORDERED_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_EMPTY_ORDERED_NON_ONE_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LISTS_EMPTY_ORDERED_NON_ONE_SUB_ITEM_INTERRUPTS_ITEM_PARAGRAPH

LISTS_ITEM_PREFIX_CHARS

public static final com.vladsch.flexmark.util.options.DataKey<String> LISTS_ITEM_PREFIX_CHARS

CODE_BLOCK_INDENT

public static final com.vladsch.flexmark.util.options.DataKey<Integer> CODE_BLOCK_INDENT

Method Detail

builder

public static Parser.Builder builder()

Create a new builder for configuring a Parser.

Returns:

a builder

builder

public static Parser.Builder builder(com.vladsch.flexmark.util.options.DataHolder options)

parse

public com.vladsch.flexmark.ast.Document parse(com.vladsch.flexmark.util.sequence.BasedSequence input)

Parse the specified input text into a tree of nodes.

Note that this method is thread-safe (a new parser state is used for each invocation).

Specified by:

parse in interface com.vladsch.flexmark.IParse

Parameters:

input - the text to parse

Returns:

the root node

parse

public com.vladsch.flexmark.ast.Document parse(String input)

Parse the specified input text into a tree of nodes.

Note that this method is thread-safe (a new parser state is used for each invocation).

Specified by:

parse in interface com.vladsch.flexmark.IParse

Parameters:

input - the text to parse

Returns:

the root node

parseReader

public com.vladsch.flexmark.ast.Document parseReader(Reader input)
                                              throws IOException

Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader.

Note that this method is thread-safe (a new parser state is used for each invocation).

Specified by:

parseReader in interface com.vladsch.flexmark.IParse

Parameters:

input - the reader to parse

Returns:

the root node

Throws:

IOException - when reading throws an exception

withOptions

public Parser withOptions(com.vladsch.flexmark.util.options.DataHolder options)

Specified by:

withOptions in interface com.vladsch.flexmark.IParse

transferReferences

public boolean transferReferences(com.vladsch.flexmark.ast.Document document,
                                  com.vladsch.flexmark.ast.Document included)

transferReferences

public static <T extends com.vladsch.flexmark.ast.Node> boolean transferReferences(com.vladsch.flexmark.ast.NodeRepository<T> destination,
                                                                                   com.vladsch.flexmark.ast.NodeRepository<T> included,
                                                                                   boolean ifUndefined)

addExtensions

public static com.vladsch.flexmark.util.options.MutableDataHolder addExtensions(com.vladsch.flexmark.util.options.MutableDataHolder options,
                                                                                Extension... extensions)

Add extension(s) to the extension list

Parameters:

options - mutable options holding existing extensions

extensions - extension to add

Returns:

mutable options

removeExtensions

public static com.vladsch.flexmark.util.options.MutableDataHolder removeExtensions(com.vladsch.flexmark.util.options.MutableDataHolder options,
                                                                                   Class... extensions)

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

Parameters:

options - mutable options holding existing extensions

extensions - extension classes to remove

Returns:

mutable options