com.vladsch.flexmark.util.format

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

java.lang.Object

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

All Implemented Interfaces:

LineFormattingAppendable, Appendable

public abstract class MarkdownWriterBase<M extends MarkdownWriterBase<M,N,C>,N,C extends NodeContext<N,C>>
extends Object
implements LineFormattingAppendable

Field Summary

Fields

Modifier and Type	Field and Description
protected C	context
protected LineFormattingAppendable	myAppendable

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
MarkdownWriterBase()
MarkdownWriterBase(int formatOptions)

Method Summary

Modifier and Type	Method and Description
M	addIndentOnFirstEOL(Runnable runnable)
M	addLine() Add a new line or blank lines as needed.
M	addPrefix(CharSequence prefix) Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections
M	addPrefix(CharSequence prefix, boolean afterEol) Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections
M	append(char c)
M	append(CharSequence csq)
M	append(CharSequence csq, int start, int end)
M	append(LineFormattingAppendable lineAppendable, int startLine, int endLine) Append lines with given prefix
M	appendTo(Appendable out, int maxBlankLines, CharSequence prefix, int startLine, int endLine) append lines to appendable with given maximum trailing blank lines and given prefix to add to all lines
M	blankLine() Add a blank line, if there is not one already appended.
M	blankLine(int count) Add a blank lines, if there isn't already given number of blank lines appended.
M	blankLineIf(boolean predicate) Add a blank line, if predicate is true and there isn't already blank lines appended.
M	closePreFormatted() Close preformatted section and suspend content modification
int	column() Get column offset after last append
C	getContext()
CharSequence	getIndentPrefix() Get prefix appended after a new line character for every indent level
List<CharSequence>	getLineContents(int startLine, int endLine) Get Lines without prefixes or EOL
int	getLineCount() Get the number of lines appended, does not include pending: EOLs
List<BasedSequence>	getLinePrefixes(int startLine, int endLine) Get Line prefixes
List<CharSequence>	getLines(int startLine, int endLine) Get Lines without EOL
int	getOptions() Get current options
int	getPendingEOL() Get number of EOLs at end of text (including pending text)
int	getPendingSpace() Get trailing spaces or tabs of trailing text
CharSequence	getPrefix() Get prefix being applied to all lines, even in pre-formatted sections
M	indent() Increase the indent level, will terminate the current line if there is unterminated text
abstract boolean	isLastBlockQuoteChild()
boolean	isPendingSpace() Test if trailing text ends in space or tab
boolean	isPreFormatted()
boolean	isPreFormattedLine(int line) Test if given line is part of pre-formatted text
M	line() Add a new line, if there was any unterminated text appended
M	lineIf(boolean predicate) Add a new line, if predicate is true and there was any unterminated text appended
M	lineOnFirstText(boolean value)
M	lineWithTrailingSpaces(int count) Add a new line, keep trailing spaces if there was any unterminated text appended
int	offset() Get text offset of all output lines (not including any text not included because it is not yet terminated by line() call) NOTE: this includes prefixes
int	offsetWithPending() Get column offset after last append NOTE: this includes prefixes
M	openPreFormatted(boolean keepIndent) Open preformatted section and suspend content modification
M	popPrefix() Pop a prefix from the stack and set the current prefix
M	popPrefix(boolean afterEol) Pop a prefix from the stack and set the current prefix
M	prefixLines(CharSequence prefix, boolean addAfterLinePrefix, int startLine, int endLine) Add prefix to selected lines either before the line prefix or after it
M	pushPrefix() Save the current prefix on the stack
M	removeIndentOnFirstEOL(Runnable runnable)
M	removeLines(int startLine, int endLine) Remove line range from result set
M	repeat(char c, int count)
M	repeat(CharSequence csq, int count)
M	repeat(CharSequence csq, int start, int end, int count)
void	setContext(C context)
M	setIndentPrefix(CharSequence prefix) Set prefix to append after a new line character for every indent level
M	setOptions(int options) Set options on processing text
M	setPrefix(CharSequence prefix) Set prefix appended after a new line character for every line and after a new line in pre-formatted sections
M	setPrefix(CharSequence prefix, boolean afterEol) Set prefix appended after a new line character for every line and after a new line in pre-formatted sections
M	tailBlankLine()
abstract M	tailBlankLine(int count)
int	textOnlyOffset() Get text offset of all output lines (not including any text not included because it is not yet terminated by line() call) NOTE: this does not include prefixes
int	textOnlyOffsetWithPending() Get column offset after last append NOTE: this does not include prefixes
String	toString()
String	toString(int maxBlankLines) get the resulting text for all lines
M	unIndent() Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text
M	unIndentNoEol() Decrease the indent level, if there is unterminated text then unindented prefix is to be applied after the next EOL.

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

Field Detail

myAppendable

protected final LineFormattingAppendable myAppendable

context

protected C extends NodeContext<N,C> context

Constructor Detail

MarkdownWriterBase

public MarkdownWriterBase()

MarkdownWriterBase

public MarkdownWriterBase(int formatOptions)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setContext

public void setContext(C context)

getContext

public C getContext()

tailBlankLine

public M tailBlankLine()

isLastBlockQuoteChild

public abstract boolean isLastBlockQuoteChild()

tailBlankLine

public abstract M tailBlankLine(int count)

isPendingSpace

public boolean isPendingSpace()

Description copied from interface: LineFormattingAppendable

Test if trailing text ends in space or tab

Specified by:

isPendingSpace in interface LineFormattingAppendable

Returns:

true if ending in space or tab

isPreFormatted

public boolean isPreFormatted()

Specified by:

isPreFormatted in interface LineFormattingAppendable

Returns:

true if in pre-formatted region

isPreFormattedLine

public boolean isPreFormattedLine(int line)

Description copied from interface: LineFormattingAppendable

Test if given line is part of pre-formatted text

Specified by:

isPreFormattedLine in interface LineFormattingAppendable

Parameters:

line - line

Returns:

true if line is inside pre-formatted text

getIndentPrefix

public CharSequence getIndentPrefix()

Description copied from interface: LineFormattingAppendable

Get prefix appended after a new line character for every indent level

Specified by:

getIndentPrefix in interface LineFormattingAppendable

Returns:

char sequence of the current indent prefix used for each indent level

getPrefix

public CharSequence getPrefix()

Description copied from interface: LineFormattingAppendable

Get prefix being applied to all lines, even in pre-formatted sections

Specified by:

getPrefix in interface LineFormattingAppendable

Returns:

char sequence of the current prefix

column

public int column()

Description copied from interface: LineFormattingAppendable

Get column offset after last append

Specified by:

column in interface LineFormattingAppendable

Returns:

column offset after last append

getLineCount

public int getLineCount()

Description copied from interface: LineFormattingAppendable

Get the number of lines appended, does not include pending: EOLs

Specified by:

getLineCount in interface LineFormattingAppendable

Returns:

number of lines appended

getOptions

public int getOptions()

Description copied from interface: LineFormattingAppendable

Get current options

Specified by:

getOptions in interface LineFormattingAppendable

Returns:

option flags

getPendingEOL

public int getPendingEOL()

Description copied from interface: LineFormattingAppendable

Get number of EOLs at end of text (including pending text)

Specified by:

getPendingEOL in interface LineFormattingAppendable

Returns:

number of eols at end of text

getPendingSpace

public int getPendingSpace()

Description copied from interface: LineFormattingAppendable

Get trailing spaces or tabs of trailing text

Specified by:

getPendingSpace in interface LineFormattingAppendable

Returns:

trailing spaces or tabs

offset

public int offset()

Description copied from interface: LineFormattingAppendable

Get text offset of all output lines (not including any text not included because it is not yet terminated by line() call) NOTE: this includes prefixes

Specified by:

offset in interface LineFormattingAppendable

Returns:

offset of text as would be returned if all current lines were taken (without prefixes)

offsetWithPending

public int offsetWithPending()

Description copied from interface: LineFormattingAppendable

Get column offset after last append NOTE: this includes prefixes

Specified by:

offsetWithPending in interface LineFormattingAppendable

Returns:

offset as would be returned by LineFormattingAppendable.offset() after line() call less 1 for EOL

textOnlyOffset

public int textOnlyOffset()

Description copied from interface: LineFormattingAppendable

Get text offset of all output lines (not including any text not included because it is not yet terminated by line() call) NOTE: this does not include prefixes

Specified by:

textOnlyOffset in interface LineFormattingAppendable

Returns:

offset of text as would be returned if all current lines were taken (without prefixes)

textOnlyOffsetWithPending

public int textOnlyOffsetWithPending()

Description copied from interface: LineFormattingAppendable

Get column offset after last append NOTE: this does not include prefixes

Specified by:

textOnlyOffsetWithPending in interface LineFormattingAppendable

Returns:

offset as would be returned by LineFormattingAppendable.offset() after line() call less 1 for EOL

getLinePrefixes

public List<BasedSequence> getLinePrefixes(int startLine,
                                           int endLine)

Description copied from interface: LineFormattingAppendable

Get Line prefixes

Specified by:

getLinePrefixes in interface LineFormattingAppendable

Parameters:

startLine - starting line offset

endLine - end line offset

Returns:

list of lines

getLineContents

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

Description copied from interface: LineFormattingAppendable

Get Lines without prefixes or EOL

Specified by:

getLineContents in interface LineFormattingAppendable

Parameters:

startLine - starting line offset

endLine - end line offset

Returns:

list of lines

getLines

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

Description copied from interface: LineFormattingAppendable

Get Lines without EOL

Specified by:

getLines in interface LineFormattingAppendable

Parameters:

startLine - starting line offset

endLine - end line offset

Returns:

list of lines

addIndentOnFirstEOL

public M addIndentOnFirstEOL(Runnable runnable)

Specified by:

addIndentOnFirstEOL in interface LineFormattingAppendable

addLine

public M addLine()

Description copied from interface: LineFormattingAppendable

Add a new line or blank lines as needed.

Specified by:

addLine in interface LineFormattingAppendable

Returns:

this

addPrefix

public M addPrefix(CharSequence prefix)

Description copied from interface: LineFormattingAppendable

Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

addPrefix in interface LineFormattingAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

Returns:

this

addPrefix

public M addPrefix(CharSequence prefix,
                   boolean afterEol)

Description copied from interface: LineFormattingAppendable

Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

addPrefix in interface LineFormattingAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

afterEol - if true prefix will take effect after EOL

Returns:

this

append

public M append(char c)

Specified by:

append in interface LineFormattingAppendable

Specified by:

append in interface Appendable

append

public M append(CharSequence csq)

Specified by:

append in interface LineFormattingAppendable

Specified by:

append in interface Appendable

append

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

Specified by:

append in interface LineFormattingAppendable

Specified by:

append in interface Appendable

append

public M append(LineFormattingAppendable lineAppendable,
                int startLine,
                int endLine)

Description copied from interface: LineFormattingAppendable

Append lines with given prefix

Specified by:

append in interface LineFormattingAppendable

Parameters:

lineAppendable - lines to append

startLine - start line to append

endLine - end line to append

Returns:

this

appendTo

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

Description copied from interface: LineFormattingAppendable

append lines to appendable with given maximum trailing blank lines and given prefix to add to all lines

Specified by:

appendTo in interface LineFormattingAppendable

Parameters:

out - appendable to output the resulting lines

maxBlankLines - maximum blank lines to allow at end, if -1 then no trailing EOL will be generated

prefix - prefix to add before each line

startLine - line from which to start output

Returns:

this

Throws:

IOException - if thrown by appendable

blankLine

public M blankLine()

Description copied from interface: LineFormattingAppendable

Add a blank line, if there is not one already appended.

Specified by:

blankLine in interface LineFormattingAppendable

Returns:

this

blankLine

public M blankLine(int count)

Description copied from interface: LineFormattingAppendable

Add a blank lines, if there isn't already given number of blank lines appended. Will append only enough blank lines to increase it to given level. If more are already in the wings then nothing is done.

Specified by:

blankLine in interface LineFormattingAppendable

Parameters:

count - number of blank lines to append

Returns:

this

blankLineIf

public M blankLineIf(boolean predicate)

Description copied from interface: LineFormattingAppendable

Add a blank line, if predicate is true and there isn't already blank lines appended.

Specified by:

blankLineIf in interface LineFormattingAppendable

Parameters:

predicate - when true append blank line

Returns:

this

closePreFormatted

public M closePreFormatted()

Description copied from interface: LineFormattingAppendable

Close preformatted section and suspend content modification

Specified by:

closePreFormatted in interface LineFormattingAppendable

Returns:

this

indent

public M indent()

Description copied from interface: LineFormattingAppendable

Increase the indent level, will terminate the current line if there is unterminated text

NOTE: this is equivalent to pushPrefix(), addPrefix(getIndentPrefix()) but adds flag to validate that LineFormattingAppendable.unIndent() is called only on prefixes added by indent()

Specified by:

indent in interface LineFormattingAppendable

Returns:

this

line

public M line()

Description copied from interface: LineFormattingAppendable

Add a new line, if there was any unterminated text appended

Specified by:

line in interface LineFormattingAppendable

Returns:

this

lineIf

public M lineIf(boolean predicate)

Description copied from interface: LineFormattingAppendable

Add a new line, if predicate is true and there was any unterminated text appended

Specified by:

lineIf in interface LineFormattingAppendable

Parameters:

predicate - if true then new line will be started

Returns:

this

lineOnFirstText

public M lineOnFirstText(boolean value)

Specified by:

lineOnFirstText in interface LineFormattingAppendable

lineWithTrailingSpaces

public M lineWithTrailingSpaces(int count)

Description copied from interface: LineFormattingAppendable

Add a new line, keep trailing spaces if there was any unterminated text appended

Specified by:

lineWithTrailingSpaces in interface LineFormattingAppendable

Parameters:

count - number of trailing spaces to add

Returns:

this

openPreFormatted

public M openPreFormatted(boolean keepIndent)

Description copied from interface: LineFormattingAppendable

Open preformatted section and suspend content modification

Specified by:

openPreFormatted in interface LineFormattingAppendable

Parameters:

keepIndent - if true will add current prefix to first line

Returns:

this

popPrefix

public M popPrefix()

Description copied from interface: LineFormattingAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

popPrefix in interface LineFormattingAppendable

Returns:

this

popPrefix

public M popPrefix(boolean afterEol)

Description copied from interface: LineFormattingAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

popPrefix in interface LineFormattingAppendable

Parameters:

afterEol - if true prefix will take effect after EOL

Returns:

this

prefixLines

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

Description copied from interface: LineFormattingAppendable

Add prefix to selected lines either before the line prefix or after it

Specified by:

prefixLines in interface LineFormattingAppendable

Parameters:

prefix - prefix to add

addAfterLinePrefix - if true add given prefix after the line prefix

startLine - starting line offset

endLine - end line offset

Returns:

this

pushPrefix

public M pushPrefix()

Description copied from interface: LineFormattingAppendable

Save the current prefix on the stack

Specified by:

pushPrefix in interface LineFormattingAppendable

Returns:

this

removeIndentOnFirstEOL

public M removeIndentOnFirstEOL(Runnable runnable)

Specified by:

removeIndentOnFirstEOL in interface LineFormattingAppendable

removeLines

public M removeLines(int startLine,
                     int endLine)

Description copied from interface: LineFormattingAppendable

Remove line range from result set

Specified by:

removeLines in interface LineFormattingAppendable

Parameters:

startLine - starting line offset

endLine - end line offset

Returns:

this

repeat

public M repeat(char c,
                int count)

Specified by:

repeat in interface LineFormattingAppendable

repeat

public M repeat(CharSequence csq,
                int count)

Specified by:

repeat in interface LineFormattingAppendable

repeat

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

Specified by:

repeat in interface LineFormattingAppendable

setIndentPrefix

public M setIndentPrefix(CharSequence prefix)

Description copied from interface: LineFormattingAppendable

Set prefix to append after a new line character for every indent level

Specified by:

setIndentPrefix in interface LineFormattingAppendable

Parameters:

prefix - prefix characters for new lines appended after this is set

Returns:

this

setOptions

public M setOptions(int options)

Description copied from interface: LineFormattingAppendable

Set options on processing text

Specified by:

setOptions in interface LineFormattingAppendable

Parameters:

options - option flags

Returns:

this

setPrefix

public M setPrefix(CharSequence prefix)

Description copied from interface: LineFormattingAppendable

Set prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

setPrefix in interface LineFormattingAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

Returns:

this

setPrefix

public M setPrefix(CharSequence prefix,
                   boolean afterEol)

Description copied from interface: LineFormattingAppendable

Set prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

setPrefix in interface LineFormattingAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

afterEol - if true prefix will take effect after EOL

Returns:

this

unIndent

public M unIndent()

Description copied from interface: LineFormattingAppendable

Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text

NOTE: this is equivalent to popPrefix() but with validation that it is called only on prefixes added by LineFormattingAppendable.indent()

Specified by:

unIndent in interface LineFormattingAppendable

Returns:

this

unIndentNoEol

public M unIndentNoEol()

Description copied from interface: LineFormattingAppendable

Decrease the indent level, if there is unterminated text then unindented prefix is to be applied after the next EOL.

Will NOT terminate the current line if there is unterminated text

NOTE: should be used with LineFormattingAppendable.addIndentOnFirstEOL(Runnable) if callback is invoked

Specified by:

unIndentNoEol in interface LineFormattingAppendable

Returns:

this

toString

public String toString(int maxBlankLines)

Description copied from interface: LineFormattingAppendable

get the resulting text for all lines

Specified by:

toString in interface LineFormattingAppendable

Parameters:

maxBlankLines - maximum blank lines to allow at end, if -1 then no trailing EOL will be generated

Returns:

resulting text