Package com.vladsch.flexmark.util.sequence.mappers

Class SpecialLeadInCharsHandler

java.lang.Object

com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInCharsHandler

All Implemented Interfaces:

SpecialLeadInHandler

public class SpecialLeadInCharsHandler
extends Object
implements SpecialLeadInHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpecialLeadInCharsHandler(com.vladsch.flexmark.util.misc.CharPredicate predicate)

Method Summary

Modifier and Type	Method	Description
static @NotNull SpecialLeadInCharsHandler	create(char leadInChar)
static @NotNull SpecialLeadInCharsHandler	create(@NotNull CharSequence leadInChar)
boolean	escape(@NotNull BasedSequence sequence, @Nullable com.vladsch.flexmark.util.data.DataHolder options, @NotNull Consumer<CharSequence> consumer)	Escape special lead-in characters which start a block element if first non-whitespace on the line
boolean	unEscape(@NotNull BasedSequence sequence, @Nullable com.vladsch.flexmark.util.data.DataHolder options, @NotNull Consumer<CharSequence> consumer)	UnEscape special lead-in characters which start a block element if first non-whitespace on the line

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecialLeadInCharsHandler

protected SpecialLeadInCharsHandler(com.vladsch.flexmark.util.misc.CharPredicate predicate)

Method Detail

escape

public boolean escape(@NotNull
                      @NotNull BasedSequence sequence,
                      @Nullable
                      @Nullable com.vladsch.flexmark.util.data.DataHolder options,
                      @NotNull
                      @NotNull Consumer<CharSequence> consumer)

Escape special lead-in characters which start a block element if first non-whitespace on the line

The 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

Specified by:

escape in interface SpecialLeadInHandler

Parameters:

sequence - char sequence appearing as first non-whitespace on a line

options - options

consumer - 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

public boolean unEscape(@NotNull
                        @NotNull BasedSequence sequence,
                        @Nullable
                        @Nullable com.vladsch.flexmark.util.data.DataHolder options,
                        @NotNull
                        @NotNull Consumer<CharSequence> consumer)

UnEscape special lead-in characters which start a block element if first non-whitespace on the line

The 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

Specified by:

unEscape in interface SpecialLeadInHandler

Parameters:

sequence - char sequence appearing as first non-whitespace on a line

options - options

consumer - 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

create

@NotNull
public static @NotNull SpecialLeadInCharsHandler create(char leadInChar)

create

@NotNull
public static @NotNull SpecialLeadInCharsHandler create(@NotNull
                                                        @NotNull CharSequence leadInChar)