com.vladsch.flexmark.formatter

Class MarkdownWriter

java.lang.Object

com.vladsch.flexmark.formatter.MarkdownWriter

All Implemented Interfaces:

com.vladsch.flexmark.util.html.LineFormattingAppendable, Appendable

public class MarkdownWriter
extends Object
implements com.vladsch.flexmark.util.html.LineFormattingAppendable

Field Summary

Fields inherited from interface com.vladsch.flexmark.util.html.LineFormattingAppendable

ALLOW_LEADING_EOL, ALLOW_LEADING_WHITESPACE, COLLAPSE_WHITESPACE, CONVERT_TABS, FORMAT_ALL, PASS_THROUGH, PREFIX_AFTER_PENDING_EOL, PREFIX_PRE_FORMATTED, SUPPRESS_TRAILING_WHITESPACE

Constructor Summary

Constructors

Constructor and Description
MarkdownWriter()
MarkdownWriter(int formatOptions)

Method Summary

Modifier and Type	Method and Description
MarkdownWriter	addIndentOnFirstEOL(Runnable runnable)
MarkdownWriter	addLine()
MarkdownWriter	addPrefix(CharSequence prefix)
MarkdownWriter	addPrefix(CharSequence prefix, boolean afterEol)
MarkdownWriter	append(char c)
MarkdownWriter	append(CharSequence csq)
MarkdownWriter	append(CharSequence csq, int start, int end)
MarkdownWriter	append(com.vladsch.flexmark.util.html.LineFormattingAppendable lineAppendable, int startLine, int endLine)
MarkdownWriter	appendNonTranslating(CharSequence csq)
MarkdownWriter	appendNonTranslating(CharSequence prefix, CharSequence csq)
MarkdownWriter	appendNonTranslating(CharSequence prefix, CharSequence csq, CharSequence suffix)
MarkdownWriter	appendNonTranslating(CharSequence prefix, CharSequence csq, CharSequence suffix, CharSequence suffix2)
MarkdownWriter	appendNonTranslating(CharSequence prefix, CharSequence csq, CharSequence suffix, CharSequence suffix2, Consumer<String> placeholderConsumer)
MarkdownWriter	appendTo(Appendable out, int maxBlankLines, CharSequence prefix, int startLine, int endLine)
MarkdownWriter	appendTranslating(CharSequence csq)
MarkdownWriter	appendTranslating(CharSequence prefix, CharSequence csq)
MarkdownWriter	appendTranslating(CharSequence prefix, CharSequence csq, CharSequence suffix)
MarkdownWriter	appendTranslating(CharSequence prefix, CharSequence csq, CharSequence suffix, CharSequence suffix2)
MarkdownWriter	blankLine()
MarkdownWriter	blankLine(int count)
MarkdownWriter	blankLineIf(boolean predicate)
MarkdownWriter	closePreFormatted()
int	column()
NodeFormatterContext	getContext()
CharSequence	getIndentPrefix()
List<CharSequence>	getLineContents(int startLine, int endLine)
int	getLineCount()
List<com.vladsch.flexmark.util.sequence.BasedSequence>	getLinePrefixes(int startLine, int endLine)
List<CharSequence>	getLines(int startLine, int endLine)
int	getOptions()
int	getPendingEOL()
int	getPendingSpace()
CharSequence	getPrefix()
MarkdownWriter	indent()
boolean	isLastBlockQuoteChild(com.vladsch.flexmark.util.ast.Node node)
boolean	isPendingSpace()
boolean	isPreFormatted()
boolean	isPreFormattedLine(int line)
MarkdownWriter	line()
MarkdownWriter	lineIf(boolean predicate)
MarkdownWriter	lineOnFirstText(boolean value)
MarkdownWriter	lineWithTrailingSpaces(int count)
int	offset()
int	offsetWithPending()
MarkdownWriter	openPreFormatted(boolean keepIndent)
MarkdownWriter	popPrefix()
MarkdownWriter	popPrefix(boolean afterEol)
MarkdownWriter	prefixLines(CharSequence prefix, boolean addAfterLinePrefix, int startLine, int endLine)
MarkdownWriter	pushPrefix()
MarkdownWriter	removeIndentOnFirstEOL(Runnable runnable)
MarkdownWriter	removeLines(int startLine, int endLine)
MarkdownWriter	repeat(char c, int count)
MarkdownWriter	repeat(CharSequence csq, int count)
MarkdownWriter	repeat(CharSequence csq, int start, int end, int count)
void	setContext(NodeFormatterContext context)
MarkdownWriter	setIndentPrefix(CharSequence prefix)
MarkdownWriter	setOptions(int options)
MarkdownWriter	setPrefix(CharSequence prefix)
MarkdownWriter	setPrefix(CharSequence prefix, boolean afterEol)
MarkdownWriter	tailBlankLine()
MarkdownWriter	tailBlankLine(int count)
int	textOnlyOffset()
int	textOnlyOffsetWithPending()
String	toString()
String	toString(int maxBlankLines)
MarkdownWriter	unIndent()
MarkdownWriter	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.html.LineFormattingAppendable

append, append, appendTo, appendTo, appendTo, appendTo, clearLineOnFirstText, getLineContent, getLineContents, getLineContents, getLinePrefix, getLinePrefixes, getLinePrefixes, getLines, getLines, lineWithTrailingSpaces, openPreFormatted, prefixLines, prefixLines, prefixLines, setLineOnFirstText

Constructor Detail

MarkdownWriter

public MarkdownWriter()

MarkdownWriter

public MarkdownWriter(int formatOptions)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setContext

public void setContext(NodeFormatterContext context)

getContext

public NodeFormatterContext getContext()

tailBlankLine

public MarkdownWriter tailBlankLine()

isLastBlockQuoteChild

public boolean isLastBlockQuoteChild(com.vladsch.flexmark.util.ast.Node node)

tailBlankLine

public MarkdownWriter tailBlankLine(int count)

appendNonTranslating

public MarkdownWriter appendNonTranslating(CharSequence csq)

appendNonTranslating

public MarkdownWriter appendNonTranslating(CharSequence prefix,
                                           CharSequence csq)

appendNonTranslating

public MarkdownWriter appendNonTranslating(CharSequence prefix,
                                           CharSequence csq,
                                           CharSequence suffix)

appendNonTranslating

public MarkdownWriter appendNonTranslating(CharSequence prefix,
                                           CharSequence csq,
                                           CharSequence suffix,
                                           CharSequence suffix2)

appendNonTranslating

public MarkdownWriter appendNonTranslating(CharSequence prefix,
                                           CharSequence csq,
                                           CharSequence suffix,
                                           CharSequence suffix2,
                                           Consumer<String> placeholderConsumer)

appendTranslating

public MarkdownWriter appendTranslating(CharSequence csq)

appendTranslating

public MarkdownWriter appendTranslating(CharSequence prefix,
                                        CharSequence csq)

appendTranslating

public MarkdownWriter appendTranslating(CharSequence prefix,
                                        CharSequence csq,
                                        CharSequence suffix)

appendTranslating

public MarkdownWriter appendTranslating(CharSequence prefix,
                                        CharSequence csq,
                                        CharSequence suffix,
                                        CharSequence suffix2)

isPendingSpace

public boolean isPendingSpace()

Specified by:

isPendingSpace in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

isPreFormatted

public boolean isPreFormatted()

Specified by:

isPreFormatted in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

isPreFormattedLine

public boolean isPreFormattedLine(int line)

Specified by:

isPreFormattedLine in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getIndentPrefix

public CharSequence getIndentPrefix()

Specified by:

getIndentPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getPrefix

public CharSequence getPrefix()

Specified by:

getPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

column

public int column()

Specified by:

column in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getLineCount

public int getLineCount()

Specified by:

getLineCount in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getOptions

public int getOptions()

Specified by:

getOptions in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getPendingEOL

public int getPendingEOL()

Specified by:

getPendingEOL in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getPendingSpace

public int getPendingSpace()

Specified by:

getPendingSpace in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

offset

public int offset()

Specified by:

offset in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

offsetWithPending

public int offsetWithPending()

Specified by:

offsetWithPending in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

textOnlyOffset

public int textOnlyOffset()

Specified by:

textOnlyOffset in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

textOnlyOffsetWithPending

public int textOnlyOffsetWithPending()

Specified by:

textOnlyOffsetWithPending in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getLinePrefixes

public List<com.vladsch.flexmark.util.sequence.BasedSequence> getLinePrefixes(int startLine,
                                                                              int endLine)

Specified by:

getLinePrefixes in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getLineContents

public List<CharSequence> getLineContents(int startLine,
                                          int endLine)

Specified by:

getLineContents in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

getLines

public List<CharSequence> getLines(int startLine,
                                   int endLine)

Specified by:

getLines in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

addIndentOnFirstEOL

public MarkdownWriter addIndentOnFirstEOL(Runnable runnable)

Specified by:

addIndentOnFirstEOL in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

addLine

public MarkdownWriter addLine()

Specified by:

addLine in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

addPrefix

public MarkdownWriter addPrefix(CharSequence prefix)

Specified by:

addPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

addPrefix

public MarkdownWriter addPrefix(CharSequence prefix,
                                boolean afterEol)

Specified by:

addPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

append

public MarkdownWriter append(char c)

Specified by:

append in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

Specified by:

append in interface Appendable

append

public MarkdownWriter append(CharSequence csq)

Specified by:

append in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

Specified by:

append in interface Appendable

append

public MarkdownWriter append(CharSequence csq,
                             int start,
                             int end)

Specified by:

append in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

Specified by:

append in interface Appendable

append

public MarkdownWriter append(com.vladsch.flexmark.util.html.LineFormattingAppendable lineAppendable,
                             int startLine,
                             int endLine)

Specified by:

append in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

appendTo

public MarkdownWriter appendTo(Appendable out,
                               int maxBlankLines,
                               CharSequence prefix,
                               int startLine,
                               int endLine)
                        throws IOException

Specified by:

appendTo in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

Throws:

IOException

blankLine

public MarkdownWriter blankLine()

Specified by:

blankLine in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

blankLine

public MarkdownWriter blankLine(int count)

Specified by:

blankLine in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

blankLineIf

public MarkdownWriter blankLineIf(boolean predicate)

Specified by:

blankLineIf in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

closePreFormatted

public MarkdownWriter closePreFormatted()

Specified by:

closePreFormatted in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

indent

public MarkdownWriter indent()

Specified by:

indent in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

line

public MarkdownWriter line()

Specified by:

line in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

lineIf

public MarkdownWriter lineIf(boolean predicate)

Specified by:

lineIf in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

lineOnFirstText

public MarkdownWriter lineOnFirstText(boolean value)

Specified by:

lineOnFirstText in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

lineWithTrailingSpaces

public MarkdownWriter lineWithTrailingSpaces(int count)

Specified by:

lineWithTrailingSpaces in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

openPreFormatted

public MarkdownWriter openPreFormatted(boolean keepIndent)

Specified by:

openPreFormatted in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

popPrefix

public MarkdownWriter popPrefix()

Specified by:

popPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

popPrefix

public MarkdownWriter popPrefix(boolean afterEol)

Specified by:

popPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

prefixLines

public MarkdownWriter prefixLines(CharSequence prefix,
                                  boolean addAfterLinePrefix,
                                  int startLine,
                                  int endLine)

Specified by:

prefixLines in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

pushPrefix

public MarkdownWriter pushPrefix()

Specified by:

pushPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

removeIndentOnFirstEOL

public MarkdownWriter removeIndentOnFirstEOL(Runnable runnable)

Specified by:

removeIndentOnFirstEOL in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

removeLines

public MarkdownWriter removeLines(int startLine,
                                  int endLine)

Specified by:

removeLines in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

repeat

public MarkdownWriter repeat(char c,
                             int count)

Specified by:

repeat in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

repeat

public MarkdownWriter repeat(CharSequence csq,
                             int count)

Specified by:

repeat in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

repeat

public MarkdownWriter repeat(CharSequence csq,
                             int start,
                             int end,
                             int count)

Specified by:

repeat in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

setIndentPrefix

public MarkdownWriter setIndentPrefix(CharSequence prefix)

Specified by:

setIndentPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

setOptions

public MarkdownWriter setOptions(int options)

Specified by:

setOptions in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

setPrefix

public MarkdownWriter setPrefix(CharSequence prefix)

Specified by:

setPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

setPrefix

public MarkdownWriter setPrefix(CharSequence prefix,
                                boolean afterEol)

Specified by:

setPrefix in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

unIndent

public MarkdownWriter unIndent()

Specified by:

unIndent in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

unIndentNoEol

public MarkdownWriter unIndentNoEol()

Specified by:

unIndentNoEol in interface com.vladsch.flexmark.util.html.LineFormattingAppendable

toString

public String toString(int maxBlankLines)

Specified by:

toString in interface com.vladsch.flexmark.util.html.LineFormattingAppendable