org.commonmark.parser.delimiter

Interface DelimiterProcessor

public interface DelimiterProcessor

Custom delimiter processor for additional delimiters besides _ and *.

Note that implementations of this need to be thread-safe, the same instance may be used by multiple parsers.

Method Summary

Modifier and Type	Method and Description
char	getClosingCharacter()
int	getDelimiterUse(DelimiterRun opener, DelimiterRun closer) Determine how many (if any) of the delimiter characters should be used.
int	getMinLength() Minimum number of delimiter characters that are needed to activate this.
char	getOpeningCharacter()
void	process(Text opener, Text closer, int delimiterUse) Process the matched delimiters, e.g.

Method Detail

getOpeningCharacter

char getOpeningCharacter()

Returns:

the character that marks the beginning of a delimited node, must not clash with any built-in special characters

getClosingCharacter

char getClosingCharacter()

Returns:

the character that marks the the ending of a delimited node, must not clash with any built-in special characters. Note that for a symmetric delimiter such as "*", this is the same as the opening.

getMinLength

int getMinLength()

Minimum number of delimiter characters that are needed to activate this. Must be at least 1.

getDelimiterUse

int getDelimiterUse(DelimiterRun opener,
                    DelimiterRun closer)

Determine how many (if any) of the delimiter characters should be used.

This allows implementations to decide how many characters to use based on the properties of the delimiter runs. An implementation can also return 0 when it doesn't want to allow this particular combination of delimiter runs.

Parameters:

opener - the opening delimiter run

closer - the closing delimiter run

Returns:

how many delimiters should be used; must not be greater than length of either opener or closer

process

void process(Text opener,
             Text closer,
             int delimiterUse)

Process the matched delimiters, e.g. by wrapping the nodes between opener and closer in a new node, or appending a new node after the opener.

Note that removal of the delimiter from the delimiter nodes and unlinking them is done by the caller.

Parameters:

opener - the text node that contained the opening delimiter

closer - the text node that contained the closing delimiter

delimiterUse - the number of delimiters that were used