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.AbstractXmlSink
org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
org.apache.maven.doxia.module.markdown.MarkdownSink
- All Implemented Interfaces:
AutoCloseable,HtmlMarkup,Markup,TextMarkup,XmlMarkup,MarkdownMarkup,Sink
Markdown generator implementation.
Note: The encoding used is UTF-8. Extends the Xhtml5 sink as in some context HTML needs to be emitted.
Note: The encoding used is UTF-8. Extends the Xhtml5 sink as in some context HTML needs to be emitted.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Xhtml5BaseSink.VerbatimMode -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Queue<org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext> The context of the surrounding elements as stack (LIFO)Keep track of end markup for inline events.Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack, tableAttributesFields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ADDRESS, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BDI, BDO, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FOOTER, FORM, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, MENUITEM, META, METER, NAV, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRONG, STYLE, SUB, SUMMARY, SUP, SVG, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, U, UL, VAR, VIDEO, WBRFields 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, STRIKETHROUGH_END_MARKUP, STRIKETHROUGH_START_MARKUP, TABLE_CELL_SEPARATOR_MARKUP, TABLE_COL_CENTER_ALIGNED_MARKUP, TABLE_COL_DEFAULT_ALIGNED_MARKUP, TABLE_COL_LEFT_ALIGNED_MARKUP, TABLE_COL_RIGHT_ALIGNED_MARKUP, TABLE_ROW_PREFIX, VERBATIM_END_MARKUP, VERBATIM_START_MARKUPFields 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, STARFields inherited from interface org.apache.maven.doxia.sink.Sink
JUSTIFY_CENTER, JUSTIFY_DEFAULT, 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_6Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPEFields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE -
Method Summary
Modifier and TypeMethodDescriptionvoidanchor(String name, SinkEventAttributes attributes) voidanchor_()voidauthor_()voidblockquote(SinkEventAttributes attributes) voidvoidbody(SinkEventAttributes attributes) voidbody_()voidbold()voidbold_()voidclose()voiddate_()voiddefinedTerm(SinkEventAttributes attributes) voidvoiddefinition(SinkEventAttributes attributes) voidvoiddefinitionList(SinkEventAttributes attributes) voidvoidfigure(SinkEventAttributes attributes) voidfigure_()voidfigureCaption(SinkEventAttributes attributes) voidvoidfigureGraphics(String name, SinkEventAttributes attributes) voidhead(SinkEventAttributes attributes) voidhead_()voidheader(SinkEventAttributes attributes) voidheader_()voidhorizontalRule(SinkEventAttributes attributes) protected voidinit()voidinline(SinkEventAttributes attributes) voidinline_()voiditalic()voiditalic_()voidlineBreak(SinkEventAttributes attributes) voidlink(String name, SinkEventAttributes attributes) voidlink_()voidlist(SinkEventAttributes attributes) voidlist_()voidlistItem(SinkEventAttributes attributes) voidvoidmarkupLineBreak(int indentLevel) voidvoidprotected static MarkdownSinknewInstance(Writer writer) voidvoidnumberedList(int numbering, SinkEventAttributes attributes) voidvoidnumberedListItem(SinkEventAttributes attributes) voidvoidvoidparagraph(SinkEventAttributes attributes) voidvoidvoidsection(int level, SinkEventAttributes attributes) voidsection_(int level) voidsectionTitle(int level, SinkEventAttributes attributes) voidsectionTitle_(int level) voidtable(SinkEventAttributes attributes) voidtable_()voidtableCaption(SinkEventAttributes attributes) voidvoidtableCell(SinkEventAttributes attributes) voidvoidtableHeaderCell(SinkEventAttributes attributes) voidvoidtableRow(SinkEventAttributes attributes) voidvoidtableRows(int[] justification, boolean grid) voidvoidtext(String text, SinkEventAttributes attributes) voidtitle_()voidunknown(String name, Object[] requiredParams, SinkEventAttributes attributes) Unknown events just log a warning message but are ignored otherwise.voidverbatim(SinkEventAttributes attributes) voidMethods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address, address_, article, article_, comment, content, content, content_, convertAndFilterAttributes, convertToHtml5CompliantAttributes, data, data_, division, division_, encodeAsHtmlComment, encodeURL, escapeHTML, flush, footer, footer_, getCellCount, getCellJustif, getTextBuffer, getVerbatimMode, isHeadFlag, isVerbatim, lineBreakOpportunity, navigation, navigation_, onSection, onSection_, onSectionTitle, onSectionTitle_, resetTextBuffer, setCellCount, setCellJustif, setHeadFlag, setVerbatimMode, sidebar, sidebar_, time, time_, verbatimContent, write, writeEndTag, writeStartTagMethods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTagMethods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
author, date, definitionListItem, definitionListItem_, titleMethods 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
-
Field Details
-
inlineStack
Keep track of end markup for inline events. Special valueUSE_XHTML_SINKis used to indicate usage of the Xhtml5BaseSink.inline_() -
elementContextStack
protected Queue<org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext> elementContextStackThe context of the surrounding elements as stack (LIFO)
-
-
Method Details
-
newInstance
-
init
- Overrides:
initin classXhtml5BaseSink
-
head
- Specified by:
headin interfaceSink- Overrides:
headin classSinkAdapter
-
head_
- Specified by:
head_in interfaceSink- Overrides:
head_in classSinkAdapter
-
body
- Specified by:
bodyin interfaceSink- Overrides:
bodyin classSinkAdapter
-
body_
- Specified by:
body_in interfaceSink- Overrides:
body_in classSinkAdapter
-
title_
- Specified by:
title_in interfaceSink- Overrides:
title_in classSinkAdapter
-
author_
- Specified by:
author_in interfaceSink- Overrides:
author_in classSinkAdapter
-
date_
- Specified by:
date_in interfaceSink- Overrides:
date_in classSinkAdapter
-
section
- Specified by:
sectionin interfaceSink- Overrides:
sectionin classXhtml5BaseSink
-
section_
- Specified by:
section_in interfaceSink- Overrides:
section_in classXhtml5BaseSink
-
header
- Specified by:
headerin interfaceSink- Overrides:
headerin classXhtml5BaseSink
-
header_
- Specified by:
header_in interfaceSink- Overrides:
header_in classXhtml5BaseSink
-
sectionTitle
- Specified by:
sectionTitlein interfaceSink- Overrides:
sectionTitlein classXhtml5BaseSink
-
sectionTitle_
- Specified by:
sectionTitle_in interfaceSink- Overrides:
sectionTitle_in classXhtml5BaseSink
-
list
- Specified by:
listin interfaceSink- Overrides:
listin classXhtml5BaseSink
-
list_
- Specified by:
list_in interfaceSink- Overrides:
list_in classXhtml5BaseSink
-
listItem
- Specified by:
listItemin interfaceSink- Overrides:
listItemin classXhtml5BaseSink
-
listItem_
- Specified by:
listItem_in interfaceSink- Overrides:
listItem_in classXhtml5BaseSink
-
numberedList
- Specified by:
numberedListin interfaceSink- Overrides:
numberedListin classXhtml5BaseSink
-
numberedList_
- Specified by:
numberedList_in interfaceSink- Overrides:
numberedList_in classXhtml5BaseSink
-
numberedListItem
- Specified by:
numberedListItemin interfaceSink- Overrides:
numberedListItemin classXhtml5BaseSink
-
numberedListItem_
- Specified by:
numberedListItem_in interfaceSink- Overrides:
numberedListItem_in classXhtml5BaseSink
-
definitionList
- Specified by:
definitionListin interfaceSink- Overrides:
definitionListin classXhtml5BaseSink
-
definitionList_
- Specified by:
definitionList_in interfaceSink- Overrides:
definitionList_in classXhtml5BaseSink
-
definedTerm
- Specified by:
definedTermin interfaceSink- Overrides:
definedTermin classXhtml5BaseSink
-
definedTerm_
- Specified by:
definedTerm_in interfaceSink- Overrides:
definedTerm_in classXhtml5BaseSink
-
definition
- Specified by:
definitionin interfaceSink- Overrides:
definitionin classXhtml5BaseSink
-
definition_
- Specified by:
definition_in interfaceSink- Overrides:
definition_in classXhtml5BaseSink
-
pageBreak
- Specified by:
pageBreakin interfaceSink- Overrides:
pageBreakin classXhtml5BaseSink
-
paragraph
- Specified by:
paragraphin interfaceSink- Overrides:
paragraphin classXhtml5BaseSink
-
paragraph_
- Specified by:
paragraph_in interfaceSink- Overrides:
paragraph_in classXhtml5BaseSink
-
verbatim
- Specified by:
verbatimin interfaceSink- Overrides:
verbatimin classXhtml5BaseSink
-
verbatim_
- Specified by:
verbatim_in interfaceSink- Overrides:
verbatim_in classXhtml5BaseSink
-
blockquote
- Specified by:
blockquotein interfaceSink- Overrides:
blockquotein classXhtml5BaseSink
-
blockquote_
- Specified by:
blockquote_in interfaceSink- Overrides:
blockquote_in classXhtml5BaseSink
-
horizontalRule
- Specified by:
horizontalRulein interfaceSink- Overrides:
horizontalRulein classXhtml5BaseSink
-
table
- Specified by:
tablein interfaceSink- Overrides:
tablein classXhtml5BaseSink
-
table_
- Specified by:
table_in interfaceSink- Overrides:
table_in classXhtml5BaseSink
-
tableRows
- Specified by:
tableRowsin interfaceSink- Overrides:
tableRowsin classXhtml5BaseSink
-
tableRows_
- Specified by:
tableRows_in interfaceSink- Overrides:
tableRows_in classXhtml5BaseSink
-
tableRow
- Specified by:
tableRowin interfaceSink- Overrides:
tableRowin classXhtml5BaseSink
-
tableRow_
- Specified by:
tableRow_in interfaceSink- Overrides:
tableRow_in classXhtml5BaseSink
-
tableCell
- Specified by:
tableCellin interfaceSink- Overrides:
tableCellin classXhtml5BaseSink
-
tableHeaderCell
- Specified by:
tableHeaderCellin interfaceSink- Overrides:
tableHeaderCellin classXhtml5BaseSink
-
tableCell_
- Specified by:
tableCell_in interfaceSink- Overrides:
tableCell_in classXhtml5BaseSink
-
tableHeaderCell_
- Specified by:
tableHeaderCell_in interfaceSink- Overrides:
tableHeaderCell_in classXhtml5BaseSink
-
tableCaption
- Specified by:
tableCaptionin interfaceSink- Overrides:
tableCaptionin classXhtml5BaseSink
-
tableCaption_
- Specified by:
tableCaption_in interfaceSink- Overrides:
tableCaption_in classXhtml5BaseSink
-
figure
- Specified by:
figurein interfaceSink- Overrides:
figurein classXhtml5BaseSink
-
figureCaption
- Specified by:
figureCaptionin interfaceSink- Overrides:
figureCaptionin classXhtml5BaseSink
-
figureCaption_
- Specified by:
figureCaption_in interfaceSink- Overrides:
figureCaption_in classXhtml5BaseSink
-
figureGraphics
- Specified by:
figureGraphicsin interfaceSink- Overrides:
figureGraphicsin classXhtml5BaseSink
-
figure_
- Specified by:
figure_in interfaceSink- Overrides:
figure_in classXhtml5BaseSink
-
anchor
- Specified by:
anchorin interfaceSink- Overrides:
anchorin classXhtml5BaseSink
-
anchor_
- Specified by:
anchor_in interfaceSink- Overrides:
anchor_in classXhtml5BaseSink
-
link
- Specified by:
linkin interfaceSink- Overrides:
linkin classXhtml5BaseSink
-
link_
- Specified by:
link_in interfaceSink- Overrides:
link_in classXhtml5BaseSink
-
inline
- Specified by:
inlinein interfaceSink- Overrides:
inlinein classXhtml5BaseSink
-
inline_
- Specified by:
inline_in interfaceSink- Overrides:
inline_in classXhtml5BaseSink
-
italic
- Specified by:
italicin interfaceSink- Overrides:
italicin classXhtml5BaseSink
-
italic_
- Specified by:
italic_in interfaceSink- Overrides:
italic_in classXhtml5BaseSink
-
bold
- Specified by:
boldin interfaceSink- Overrides:
boldin classXhtml5BaseSink
-
bold_
- Specified by:
bold_in interfaceSink- Overrides:
bold_in classXhtml5BaseSink
-
monospaced
- Specified by:
monospacedin interfaceSink- Overrides:
monospacedin classXhtml5BaseSink
-
monospaced_
- Specified by:
monospaced_in interfaceSink- Overrides:
monospaced_in classXhtml5BaseSink
-
lineBreak
- Specified by:
lineBreakin interfaceSink- Overrides:
lineBreakin classXhtml5BaseSink
-
nonBreakingSpace
- Specified by:
nonBreakingSpacein interfaceSink- Overrides:
nonBreakingSpacein classXhtml5BaseSink
-
text
- Specified by:
textin interfaceSink- Overrides:
textin classXhtml5BaseSink
-
rawText
- Specified by:
rawTextin interfaceSink- Overrides:
rawTextin classXhtml5BaseSink
-
unknown
Unknown events just log a warning message but are ignored otherwise.- Specified by:
unknownin interfaceSink- Overrides:
unknownin classXhtml5BaseSink- See Also:
-
markupLineBreak
- Specified by:
markupLineBreakin interfaceSink- Overrides:
markupLineBreakin classXhtml5BaseSink
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceSink- Overrides:
closein classXhtml5BaseSink
-