Interface SpecialLeadInHandler
- All Known Implementing Classes:
AdmonitionBlockParser.AdmonitionLeadInHandler
,ListBlockParser.ListItemLeadInHandler
,SpecialLeadInCharsHandler
,SpecialLeadInStartsWithCharsHandler
public interface SpecialLeadInHandler
-
Method Summary
Modifier and TypeMethodDescriptionboolean
escape
(@NotNull BasedSequence sequence, @Nullable DataHolder options, @NotNull Consumer<CharSequence> consumer) Escape special lead-in characters which start a block element if first non-whitespace on the lineboolean
unEscape
(@NotNull BasedSequence sequence, @Nullable DataHolder options, @NotNull Consumer<CharSequence> consumer) UnEscape special lead-in characters which start a block element if first non-whitespace on the line
-
Method Details
-
escape
boolean escape(@NotNull @NotNull BasedSequence sequence, @Nullable @Nullable DataHolder options, @NotNull @NotNull Consumer<CharSequence> consumer) Escape special lead-in characters which start a block element if first non-whitespace on the lineThe leadIn sequence is always followed by a space or EOL so if lead in does not require a space to start a block element then test if it starts with the special sequence, otherwise test if it equals the special sequence
- Parameters:
sequence
- char sequence appearing as first non-whitespace on a lineoptions
- additional options if neededconsumer
- consumer of char sequences to be called for the leadIn if it is changed by this handler- Returns:
- true if sequence was a lead in for the handler
-
unEscape
boolean unEscape(@NotNull @NotNull BasedSequence sequence, @Nullable @Nullable DataHolder options, @NotNull @NotNull Consumer<CharSequence> consumer) UnEscape special lead-in characters which start a block element if first non-whitespace on the lineThe leadIn sequence is always followed by a space or EOL so if lead in does not require a space to start a block element then test if it starts with the special sequence, otherwise test if it equals the special sequence
- Parameters:
sequence
- char sequence appearing as first non-whitespace on a lineoptions
- additional options if neededconsumer
- consumer of char sequences to be called for the leadIn if it is changed by this handler- Returns:
- true if sequence was a lead in for the handler
-