Package org.commonmark.internal

Class StaggeredDelimiterProcessor

java.lang.Object
org.commonmark.internal.StaggeredDelimiterProcessor
All Implemented Interfaces:
DelimiterProcessor
class StaggeredDelimiterProcessor extends Object implements DelimiterProcessor
An implementation of DelimiterProcessor that dispatches all calls to two or more other DelimiterProcessors depending on the length of the delimiter run. All child DelimiterProcessors must have different minimum lengths. A given delimiter run is dispatched to the child with the largest acceptable minimum length. If no child is applicable, the one with the largest minimum length is chosen.

  • Field Details

  • Constructor Details

    • StaggeredDelimiterProcessor

      StaggeredDelimiterProcessor(char delim)

  • Method Details

    • 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

    • add

      void add(DelimiterProcessor dp)

    • findProcessor

      private DelimiterProcessor findProcessor(int len)

    • 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