Package org.commonmark.parser.beta

Interface InlineContentParserFactory

public interface InlineContentParserFactory

A factory for extending inline content parsing.

See Parser.Builder.customInlineContentParserFactory(org.commonmark.parser.beta.InlineContentParserFactory) for how to register it.

Method Summary

Modifier and Type	Method	Description
InlineContentParser	create()	Create an InlineContentParser that will do the parsing.
Set<Character>	getTriggerCharacters()	An inline content parser needs to have a special "trigger" character which activates it.

Method Details

getTriggerCharacters

Set<Character> getTriggerCharacters()

An inline content parser needs to have a special "trigger" character which activates it. When this character is encountered during inline parsing, InlineContentParser.tryParse(org.commonmark.parser.beta.InlineParserState) is called with the current parser state. It can also register for more than one trigger character.

create

InlineContentParser create()

Create an InlineContentParser that will do the parsing. Create is called once per text snippet of inline content inside block structures, and then called each time a trigger character is encountered.