Package org.commonmark.ext.gfm.strikethrough.internal

Class StrikethroughDelimiterProcessor

java.lang.Object

org.commonmark.ext.gfm.strikethrough.internal.StrikethroughDelimiterProcessor

All Implemented Interfaces:

DelimiterProcessor

public class StrikethroughDelimiterProcessor
extends java.lang.Object
implements DelimiterProcessor

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	requireTwoTildes

Constructor Summary

Constructors

Constructor	Description
StrikethroughDelimiterProcessor()
StrikethroughDelimiterProcessor(boolean requireTwoTildes)

Method Summary

Modifier and Type	Method	Description
char	getClosingCharacter()
int	getMinLength()	Minimum number of delimiter characters that are needed to activate this.
char	getOpeningCharacter()
int	process(DelimiterRun openingRun, DelimiterRun closingRun)	Process the delimiter runs.

Methods inherited from class java.lang.Object

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

Field Detail

requireTwoTildes

private final boolean requireTwoTildes

Constructor Detail

StrikethroughDelimiterProcessor

public StrikethroughDelimiterProcessor()

StrikethroughDelimiterProcessor

public StrikethroughDelimiterProcessor(boolean requireTwoTildes)

Method Detail

getOpeningCharacter

public char getOpeningCharacter()

Specified by:

getOpeningCharacter in interface DelimiterProcessor

Returns:

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

getClosingCharacter

public char getClosingCharacter()

Specified by:

getClosingCharacter in interface DelimiterProcessor

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

public int getMinLength()

Description copied from interface: DelimiterProcessor

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

Specified by:

getMinLength in interface DelimiterProcessor

process

public int process(DelimiterRun openingRun,
                   DelimiterRun closingRun)

Description copied from interface: DelimiterProcessor

Process the delimiter runs.

The processor can examine the runs and the nodes and decide if it wants to process or not. If not, it should not change any nodes and return 0. If yes, it should do the processing (wrapping nodes, etc) and then return how many delimiters were used.

Note that removal (unlinking) of the used delimiter Text nodes is done by the caller.

Specified by:

process in interface DelimiterProcessor

Parameters:

openingRun - the opening delimiter run

closingRun - the closing delimiter run

Returns:

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