OpenJDK 27 · jdk.internal.org.commonmark.renderer.markdown.MarkdownWriter

Modifier and Type	Field and Description
private boolean	atLineStart
private int	blockSeparator
private final Appendable	buffer
private char	lastChar
private final LinkedList<String>	prefixes
private final LinkedList<CharMatcher>	rawEscapes
private final LinkedList<Boolean>	tight

Access	Constructor and Description
public	MarkdownWriter(Appendable out)

Method Summary

Modifier and Type	Method and Description
private void	append(char c, CharMatcher escape)
public void	block() Enqueue a block separator to be written before the next text is written.
private void	flushBlockSeparator() If a block separator has been enqueued with `block()` but not yet written, write it now.
public char	getLastChar() Returns: the last character that was written
public boolean	isAtLineStart() Returns: whether we're at the line start (not counting any prefixes), i.e. after a `line` or `block`.
private boolean	isTight()
public void	line() Write a newline (line terminator).
private boolean	needsEscaping(char c, CharMatcher escape)
public void	popPrefix() Remove the last prefix from the top of the stack.
public void	popRawEscape() Remove the last raw escape from the top of the stack.
public void	popTight() Remove the last "tight" setting from the top of the stack.
public void	pushPrefix(String the raw prefix string prefix) Push a prefix onto the top of the stack.
public void	pushRawEscape(CharMatcher the characters to escape in raw text rawEscape) Escape the characters matching the supplied matcher, in all text (text and raw).
public void	pushTight(boolean tight) Change whether blocks are tight or loose.
public void	raw(String s) Write the supplied string (raw/unescaped except if `pushRawEscape` was used).
public void	raw(char c) Write the supplied character (raw/unescaped except if `pushRawEscape` was used).
private boolean	rawNeedsEscaping(char c)
public void	text(String the string to write s, CharMatcher which characters to escape escape) Write the supplied string with escaping.
private void	write(String s, CharMatcher escape)
private void	write(char c)
public void	writePrefix(String the raw prefix string to write prefix) Write a prefix.
private void	writePrefixes()

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

atLineStart	back to summary
private boolean atLineStart

blockSeparator	back to summary
private int blockSeparator

buffer	back to summary
private final Appendable buffer

lastChar	back to summary
private char lastChar

prefixes	back to summary
private final LinkedList<String> prefixes

rawEscapes	back to summary
private final LinkedList<CharMatcher> rawEscapes

tight	back to summary
private final LinkedList<Boolean> tight

MarkdownWriter	back to summary
public MarkdownWriter(Appendable out)

Method Detail

append	back to summary
private void append(char c, CharMatcher escape) throws IOException

block	back to summary
public void block() Enqueue a block separator to be written before the next text is written. Block separators are not written straight away because if there are no more blocks to write we don't want a separator (at the end of the document).

flushBlockSeparator	back to summary
private void flushBlockSeparator() If a block separator has been enqueued with `block()` but not yet written, write it now.

getLastChar	back to summary
public char getLastChar() Returns:char the last character that was written

isAtLineStart	back to summary
public boolean isAtLineStart() Returns:boolean whether we're at the line start (not counting any prefixes), i.e. after a `line` or `block`.

isTight	back to summary
private boolean isTight()

line	back to summary
public void line() Write a newline (line terminator).

needsEscaping	back to summary
private boolean needsEscaping(char c, CharMatcher escape)

popPrefix	back to summary
public void popPrefix() Remove the last prefix from the top of the stack.

popRawEscape	back to summary
public void popRawEscape() Remove the last raw escape from the top of the stack.

popTight	back to summary
public void popTight() Remove the last "tight" setting from the top of the stack.

pushPrefix	back to summary
public void pushPrefix(String prefix) Push a prefix onto the top of the stack. All prefixes are written at the beginning of each line, until the prefix is popped again. Parameters prefix:String the raw prefix string

pushPrefix

back to summary

public void pushPrefix(String prefix)

Push a prefix onto the top of the stack. All prefixes are written at the beginning of each line, until the prefix is popped again.

Parameters

prefix:String: the raw prefix string

pushRawEscape	back to summary
public void pushRawEscape(CharMatcher rawEscape) Escape the characters matching the supplied matcher, in all text (text and raw). This might be useful to extensions that add another layer of syntax, e.g. the tables extension that uses `\|` to separate cells and needs all `\|` characters to be escaped (even in code spans). Parameters rawEscape:CharMatcher the characters to escape in raw text

pushRawEscape

back to summary

public void pushRawEscape(CharMatcher rawEscape)

Escape the characters matching the supplied matcher, in all text (text and raw). This might be useful to extensions that add another layer of syntax, e.g. the tables extension that uses `|` to separate cells and needs all `|` characters to be escaped (even in code spans).

Parameters

rawEscape:CharMatcher: the characters to escape in raw text

pushTight back to summary

pushTight	back to summary
public void pushTight(boolean tight) Change whether blocks are tight or loose. Loose is the default where blocks are separated by a blank line. Tight is where blocks are not separated by a blank line. Tight blocks are used in lists, if there are no blank lines within the list. Note that changing this does not affect block separators that have already been enqueued with `block()`, only future ones.

public void pushTight(boolean tight)

Change whether blocks are tight or loose. Loose is the default where blocks are separated by a blank line. Tight is where blocks are not separated by a blank line. Tight blocks are used in lists, if there are no blank lines within the list.

Note that changing this does not affect block separators that have already been enqueued with block(), only future ones.

raw	back to summary
public void raw(String s) Write the supplied string (raw/unescaped except if `pushRawEscape` was used).

raw	back to summary
public void raw(char c) Write the supplied character (raw/unescaped except if `pushRawEscape` was used).

rawNeedsEscaping	back to summary
private boolean rawNeedsEscaping(char c)

text	back to summary
public void text(String s, CharMatcher escape) Write the supplied string with escaping. Parameters s:String the string to write escape:CharMatcher which characters to escape

text

back to summary

public void text(String s, CharMatcher escape)

Write the supplied string with escaping.

Parameters

s:String: the string to write
escape:CharMatcher: which characters to escape

write	back to summary
private void write(String s, CharMatcher escape)

write	back to summary
private void write(char c)

writePrefix	back to summary
public void writePrefix(String prefix) Write a prefix. Parameters prefix:String the raw prefix string to write

writePrefix

back to summary

public void writePrefix(String prefix)

Write a prefix.

Parameters

prefix:String: the raw prefix string to write

writePrefixes	back to summary
private void writePrefixes()

public Class MarkdownWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail