Top Fields Constructors Methods

com.vladsch.flexmark.util.sequence.mappers

public Class SpecialLeadInCharsHandler

Class Inheritance

extends Object
implements SpecialLeadInHandler

java.lang.Object
com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInCharsHandler

All Implemented Interfaces

com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInHandler

Imports

com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.misc.CharPredicate, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.function.Consumer

Field Summary

Modifier and Type	Field and Description
pack-priv final CharPredicate	predicate

Constructor Summary

Access	Constructor and Description
protected	SpecialLeadInCharsHandler(CharPredicate predicate)

Method Summary

Modifier and Type	Method and Description
public static @NotNull SpecialLeadInCharsHandler	create(char leadInChar)
public static @NotNull SpecialLeadInCharsHandler	create(@NotNull CharSequence leadInChar)
public boolean	Returns: true if sequence was a lead in for the handler escape(@NotNull BasedSequence char sequence appearing as first non-whitespace on a line sequence, @Nullable DataHolder options options, @NotNull Consumer<CharSequence> consumer of char sequences to be called for the leadIn if it is changed by this handler 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
public boolean	Returns: true if sequence was a lead in for the handler unEscape(@NotNull BasedSequence char sequence appearing as first non-whitespace on a line sequence, @Nullable DataHolder options options, @NotNull Consumer<CharSequence> consumer of char sequences to be called for the leadIn if it is changed by this handler 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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

predicate	back to summary
pack-priv final CharPredicate predicate

Constructor Detail

SpecialLeadInCharsHandler	back to summary
protected SpecialLeadInCharsHandler(CharPredicate predicate)

Method Detail

create	back to summary
public static @NotNull SpecialLeadInCharsHandler create(char leadInChar) Annotations @NotNull

create	back to summary
public static @NotNull SpecialLeadInCharsHandler create(@NotNull CharSequence leadInChar) Annotations @NotNull

escape	back to summary
public boolean 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 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 Parameters sequence:@NotNull BasedSequence char sequence appearing as first non-whitespace on a line options:@Nullable DataHolder options consumer:@NotNull Consumer<CharSequence> consumer of char sequences to be called for the leadIn if it is changed by this handler Returns:boolean true if sequence was a lead in for the handler Annotations @Override

unEscape	back to summary
public boolean 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 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 Parameters sequence:@NotNull BasedSequence char sequence appearing as first non-whitespace on a line options:@Nullable DataHolder options consumer:@NotNull Consumer<CharSequence> consumer of char sequences to be called for the leadIn if it is changed by this handler Returns:boolean true if sequence was a lead in for the handler Annotations @Override