org.apache.maven.doxia.module.markdown

Class MarkdownSink

java.lang.Object

org.apache.maven.doxia.sink.impl.AbstractSink

org.apache.maven.doxia.sink.impl.SinkAdapter

org.apache.maven.doxia.sink.impl.AbstractTextSink

org.apache.maven.doxia.module.markdown.MarkdownSink

All Implemented Interfaces:

AutoCloseable, Markup, TextMarkup, MarkdownMarkup, Sink

public class MarkdownSink
extends AbstractTextSink
implements MarkdownMarkup

Markdown generator implementation.
Note: The encoding used is UTF-8.

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext>	elementContextStack The context of the surrounding elements as stack (LIFO)
protected Queue<Queue<String>>	inlineStack Keep track of end markup for inline events.

Fields inherited from interface org.apache.maven.doxia.module.markdown.MarkdownMarkup

ANCHOR_END_MARKUP, ANCHOR_START_MARKUP, BACKSLASH, BLANK_LINE, BLOCKQUOTE_START_MARKUP, BOLD_END_MARKUP, BOLD_START_MARKUP, COMMENT_END, COMMENT_START, HORIZONTAL_RULE_MARKUP, INDENT, ITALIC_END_MARKUP, ITALIC_START_MARKUP, LINK_END_MARKUP, LINK_START_1_MARKUP, LINK_START_2_MARKUP, LIST_ORDERED_ITEM_START_MARKUP, LIST_UNORDERED_ITEM_START_MARKUP, METADATA_MARKUP, MONOSPACED_END_MARKUP, MONOSPACED_START_MARKUP, NON_BREAKING_SPACE_MARKUP, SECTION_TITLE_START_MARKUP, TABLE_CELL_SEPARATOR_MARKUP, TABLE_COL_CENTER_ALIGNED_MARKUP, TABLE_COL_LEFT_ALIGNED_MARKUP, TABLE_COL_RIGHT_ALIGNED_MARKUP, TABLE_ROW_PREFIX, VERBATIM_END_MARKUP, VERBATIM_START_MARKUP

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

Fields inherited from interface org.apache.maven.doxia.markup.Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Fields inherited from interface org.apache.maven.doxia.sink.Sink

JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MarkdownSink(Writer writer) Constructor, initialize the Writer and the variables.

Method Summary

Modifier and Type	Method and Description
void	anchor_()
void	anchor(String name, SinkEventAttributes attributes)
void	author_()
void	blockquote_()
void	blockquote(SinkEventAttributes attributes)
void	body_()
void	body(SinkEventAttributes attributes)
void	bold_()
void	bold()
void	close()
void	comment(String comment)
void	date_()
void	definedTerm_()
void	definedTerm(SinkEventAttributes attributes)
void	definition_()
void	definition(SinkEventAttributes attributes)
void	definitionList_()
void	definitionList(SinkEventAttributes attributes)
void	figure_()
void	figure(SinkEventAttributes attributes)
void	figureGraphics(String name, SinkEventAttributes attributes)
void	flush()
protected StringBuilder	getBuffer() Returns the buffer that holds the current text.
void	head_()
void	head(SinkEventAttributes attributes)
void	horizontalRule(SinkEventAttributes attributes)
protected void	init()
void	inline_()
void	inline(SinkEventAttributes attributes)
void	italic_()
void	italic()
void	lineBreak(SinkEventAttributes attributes)
void	link_()
void	link(String name, SinkEventAttributes attributes)
void	list_()
void	listItem_()
void	listItem(SinkEventAttributes attributes)
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering, SinkEventAttributes attributes)
void	numberedListItem_()
void	numberedListItem(SinkEventAttributes attributes)
void	pageBreak()
void	paragraph_()
void	paragraph(SinkEventAttributes attributes)
void	rawText(String text)
protected void	resetBuffer() Reset the StringBuilder.
void	sectionTitle_(int level)
void	sectionTitle(int level, SinkEventAttributes attributes)
void	table(SinkEventAttributes attributes)
void	tableCaption_()
void	tableCaption(SinkEventAttributes attributes)
void	tableCell_()
void	tableCell(SinkEventAttributes attributes)
void	tableHeaderCell_()
void	tableHeaderCell(SinkEventAttributes attributes)
void	tableRow_()
void	tableRow(SinkEventAttributes attributes)
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(String text, SinkEventAttributes attributes)
void	title_()
void	unknown(String name, Object[] requiredParams, SinkEventAttributes attributes) Unknown events just log a warning message but are ignored otherwise.
void	verbatim_()
void	verbatim(SinkEventAttributes attributes)
protected void	writeUnescaped(String text)

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter

address_, address, article_, article, author, content_, content, data_, data, date, definitionListItem_, definitionListItem, division_, division, figureCaption_, figureCaption, footer_, footer, header_, header, lineBreakOpportunity, list, navigation_, navigation, section_, section, sidebar_, sidebar, table_, time_, time, title

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

address, anchor, article, author, blockquote, body, content, data, date, definedTerm, definition, definitionList, definitionListItem, division, figure, figureCaption, figureGraphics, footer, formatLocation, getDocumentLocator, getLocationLogPrefix, head, header, horizontalRule, inline, lineBreak, lineBreakOpportunity, link, list, listItem, navigation, numberedList, numberedListItem, paragraph, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, section6_, section6, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, sectionTitle6_, sectionTitle6, setDocumentLocator, sidebar, table, tableCaption, tableCell, tableHeaderCell, tableRow, tableRows, text, time, title, unifyEOLs, verbatim

Methods inherited from class java.lang.Object

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

Field Detail

inlineStack

protected Queue<Queue<String>> inlineStack

Keep track of end markup for inline events.

elementContextStack

protected Queue<org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext> elementContextStack

The context of the surrounding elements as stack (LIFO)

Constructor Detail

MarkdownSink

protected MarkdownSink(Writer writer)

Constructor, initialize the Writer and the variables.

Parameters:

writer - not null writer to write the result. Should be an UTF-8 Writer.

Method Detail

getBuffer

protected StringBuilder getBuffer()

Returns the buffer that holds the current text.

Returns:

A StringBuffer.

init

protected void init()

Overrides:

init in class AbstractSink

resetBuffer

protected void resetBuffer()

Reset the StringBuilder.

head

public void head(SinkEventAttributes attributes)

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head_

public void head_()

Specified by:

head_ in interface Sink

Overrides:

head_ in class SinkAdapter

body

public void body(SinkEventAttributes attributes)

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body_

public void body_()

Specified by:

body_ in interface Sink

Overrides:

body_ in class SinkAdapter

title_

public void title_()

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author_

public void author_()

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date_

public void date_()

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

sectionTitle

public void sectionTitle(int level,
                         SinkEventAttributes attributes)

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_(int level)

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

list_

public void list_()

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem(SinkEventAttributes attributes)

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem_

public void listItem_()

Specified by:

listItem_ in interface Sink

Overrides:

listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface Sink

Overrides:

numberedListItem_ in class SinkAdapter

definitionList

public void definitionList(SinkEventAttributes attributes)

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm(SinkEventAttributes attributes)

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definition

public void definition(SinkEventAttributes attributes)

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition_

public void definition_()

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

paragraph

public void paragraph(SinkEventAttributes attributes)

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(SinkEventAttributes attributes)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

blockquote

public void blockquote(SinkEventAttributes attributes)

Specified by:

blockquote in interface Sink

Overrides:

blockquote in class SinkAdapter

blockquote_

public void blockquote_()

Specified by:

blockquote_ in interface Sink

Overrides:

blockquote_ in class SinkAdapter

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

table

public void table(SinkEventAttributes attributes)

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow(SinkEventAttributes attributes)

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell(SinkEventAttributes attributes)

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption(SinkEventAttributes attributes)

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

figure

public void figure(SinkEventAttributes attributes)

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

figureGraphics

public void figureGraphics(String name,
                           SinkEventAttributes attributes)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

figure_

public void figure_()

Specified by:

figure_ in interface Sink

Overrides:

figure_ in class SinkAdapter

anchor

public void anchor(String name,
                   SinkEventAttributes attributes)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor_

public void anchor_()

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(String name,
                 SinkEventAttributes attributes)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link_

public void link_()

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

inline

public void inline(SinkEventAttributes attributes)

Specified by:

inline in interface Sink

Overrides:

inline in class SinkAdapter

inline_

public void inline_()

Specified by:

inline_ in interface Sink

Overrides:

inline_ in class SinkAdapter

italic

public void italic()

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak(SinkEventAttributes attributes)

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(String text,
                 SinkEventAttributes attributes)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

rawText

public void rawText(String text)

Specified by:

rawText in interface Sink

Overrides:

rawText in class SinkAdapter

comment

public void comment(String comment)

Specified by:

comment in interface Sink

Overrides:

comment in class SinkAdapter

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Unknown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

See Also:

Sink.unknown(String,Object[],SinkEventAttributes)

writeUnescaped

protected void writeUnescaped(String text)

flush

public void flush()

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter