com.vladsch.flexmark.util.format

Class MarkdownWriterBase<T extends MarkdownWriterBase<T,N,C>,N,C extends NodeContext<N,C>>

java.lang.Object

com.vladsch.flexmark.util.format.MarkdownWriterBase<T,N,C>

All Implemented Interfaces:

com.vladsch.flexmark.util.sequence.LineAppendable, Appendable, Iterable<com.vladsch.flexmark.util.sequence.LineInfo>

public abstract class MarkdownWriterBase<T extends MarkdownWriterBase<T,N,C>,N,C extends NodeContext<N,C>>
extends Object
implements com.vladsch.flexmark.util.sequence.LineAppendable

Nested Class Summary

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

com.vladsch.flexmark.util.sequence.LineAppendable.Options

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vladsch.flexmark.util.sequence.LineAppendableImpl	appendable
protected C	context

Fields inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

ALLOW_LEADING_EOL, ALLOW_LEADING_WHITESPACE, COLLAPSE_WHITESPACE, CONVERT_TABS, F_COLLAPSE_WHITESPACE, F_CONVERT_TABS, F_FORMAT_ALL, F_PASS_THROUGH, F_PREFIX_PRE_FORMATTED, F_TRIM_LEADING_EOL, F_TRIM_LEADING_WHITESPACE, F_TRIM_TRAILING_WHITESPACE, F_WHITESPACE_REMOVAL, FORMAT_ALL, O_COLLAPSE_WHITESPACE, O_CONVERT_TABS, O_FORMAT_ALL, O_PASS_THROUGH, O_PREFIX_PRE_FORMATTED, O_TRIM_LEADING_EOL, O_TRIM_LEADING_WHITESPACE, O_TRIM_TRAILING_WHITESPACE, PASS_THROUGH, PREFIX_PRE_FORMATTED, TRIM_LEADING_WHITESPACE, TRIM_TRAILING_WHITESPACE

Constructor Summary

Constructors

Constructor and Description
MarkdownWriterBase()
MarkdownWriterBase(@Nullable Appendable builder, int formatOptions)
MarkdownWriterBase(int formatOptions)

Method Summary

Modifier and Type	Method and Description
T	addIndentOnFirstEOL(@NotNull Runnable listener)
T	addPrefix(@NotNull CharSequence prefix)
T	addPrefix(@NotNull CharSequence prefix, boolean afterEol)
T	append(char c)
T	append(char c, int count)
T	append(@NotNull CharSequence csq)
T	append(@NotNull CharSequence csq, int start, int end)
T	append(@NotNull com.vladsch.flexmark.util.sequence.LineAppendable lines, int startLine, int endLine, boolean withPrefixes)
<T extends Appendable> T	appendTo(T out, boolean withPrefixes, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine)
T	blankLine()
T	blankLine(int count)
T	blankLineIf(boolean predicate)
T	changeOptions(int addFlags, int removeFlags)
T	closePreFormatted()
int	column()
boolean	endsWithEOL()
int	getAfterEolPrefixDelta()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence	getBeforeEolPrefix()
@NotNull com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder<?,?>	getBuilder()
C	getContext()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence	getIndentPrefix()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence	getLine(int lineIndex)
int	getLineCount()
int	getLineCountWithPending()
@NotNull com.vladsch.flexmark.util.sequence.LineInfo	getLineInfo(int lineIndex)
@NotNull Iterable<com.vladsch.flexmark.util.sequence.BasedSequence>	getLines(int maxTrailingBlankLines, int startLine, int endLine, boolean withPrefixes)
@NotNull Iterable<com.vladsch.flexmark.util.sequence.LineInfo>	getLinesInfo(int maxTrailingBlankLines, int startLine, int endLine)
int	getOptions()
@NotNull com.vladsch.flexmark.util.misc.BitFieldSet<com.vladsch.flexmark.util.sequence.LineAppendable.Options>	getOptionSet()
int	getPendingEOL()
int	getPendingSpace()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence	getPrefix()
int	getTrailingBlankLines(int endLine)
T	indent()
void	insertLine(int lineIndex, @NotNull CharSequence prefix, @NotNull CharSequence text)
boolean	isPendingSpace()
boolean	isPreFormatted()
@NotNull Iterator<com.vladsch.flexmark.util.sequence.LineInfo>	iterator()
abstract @NotNull com.vladsch.flexmark.util.sequence.BasedSequence	lastBlockQuoteChildPrefix(com.vladsch.flexmark.util.sequence.BasedSequence prefix)
T	line()
T	lineIf(boolean predicate)
T	lineOnFirstText(boolean value)
T	lineWithTrailingSpaces(int count)
int	offset()
int	offsetWithPending()
T	openPreFormatted(boolean keepIndent)
T	popOptions()
T	popPrefix()
T	popPrefix(boolean afterEol)
T	pushOptions()
T	pushPrefix()
T	removeExtraBlankLines(int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine)
T	removeIndentOnFirstEOL(@NotNull Runnable listener)
T	removeLines(int startLine, int endLine)
void	setContext(C context)
T	setIndentPrefix(@Nullable CharSequence prefix)
void	setLine(int lineIndex, @NotNull CharSequence prefix, @NotNull CharSequence text)
T	setOptions(int flags)
T	setPrefix(@NotNull CharSequence prefix)
T	setPrefix(@Nullable CharSequence prefix, boolean afterEol)
void	setPrefixLength(int lineIndex, int prefixEndIndex)
T	tailBlankLine()
T	tailBlankLine(int count)
@NotNull CharSequence	toSequence(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes)
String	toString()
@NotNull String	toString(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes)
T	unIndent()
T	unIndentNoEol()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

addOptions, append, append, appendAll, appendTo, appendTo, appendTo, appendTo, appendToSilently, appendToSilently, appendToSilently, appendToSilently, clearLineOnFirstText, combinedPrefix, copyAppendable, copyAppendable, copyAppendable, copyAppendable, copyAppendable, get, getEmptyAppendable, getLineContent, getLinePrefix, getLines, getLines, getLines, getLines, getLinesInfo, getLinesInfo, getTrailingBlankLines, isEmpty, isNotEmpty, noPreserveSpaces, noTrimLeading, preserveSpaces, removeExtraBlankLines, removeOptions, setLineOnFirstText, setOptions, setOptions, toOptionSet, toOptionSet, toSequence, toSequence, toSequence, toSequence, toString, toString, toString, toString, trimLeading

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

appendable

protected final com.vladsch.flexmark.util.sequence.LineAppendableImpl appendable

context

protected C extends NodeContext<N,C> context

Constructor Detail

MarkdownWriterBase

public MarkdownWriterBase()

MarkdownWriterBase

public MarkdownWriterBase(int formatOptions)

MarkdownWriterBase

public MarkdownWriterBase(@Nullable
                          @Nullable Appendable builder,
                          int formatOptions)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setContext

public void setContext(C context)

getContext

public C getContext()

tailBlankLine

@NotNull
public T tailBlankLine()

lastBlockQuoteChildPrefix

@NotNull
public abstract @NotNull com.vladsch.flexmark.util.sequence.BasedSequence lastBlockQuoteChildPrefix(com.vladsch.flexmark.util.sequence.BasedSequence prefix)

tailBlankLine

@NotNull
public T tailBlankLine(int count)

iterator

@NotNull
public @NotNull Iterator<com.vladsch.flexmark.util.sequence.LineInfo> iterator()

Specified by:

iterator in interface com.vladsch.flexmark.util.sequence.LineAppendable

Specified by:

iterator in interface Iterable<com.vladsch.flexmark.util.sequence.LineInfo>

getLines

@NotNull
public @NotNull Iterable<com.vladsch.flexmark.util.sequence.BasedSequence> getLines(int maxTrailingBlankLines,
                                                                                             int startLine,
                                                                                             int endLine,
                                                                                             boolean withPrefixes)

Specified by:

getLines in interface com.vladsch.flexmark.util.sequence.LineAppendable

getLinesInfo

@NotNull
public @NotNull Iterable<com.vladsch.flexmark.util.sequence.LineInfo> getLinesInfo(int maxTrailingBlankLines,
                                                                                            int startLine,
                                                                                            int endLine)

Specified by:

getLinesInfo in interface com.vladsch.flexmark.util.sequence.LineAppendable

setPrefixLength

public void setPrefixLength(int lineIndex,
                            int prefixEndIndex)

Specified by:

setPrefixLength in interface com.vladsch.flexmark.util.sequence.LineAppendable

insertLine

public void insertLine(int lineIndex,
                       @NotNull
                       @NotNull CharSequence prefix,
                       @NotNull
                       @NotNull CharSequence text)

Specified by:

insertLine in interface com.vladsch.flexmark.util.sequence.LineAppendable

setLine

public void setLine(int lineIndex,
                    @NotNull
                    @NotNull CharSequence prefix,
                    @NotNull
                    @NotNull CharSequence text)

Specified by:

setLine in interface com.vladsch.flexmark.util.sequence.LineAppendable

appendTo

public <T extends Appendable> T appendTo(@NotNull
                                         T out,
                                         boolean withPrefixes,
                                         int maxBlankLines,
                                         int maxTrailingBlankLines,
                                         int startLine,
                                         int endLine)
                                  throws IOException

Specified by:

appendTo in interface com.vladsch.flexmark.util.sequence.LineAppendable

Throws:

IOException

endsWithEOL

public boolean endsWithEOL()

Specified by:

endsWithEOL in interface com.vladsch.flexmark.util.sequence.LineAppendable

isPendingSpace

public boolean isPendingSpace()

Specified by:

isPendingSpace in interface com.vladsch.flexmark.util.sequence.LineAppendable

isPreFormatted

public boolean isPreFormatted()

Specified by:

isPreFormatted in interface com.vladsch.flexmark.util.sequence.LineAppendable

getTrailingBlankLines

public int getTrailingBlankLines(int endLine)

Specified by:

getTrailingBlankLines in interface com.vladsch.flexmark.util.sequence.LineAppendable

column

public int column()

Specified by:

column in interface com.vladsch.flexmark.util.sequence.LineAppendable

getLineCount

public int getLineCount()

Specified by:

getLineCount in interface com.vladsch.flexmark.util.sequence.LineAppendable

getLineCountWithPending

public int getLineCountWithPending()

Specified by:

getLineCountWithPending in interface com.vladsch.flexmark.util.sequence.LineAppendable

getOptions

public int getOptions()

Specified by:

getOptions in interface com.vladsch.flexmark.util.sequence.LineAppendable

getPendingSpace

public int getPendingSpace()

Specified by:

getPendingSpace in interface com.vladsch.flexmark.util.sequence.LineAppendable

getPendingEOL

public int getPendingEOL()

Specified by:

getPendingEOL in interface com.vladsch.flexmark.util.sequence.LineAppendable

offset

public int offset()

Specified by:

offset in interface com.vladsch.flexmark.util.sequence.LineAppendable

offsetWithPending

public int offsetWithPending()

Specified by:

offsetWithPending in interface com.vladsch.flexmark.util.sequence.LineAppendable

getAfterEolPrefixDelta

public int getAfterEolPrefixDelta()

Specified by:

getAfterEolPrefixDelta in interface com.vladsch.flexmark.util.sequence.LineAppendable

getBuilder

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder<?,?> getBuilder()

Specified by:

getBuilder in interface com.vladsch.flexmark.util.sequence.LineAppendable

getPrefix

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getPrefix()

Specified by:

getPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

getBeforeEolPrefix

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getBeforeEolPrefix()

Specified by:

getBeforeEolPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

getLineInfo

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.LineInfo getLineInfo(int lineIndex)

Specified by:

getLineInfo in interface com.vladsch.flexmark.util.sequence.LineAppendable

getLine

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getLine(int lineIndex)

Specified by:

getLine in interface com.vladsch.flexmark.util.sequence.LineAppendable

getIndentPrefix

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getIndentPrefix()

Specified by:

getIndentPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

toSequence

@NotNull
public @NotNull CharSequence toSequence(int maxBlankLines,
                                                 int maxTrailingBlankLines,
                                                 boolean withPrefixes)

Specified by:

toSequence in interface com.vladsch.flexmark.util.sequence.LineAppendable

toString

@NotNull
public @NotNull String toString(int maxBlankLines,
                                         int maxTrailingBlankLines,
                                         boolean withPrefixes)

Specified by:

toString in interface com.vladsch.flexmark.util.sequence.LineAppendable

getOptionSet

@NotNull
public @NotNull com.vladsch.flexmark.util.misc.BitFieldSet<com.vladsch.flexmark.util.sequence.LineAppendable.Options> getOptionSet()

Specified by:

getOptionSet in interface com.vladsch.flexmark.util.sequence.LineAppendable

removeExtraBlankLines

@NotNull
public T removeExtraBlankLines(int maxBlankLines,
                                        int maxTrailingBlankLines,
                                        int startLine,
                                        int endLine)

Specified by:

removeExtraBlankLines in interface com.vladsch.flexmark.util.sequence.LineAppendable

removeLines

@NotNull
public T removeLines(int startLine,
                              int endLine)

Specified by:

removeLines in interface com.vladsch.flexmark.util.sequence.LineAppendable

pushOptions

@NotNull
public T pushOptions()

Specified by:

pushOptions in interface com.vladsch.flexmark.util.sequence.LineAppendable

popOptions

@NotNull
public T popOptions()

Specified by:

popOptions in interface com.vladsch.flexmark.util.sequence.LineAppendable

changeOptions

@NotNull
public T changeOptions(int addFlags,
                                int removeFlags)

Specified by:

changeOptions in interface com.vladsch.flexmark.util.sequence.LineAppendable

addIndentOnFirstEOL

@NotNull
public T addIndentOnFirstEOL(@NotNull
                                      @NotNull Runnable listener)

Specified by:

addIndentOnFirstEOL in interface com.vladsch.flexmark.util.sequence.LineAppendable

addPrefix

@NotNull
public T addPrefix(@NotNull
                            @NotNull CharSequence prefix)

Specified by:

addPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

addPrefix

@NotNull
public T addPrefix(@NotNull
                            @NotNull CharSequence prefix,
                            boolean afterEol)

Specified by:

addPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

append

@NotNull
public T append(char c)

Specified by:

append in interface com.vladsch.flexmark.util.sequence.LineAppendable

Specified by:

append in interface Appendable

append

@NotNull
public T append(@NotNull
                         @NotNull CharSequence csq)

Specified by:

append in interface com.vladsch.flexmark.util.sequence.LineAppendable

Specified by:

append in interface Appendable

append

@NotNull
public T append(@NotNull
                         @NotNull CharSequence csq,
                         int start,
                         int end)

Specified by:

append in interface com.vladsch.flexmark.util.sequence.LineAppendable

Specified by:

append in interface Appendable

append

@NotNull
public T append(@NotNull
                         @NotNull com.vladsch.flexmark.util.sequence.LineAppendable lines,
                         int startLine,
                         int endLine,
                         boolean withPrefixes)

Specified by:

append in interface com.vladsch.flexmark.util.sequence.LineAppendable

blankLine

@NotNull
public T blankLine()

Specified by:

blankLine in interface com.vladsch.flexmark.util.sequence.LineAppendable

blankLine

@NotNull
public T blankLine(int count)

Specified by:

blankLine in interface com.vladsch.flexmark.util.sequence.LineAppendable

blankLineIf

@NotNull
public T blankLineIf(boolean predicate)

Specified by:

blankLineIf in interface com.vladsch.flexmark.util.sequence.LineAppendable

closePreFormatted

@NotNull
public T closePreFormatted()

Specified by:

closePreFormatted in interface com.vladsch.flexmark.util.sequence.LineAppendable

indent

@NotNull
public T indent()

Specified by:

indent in interface com.vladsch.flexmark.util.sequence.LineAppendable

line

@NotNull
public T line()

Specified by:

line in interface com.vladsch.flexmark.util.sequence.LineAppendable

lineIf

@NotNull
public T lineIf(boolean predicate)

Specified by:

lineIf in interface com.vladsch.flexmark.util.sequence.LineAppendable

lineOnFirstText

@NotNull
public T lineOnFirstText(boolean value)

Specified by:

lineOnFirstText in interface com.vladsch.flexmark.util.sequence.LineAppendable

lineWithTrailingSpaces

@NotNull
public T lineWithTrailingSpaces(int count)

Specified by:

lineWithTrailingSpaces in interface com.vladsch.flexmark.util.sequence.LineAppendable

openPreFormatted

@NotNull
public T openPreFormatted(boolean keepIndent)

Specified by:

openPreFormatted in interface com.vladsch.flexmark.util.sequence.LineAppendable

popPrefix

@NotNull
public T popPrefix()

Specified by:

popPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

popPrefix

@NotNull
public T popPrefix(boolean afterEol)

Specified by:

popPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

pushPrefix

@NotNull
public T pushPrefix()

Specified by:

pushPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

removeIndentOnFirstEOL

@NotNull
public T removeIndentOnFirstEOL(@NotNull
                                         @NotNull Runnable listener)

Specified by:

removeIndentOnFirstEOL in interface com.vladsch.flexmark.util.sequence.LineAppendable

append

@NotNull
public T append(char c,
                         int count)

Specified by:

append in interface com.vladsch.flexmark.util.sequence.LineAppendable

setIndentPrefix

@NotNull
public T setIndentPrefix(@Nullable
                                  @Nullable CharSequence prefix)

Specified by:

setIndentPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

setOptions

@NotNull
public T setOptions(int flags)

Specified by:

setOptions in interface com.vladsch.flexmark.util.sequence.LineAppendable

setPrefix

@NotNull
public T setPrefix(@NotNull
                            @NotNull CharSequence prefix)

Specified by:

setPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

setPrefix

@NotNull
public T setPrefix(@Nullable
                            @Nullable CharSequence prefix,
                            boolean afterEol)

Specified by:

setPrefix in interface com.vladsch.flexmark.util.sequence.LineAppendable

unIndent

@NotNull
public T unIndent()

Specified by:

unIndent in interface com.vladsch.flexmark.util.sequence.LineAppendable

unIndentNoEol

@NotNull
public T unIndentNoEol()

Specified by:

unIndentNoEol in interface com.vladsch.flexmark.util.sequence.LineAppendable