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

All Implemented Interfaces:: AutoCloseable, HtmlMarkup, Markup, TextMarkup, XmlMarkup, MarkdownMarkup, Sink

public class MarkdownSink extends Xhtml5BaseSink implements MarkdownMarkup

Markdown generator implementation.
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

Modifier and Type

Class

Description

(package private) static enum

MarkdownSink.ElementContext

Most important contextual metadata (of elements).

(package private) static interface

MarkdownSink.TextEscapeFunction

Nested classes/interfaces inherited from class Xhtml5BaseSink
Xhtml5BaseSink.VerbatimMode
Field Summary

Fields

Modifier and Type

Field

Description

private Collection<String>

authors

author.

private final BufferingStackWriter

bufferingStackWriter

The inner decorated writer to buffer the text of contexts requiring buffering.

private int

cellCount

number of cells in a table.

private List<Integer>

cellJustif

justification of table cells per column.

private String

date

date.

protected Queue<MarkdownSink.ElementContext>

elementContextStack

The context of the surrounding elements as stack (LIFO)

private String

figureSrc

protected Queue<Queue<String>>

inlineStack

Keep track of end markup for inline events.

private boolean

isFirstTableRow

is header row

private boolean

isVerbatimHtmlContext

flag if the current verbatim block added a HTML context or not

private final LastTwoLinesAwareWriter

lineAwareWriter

The outer decorated writer taking care of remembering the last two written lines.

private String

linkName

linkName.

private static final org.slf4j.Logger

LOGGER

private boolean

tableHeaderCellFlag

tableHeaderCellFlag, set to true for table rows containing at least one table header cell

private String

title

title.

private static final String

USE_XHTML_SINK

Fields inherited from class Xhtml5BaseSink
contentStack, tableAttributes

Fields inherited from interface 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, WBR

Fields inherited from interface 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_MARKUP

Fields inherited from interface 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 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_6

Fields inherited from interface TextMarkup
PIPE

Fields inherited from interface XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
Constructor Summary

Constructors

Modifier

Constructor

Description

private

MarkdownSink(LastTwoLinesAwareWriter lineAwareWriter, BufferingStackWriter bufferingStackWriter)

Constructor, initialize the Writer and the variables.
Method Summary

Modifier and Type

Method

Description

void

anchor(String name, SinkEventAttributes attributes)

Starts an element which defines an anchor.

void

anchor_()

Ends an anchor element.

void

author_()

Ends an author element.

void

blockquote(SinkEventAttributes attributes)

Starts a blockquote element.

void

blockquote_()

Ends an blockquote element.

void

body(SinkEventAttributes attributes)

Starts the body of a document.

void

body_()

Ends the body element.

void

bold()

Starts a bold element.

void

bold_()

Ends a bold element.

void

close()

Closes the writer or the stream, if needed.

void

date_()

Ends the date element.

void

definedTerm(SinkEventAttributes attributes)

Starts a definition term element within a definition list.

void

definedTerm_()

Ends a definition term element within a definition list.

void

definition(SinkEventAttributes attributes)

Starts a definition element within a definition list.

void

definition_()

Ends a definition element within a definition list.

void

definitionList(SinkEventAttributes attributes)

Starts a definition list.

void

definitionList_()

Ends a definition list element.

private void

endBlock(boolean requireBlankLine)

private void

endContext(MarkdownSink.ElementContext expectedContext)

private void

endTableCell()

Ends a table cell.

private void

ensureBeginningOfLine()

Ensures that the Xhtml5BaseSink.writer is currently at the beginning of a new line.

private void

ensureBlankLine()

Ensures that the Xhtml5BaseSink.writer is preceded by a blank line.

void

figure(SinkEventAttributes attributes)

Starts a basic image embedding element.

void

figure_()

Ends a basic image embedding element.

void

figureCaption(SinkEventAttributes attributes)

Starts a figure caption.

void

figureCaption_()

Ends a caption of an image.

void

figureGraphics(String name, SinkEventAttributes attributes)

Adds a graphic element.

private static boolean

filterAttributes(MutableAttributeSet attributes, AttributeSet... attributesToFilter)

private String

getLinePrefix()

void

head(SinkEventAttributes attributes)

Starts the head element.

void

head_()

Ends the head element.

void

header(SinkEventAttributes attributes)

Start a new header within the section or body.

void

header_()

Ends a header element.

void

horizontalRule(SinkEventAttributes attributes)

Adds a horizontal separator rule.

protected void

init()

This is called in AbstractSink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.

private void

initInternal()

void

inline(SinkEventAttributes attributes)

Starts an inline element.

void

inline_()

Ends an inline element.

private boolean

isInListItem()

void

italic()

Starts an italic element.

void

italic_()

Ends an italic element.

void

lineBreak(SinkEventAttributes attributes)

Adds a line break.

void

link(String name, SinkEventAttributes attributes)

The default style class for external link is externalLink.

void

link_()

Ends a link element.

void

list(SinkEventAttributes attributes)

Starts an unordered list.

void

list_()

Ends an unordered list element.

void

listItem(SinkEventAttributes attributes)

Starts a list item element within an unordered list.

void

listItem_()

Ends a list item element within an unordered list.

void

markupLineBreak(int indentLevel)

Adds a single line break with the specified indentation level.

void

monospaced()

Starts a monospaced element.

void

monospaced_()

Ends a monospaced element.

protected static MarkdownSink

newInstance(Writer writer)

void

nonBreakingSpace()

Adds a non breaking space, ie a space without any special formatting operations.

void

numberedList(int numbering, SinkEventAttributes attributes)

The default list style depends on the numbering.

void

numberedList_()

Ends an ordered list element.

void

numberedListItem(SinkEventAttributes attributes)

Starts a list item element within an ordered list.

void

numberedListItem_()

Ends a list item element within an ordered list.

void

pageBreak()

Adds a new page separator.

void

paragraph(SinkEventAttributes attributes)

Starts a paragraph.

void

paragraph_()

Ends a paragraph element.

void

rawText(String text)

Adds a raw text, ie a text without any special formatting operations.

void

section(int level, SinkEventAttributes attributes)

Start a new section at the given level.

void

section_(int level)

Ends a section at the given level.

void

sectionTitle(int level, SinkEventAttributes attributes)

Start a new section title at the given level.

void

sectionTitle_(int level)

Ends a section title at the given level.

private void

startBlock(boolean requireBlankLine)

private void

startContext(MarkdownSink.ElementContext newContext)

void

table(SinkEventAttributes attributes)

Starts a table.

void

table_()

Ends a table element.

void

tableCaption(SinkEventAttributes attributes)

Starts a table caption.

void

tableCaption_()

Ends a caption element of a table.

void

tableCell(SinkEventAttributes attributes)

Starts a table cell.

void

tableCell_()

Ends a cell element.

void

tableHeaderCell(SinkEventAttributes attributes)

Starts a table header cell.

void

tableHeaderCell_()

Ends a cell header element.

void

tableRow(SinkEventAttributes attributes)

Rows are striped with two colors by adding the class a or b.

void

tableRow_()

Ends a row element.

void

tableRows(int[] justification, boolean grid)

The default style class is bodyTable.

void

tableRows_()

Ends an element that contains rows of table data.

void

text(String text, SinkEventAttributes attributes)

Adds a text.

void

title_()

Ends the title element.

private String

toogleToRootContextWithoutBuffering(boolean dumpBuffer)

void

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

Adds an unknown event.

void

verbatim(SinkEventAttributes attributes)

Depending on whether the decoration attribute is "source" or not, this leads to either emitting <pre><code> or just <pre>.

void

verbatim_()

Ends a verbatim element.

private void

writeEmptyTableHeader()

private void

writeImage(String alt, String src)

private void

writeTableDelimiterRow()

Emit the delimiter row which determines the alignment

Methods inherited from class 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, writeStartTag

Methods inherited from class AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

Methods inherited from class SinkAdapter
author, date, definitionListItem, definitionListItem_, title

Methods inherited from class 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 Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- LOGGER
  
  private static final org.slf4j.Logger LOGGER
- authors
  
  private Collection<String> authors
  
  author.
- title
  
  private String title
  
  title.
- date
  
  private String date
  
  date.
- linkName
  
  private String linkName
  
  linkName.
- tableHeaderCellFlag
  
  private boolean tableHeaderCellFlag
  
  tableHeaderCellFlag, set to true for table rows containing at least one table header cell
- cellCount
  
  private int cellCount
  
  number of cells in a table.
- cellJustif
  
  private List<Integer> cellJustif
  
  justification of table cells per column.
- isFirstTableRow
  
  private boolean isFirstTableRow
  
  is header row
- bufferingStackWriter
  
  private final BufferingStackWriter bufferingStackWriter
  
  The inner decorated writer to buffer the text of contexts requiring buffering. Writing to this and bufferingWriter has the same effect.
- lineAwareWriter
  
  private final LastTwoLinesAwareWriter lineAwareWriter
  
  The outer decorated writer taking care of remembering the last two written lines. Writing to this and writer has the same effect.
- USE_XHTML_SINK
  private static final String USE_XHTML_SINK
  
  See Also:
  
  Constant Field Values
- inlineStack
  
  protected Queue<Queue<String>> inlineStack
  
  Keep track of end markup for inline events. Special value USE_XHTML_SINK is used to indicate usage of the Xhtml5BaseSink.inline_()
- elementContextStack
  
  protected Queue<MarkdownSink.ElementContext> elementContextStack
  
  The context of the surrounding elements as stack (LIFO)
- figureSrc
  
  private String figureSrc
- isVerbatimHtmlContext
  
  private boolean isVerbatimHtmlContext
  
  flag if the current verbatim block added a HTML context or not
Constructor Details
- MarkdownSink
  
  private MarkdownSink(LastTwoLinesAwareWriter lineAwareWriter, BufferingStackWriter bufferingStackWriter)
  
  Constructor, initialize the Writer and the variables.
  
  Parameters:
  
  writer - not null writer to write the result. Should be an UTF-8 Writer.
Method Details
- newInstance
  
  protected static MarkdownSink newInstance(Writer writer)
- initInternal
  
  private void initInternal()
- endContext
  
  private void endContext(MarkdownSink.ElementContext expectedContext)
- startContext
  
  private void startContext(MarkdownSink.ElementContext newContext)
- toogleToRootContextWithoutBuffering
  
  private String toogleToRootContextWithoutBuffering(boolean dumpBuffer)
- ensureBeginningOfLine
  
  private void ensureBeginningOfLine()
  
  Ensures that the Xhtml5BaseSink.writer is currently at the beginning of a new line. Optionally writes a line separator to ensure that.
- ensureBlankLine
  
  private void ensureBlankLine()
  
  Ensures that the Xhtml5BaseSink.writer is preceded by a blank line. Optionally writes a blank line or just line delimiter to ensure that.
- startBlock
  
  private void startBlock(boolean requireBlankLine)
- endBlock
  
  private void endBlock(boolean requireBlankLine)
- getLinePrefix
  
  private String getLinePrefix()
  
  Returns:
  
  the prefix to be used for each line in the current context (i.e. the prefix of the current container context and all its ancestors), may be empty
- isInListItem
  
  private boolean isInListItem()
- init
  
  protected void init()
  
  Description copied from class: AbstractSink
  
  This is called in AbstractSink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
  
  Overrides:
  
  init in class Xhtml5BaseSink
- head
  public void head(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts the head element.
  This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.
  
  The canonical sequence of events for the head element is:
  
  sink.head(); sink.title(); sink.text("Title"); sink.title_(); sink.author(); sink.text("Author"); sink.author_(); sink.date(); sink.text("Date"); sink.date_(); sink.head_();
  
  but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).
  
  Supported attributes are:
  
  PROFILE, LANG.
  
  Specified by:
  
  head in interface Sink
  
  Overrides:
  
  head in class SinkAdapter
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- head_
  
  public void head_()
  
  Description copied from interface: Sink
  
  Ends the head element.
  
  Specified by:
  
  head_ in interface Sink
  
  Overrides:
  
  head_ in class SinkAdapter
- body
  public void body(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts the body of a document. This contains the document's content.
  Supported attributes are the base attributes.
  
  Specified by:
  
  body in interface Sink
  
  Overrides:
  
  body in class SinkAdapter
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  Sink.head(SinkEventAttributes)
- body_
  
  public void body_()
  
  Description copied from interface: Sink
  
  Ends the body element.
  
  Specified by:
  
  body_ in interface Sink
  
  Overrides:
  
  body_ in class SinkAdapter
- title_
  
  public void title_()
  
  Description copied from interface: Sink
  
  Ends the title element.
  
  Specified by:
  
  title_ in interface Sink
  
  Overrides:
  
  title_ in class SinkAdapter
- author_
  
  public void author_()
  
  Description copied from interface: Sink
  
  Ends an author element.
  
  Specified by:
  
  author_ in interface Sink
  
  Overrides:
  
  author_ in class SinkAdapter
- date_
  
  public void date_()
  
  Description copied from interface: Sink
  
  Ends the date element.
  
  Specified by:
  
  date_ in interface Sink
  
  Overrides:
  
  date_ in class SinkAdapter
- section
  
  public void section(int level, SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Start a new section at the given level.
  Sections with higher level have to be entirely contained within sections of lower level.
  
  Supported attributes are the base attributes.
  
  Specified by:
  
  section in interface Sink
  
  Overrides:
  
  section in class Xhtml5BaseSink
  
  Parameters:
  
  level - the section level (must be a value between 1 and 6).
  
  attributes - A set of SinkEventAttributes, may be null.
- section_
  
  public void section_(int level)
  
  Description copied from interface: Sink
  
  Ends a section at the given level.
  
  Specified by:
  
  section_ in interface Sink
  
  Overrides:
  
  section_ in class Xhtml5BaseSink
  
  Parameters:
  
  level - the section level (must be a value between 1 and 6).
- header
  
  public void header(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Start a new header within the section or body.
  Supported attributes are the base attributes.
  
  Specified by:
  
  header in interface Sink
  
  Overrides:
  
  header in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- header_
  
  public void header_()
  
  Description copied from interface: Sink
  
  Ends a header element.
  
  Specified by:
  
  header_ in interface Sink
  
  Overrides:
  
  header_ in class Xhtml5BaseSink
- sectionTitle
  
  public void sectionTitle(int level, SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Start a new section title at the given level.
  This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.
  
  NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).
  
  Supported attributes are the base attributes plus ALIGN.
  
  Specified by:
  
  sectionTitle in interface Sink
  
  Overrides:
  
  sectionTitle in class Xhtml5BaseSink
  
  Parameters:
  
  level - the section title level (must be a value between 1 and 6).
  
  attributes - A set of SinkEventAttributes, may be null.
- sectionTitle_
  
  public void sectionTitle_(int level)
  
  Description copied from interface: Sink
  
  Ends a section title at the given level.
  
  Specified by:
  
  sectionTitle_ in interface Sink
  
  Overrides:
  
  sectionTitle_ in class Xhtml5BaseSink
  
  Parameters:
  
  level - the section title level (must be a value between 1 and 6).
- list
  public void list(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts an unordered list.
  Supported attributes are the base attributes.
  A list must contain at least one Sink.listItem(SinkEventAttributes) or Sink.listItem() as direct successor of this method.
  
  Specified by:
  
  list in interface Sink
  
  Overrides:
  
  list in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.UL
- list_
  public void list_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends an unordered list element.
  
  Specified by:
  
  list_ in interface Sink
  
  Overrides:
  
  list_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.UL
- listItem
  public void listItem(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a list item element within an unordered list.
  Supported attributes are the base attributes.
  Nested lists must have the following Sink method sequence:
  
  Sink.listItem(SinkEventAttributes) or Sink.listItem()
  
  Sink.list(SinkEventAttributes) or Sink.list()
  
  Sink.listItem(SinkEventAttributes) or Sink.listItem()
  
  ...
  
  Sink.listItem_()
  
  Sink.list_()
  
  ...
  
  Sink.listItem_()
  
  Sink.list_()
  
  Specified by:
  
  listItem in interface Sink
  
  Overrides:
  
  listItem in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.LI
- listItem_
  public void listItem_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a list item element within an unordered list.
  
  Specified by:
  
  listItem_ in interface Sink
  
  Overrides:
  
  listItem_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.LI
- numberedList
  public void numberedList(int numbering, SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  The default list style depends on the numbering. Starts an ordered list element.
  Supported attributes are the base attributes.
  A list must contain at least one Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem() as direct successor of this method.
  
  Specified by:
  
  numberedList in interface Sink
  
  Overrides:
  
  numberedList in class Xhtml5BaseSink
  
  Parameters:
  
  numbering - the numbering style.
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.OL
- numberedList_
  public void numberedList_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends an ordered list element.
  
  Specified by:
  
  numberedList_ in interface Sink
  
  Overrides:
  
  numberedList_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.OL
- numberedListItem
  public void numberedListItem(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a list item element within an ordered list.
  Supported attributes are the base attributes.
  Nested lists must have the following Sink method sequence:
  
  Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
  
  Sink.numberedList(int,SinkEventAttributes) or Sink.numberedList(int)
  
  Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
  
  ...
  
  Sink.numberedListItem_()
  
  Sink.numberedList_()
  
  ...
  
  Sink.numberedListItem_()
  
  Sink.numberedList_()
  
  Specified by:
  
  numberedListItem in interface Sink
  
  Overrides:
  
  numberedListItem in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.LI
- numberedListItem_
  public void numberedListItem_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a list item element within an ordered list.
  
  Specified by:
  
  numberedListItem_ in interface Sink
  
  Overrides:
  
  numberedListItem_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.LI
- definitionList
  public void definitionList(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a definition list.
  Supported attributes are the base attributes.
  
  Specified by:
  
  definitionList in interface Sink
  
  Overrides:
  
  definitionList in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.DL
- definitionList_
  public void definitionList_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a definition list element.
  
  Specified by:
  
  definitionList_ in interface Sink
  
  Overrides:
  
  definitionList_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.DL
- definedTerm
  public void definedTerm(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a definition term element within a definition list.
  Supported attributes are the base attributes.
  
  Specified by:
  
  definedTerm in interface Sink
  
  Overrides:
  
  definedTerm in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.DT
- definedTerm_
  public void definedTerm_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a definition term element within a definition list.
  
  Specified by:
  
  definedTerm_ in interface Sink
  
  Overrides:
  
  definedTerm_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.DT
- definition
  public void definition(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a definition element within a definition list.
  Supported attributes are the base attributes.
  
  Specified by:
  
  definition in interface Sink
  
  Overrides:
  
  definition in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.DD
- definition_
  public void definition_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a definition element within a definition list.
  
  Specified by:
  
  definition_ in interface Sink
  
  Overrides:
  
  definition_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.DD
- pageBreak
  
  public void pageBreak()
  
  Description copied from interface: Sink
  
  Adds a new page separator.
  
  Specified by:
  
  pageBreak in interface Sink
  
  Overrides:
  
  pageBreak in class Xhtml5BaseSink
- paragraph
  public void paragraph(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a paragraph.
  Supported attributes are the base attributes plus ALIGN.
  
  Specified by:
  
  paragraph in interface Sink
  
  Overrides:
  
  paragraph in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.P
- paragraph_
  public void paragraph_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a paragraph element.
  
  Specified by:
  
  paragraph_ in interface Sink
  
  Overrides:
  
  paragraph_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.P
- verbatim
  public void verbatim(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Depending on whether the decoration attribute is "source" or not, this leads to either emitting <pre><code> or just <pre>. No default classes are emitted but the given attributes are always added to the pre element only. Starts a verbatim block, ie a block where whitespace has semantic relevance.
  Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.
  
  Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.
  
  Supported attributes are the base attributes plus:
  
  DECORATION (values: "source"), ALIGN, WIDTH.
  
  Specified by:
  
  verbatim in interface Sink
  
  Overrides:
  
  verbatim in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.PRE
  
  HTML.Tag.CODE
- verbatim_
  public void verbatim_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a verbatim element.
  
  Specified by:
  
  verbatim_ in interface Sink
  
  Overrides:
  
  verbatim_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.CODE
  
  HTML.Tag.PRE
- blockquote
  public void blockquote(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a blockquote element.
  Supported attributes are the base attributes.
  
  Specified by:
  
  blockquote in interface Sink
  
  Overrides:
  
  blockquote in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.BLOCKQUOTE
- blockquote_
  public void blockquote_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends an blockquote element.
  
  Specified by:
  
  blockquote_ in interface Sink
  
  Overrides:
  
  blockquote_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.BLOCKQUOTE
- horizontalRule
  public void horizontalRule(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Adds a horizontal separator rule.
  Supported attributes are the base attributes plus:
  
  ALIGN, NOSHADE, SIZE, WIDTH.
  
  Specified by:
  
  horizontalRule in interface Sink
  
  Overrides:
  
  horizontalRule in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.HR
- table
  public void table(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts a table.
  The canonical sequence of events for the table element is:
  
  sink.table(); sink.tableRows(justify, true); sink.tableRow(); sink.tableCell(); sink.text("cell 1,1"); sink.tableCell_(); sink.tableCell(); sink.text("cell 1,2"); sink.tableCell_(); sink.tableRow_(); sink.tableRows_(); sink.tableCaption(); sink.text("Table caption"); sink.tableCaption_(); sink.table_();
  
  where the tableCaption element is optional.
  
  However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
  
  Supported attributes are the base attributes plus:
  
  ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.
  
  Specified by:
  
  table in interface Sink
  
  Overrides:
  
  table in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- table_
  public void table_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a table element.
  
  Specified by:
  
  table_ in interface Sink
  
  Overrides:
  
  table_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.TABLE
- tableRows
  public void tableRows(int[] justification, boolean grid)
  
  Description copied from class: Xhtml5BaseSink
  
  The default style class is bodyTable.
  
  Specified by:
  
  tableRows in interface Sink
  
  Overrides:
  
  tableRows in class Xhtml5BaseSink
  
  Parameters:
  
  justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells. Each element of the array must be one of the following constants: Sink.JUSTIFY_LEFT, Sink.JUSTIFY_CENTER, Sink.JUSTIFY_RIGHT or Sink.JUSTIFY_DEFAULT.
  
  grid - if true the style class bodyTableBorder will be added true to render a grid, false otherwise.
  
  See Also:
  
  HTML.Tag.TABLE
- tableRows_
  
  public void tableRows_()
  
  Description copied from interface: Sink
  
  Ends an element that contains rows of table data.
  
  Specified by:
  
  tableRows_ in interface Sink
  
  Overrides:
  
  tableRows_ in class Xhtml5BaseSink
- tableRow
  public void tableRow(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Rows are striped with two colors by adding the class a or b. If the provided attributes specify the hidden class, the next call to tableRow will set the same striping class as this one. A style for hidden or table.bodyTable hidden may need to be provided to actually hide such a row. Starts a table row.
  Supported attributes are the base attributes plus:
  
  ALIGN, BGCOLOR, VALIGN.
  
  Specified by:
  
  tableRow in interface Sink
  
  Overrides:
  
  tableRow in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.TR
- tableRow_
  public void tableRow_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a row element.
  
  Specified by:
  
  tableRow_ in interface Sink
  
  Overrides:
  
  tableRow_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.TR
- writeEmptyTableHeader
  
  private void writeEmptyTableHeader()
- writeTableDelimiterRow
  
  private void writeTableDelimiterRow()
  
  Emit the delimiter row which determines the alignment
- tableCell
  
  public void tableCell(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts a table cell.
  Supported attributes are the base attributes plus:
  
  ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
  
  Specified by:
  
  tableCell in interface Sink
  
  Overrides:
  
  tableCell in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- tableHeaderCell
  
  public void tableHeaderCell(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts a table header cell.
  Supported attributes are the same as for tableCell.
  
  Specified by:
  
  tableHeaderCell in interface Sink
  
  Overrides:
  
  tableHeaderCell in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- tableCell_
  
  public void tableCell_()
  
  Description copied from interface: Sink
  
  Ends a cell element.
  
  Specified by:
  
  tableCell_ in interface Sink
  
  Overrides:
  
  tableCell_ in class Xhtml5BaseSink
- tableHeaderCell_
  
  public void tableHeaderCell_()
  
  Description copied from interface: Sink
  
  Ends a cell header element.
  
  Specified by:
  
  tableHeaderCell_ in interface Sink
  
  Overrides:
  
  tableHeaderCell_ in class Xhtml5BaseSink
- endTableCell
  
  private void endTableCell()
  
  Ends a table cell.
- tableCaption
  public void tableCaption(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a table caption.
  Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
  
  Supported attributes are the base attributes plus ALIGN.
  
  Specified by:
  
  tableCaption in interface Sink
  
  Overrides:
  
  tableCaption in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.CAPTION
- tableCaption_
  public void tableCaption_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a caption element of a table.
  
  Specified by:
  
  tableCaption_ in interface Sink
  
  Overrides:
  
  tableCaption_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.CAPTION
- figure
  public void figure(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts a basic image embedding element.
  The canonical sequence of events for the figure element is:
  
  sink.figure(); sink.figureGraphics("figure.png"); sink.figureCaption(); sink.text("Figure caption",); sink.figureCaption_(); sink.figure_();
  
  where the figureCaption element is optional.
  
  However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.
  
  NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).
  
  Supported attributes are the base attributes.
  
  Specified by:
  
  figure in interface Sink
  
  Overrides:
  
  figure in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- figureCaption
  public void figureCaption(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts a figure caption.
  Supported attributes are the base attributes.
  
  Specified by:
  
  figureCaption in interface Sink
  
  Overrides:
  
  figureCaption in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  Sink.figure(SinkEventAttributes)
- figureCaption_
  
  public void figureCaption_()
  
  Description copied from interface: Sink
  
  Ends a caption of an image.
  
  Specified by:
  
  figureCaption_ in interface Sink
  
  Overrides:
  
  figureCaption_ in class Xhtml5BaseSink
- figureGraphics
  public void figureGraphics(String name, SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Adds a graphic element.
  The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.
  
  Supported attributes are the base attributes plus:
  
  SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.
  
  If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.
  
  Specified by:
  
  figureGraphics in interface Sink
  
  Overrides:
  
  figureGraphics in class Xhtml5BaseSink
  
  Parameters:
  
  name - the image source, a valid URL.
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  Sink.figure(SinkEventAttributes)
- figure_
  
  public void figure_()
  
  Description copied from interface: Sink
  
  Ends a basic image embedding element.
  
  Specified by:
  
  figure_ in interface Sink
  
  Overrides:
  
  figure_ in class Xhtml5BaseSink
- writeImage
  
  private void writeImage(String alt, String src)
- anchor
  public void anchor(String name, SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Starts an element which defines an anchor.
  The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:
  
  ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
  
  Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
  
  Specified by:
  
  anchor in interface Sink
  
  Overrides:
  
  anchor in class Xhtml5BaseSink
  
  Parameters:
  
  name - the name of the anchor. This has to be a valid SGML NAME token.
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.A
- anchor_
  public void anchor_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends an anchor element.
  
  Specified by:
  
  anchor_ in interface Sink
  
  Overrides:
  
  anchor_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.A
- link
  public void link(String name, SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  The default style class for external link is externalLink. Starts a link.
  The name parameter has to be a valid URI according to RFC 3986, i.e. for internal links (links to an anchor within the same source document), name should start with the character "#". This also implies that all unsafe characters are already encoded.
  
  Supported attributes are the base attributes plus:
  
  CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.
  
  If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
  
  Specified by:
  
  link in interface Sink
  
  Overrides:
  
  link in class Xhtml5BaseSink
  
  Parameters:
  
  name - the name of the link.
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.A
- link_
  public void link_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a link element.
  
  Specified by:
  
  link_ in interface Sink
  
  Overrides:
  
  link_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.A
- inline
  
  public void inline(SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Starts an inline element.
  The inline method is similar to Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.
  
  Supported attributes are the base attributes plus
  
  SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
  
  Specified by:
  
  inline in interface Sink
  
  Overrides:
  
  inline in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
- filterAttributes
  
  private static boolean filterAttributes(MutableAttributeSet attributes, AttributeSet... attributesToFilter)
- inline_
  
  public void inline_()
  
  Description copied from interface: Sink
  
  Ends an inline element.
  
  Specified by:
  
  inline_ in interface Sink
  
  Overrides:
  
  inline_ in class Xhtml5BaseSink
- italic
  public void italic()
  
  Description copied from class: Xhtml5BaseSink
  
  Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  italic in interface Sink
  
  Overrides:
  
  italic in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.I
- italic_
  public void italic_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  italic_ in interface Sink
  
  Overrides:
  
  italic_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.I
- bold
  public void bold()
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  bold in interface Sink
  
  Overrides:
  
  bold in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.B
- bold_
  public void bold_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  bold_ in interface Sink
  
  Overrides:
  
  bold_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.B
- monospaced
  public void monospaced()
  
  Description copied from class: Xhtml5BaseSink
  
  Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  monospaced in interface Sink
  
  Overrides:
  
  monospaced in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.CODE
- monospaced_
  public void monospaced_()
  
  Description copied from class: Xhtml5BaseSink
  
  Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  
  Specified by:
  
  monospaced_ in interface Sink
  
  Overrides:
  
  monospaced_ in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.CODE
- lineBreak
  public void lineBreak(SinkEventAttributes attributes)
  
  Description copied from class: Xhtml5BaseSink
  
  Adds a line break.
  Supported attributes are:
  
  ID, CLASS, TITLE, STYLE.
  
  Specified by:
  
  lineBreak in interface Sink
  
  Overrides:
  
  lineBreak in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - A set of SinkEventAttributes, may be null.
  
  See Also:
  
  HTML.Tag.BR
- nonBreakingSpace
  
  public void nonBreakingSpace()
  
  Description copied from interface: Sink
  
  Adds a non breaking space, ie a space without any special formatting operations.
  
  Specified by:
  
  nonBreakingSpace in interface Sink
  
  Overrides:
  
  nonBreakingSpace in class Xhtml5BaseSink
- text
  
  public void text(String text, SinkEventAttributes attributes)
  
  Description copied from interface: Sink
  
  Adds a text.
  The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.
  
  If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.
  
  Supported attributes are the base attributes plus
  
  SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
  
  The following attributes are deprecated:
  
  VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
  
  Specified by:
  
  text in interface Sink
  
  Overrides:
  
  text in class Xhtml5BaseSink
  
  Parameters:
  
  text - The text to write.
  
  attributes - A set of SinkEventAttributes, may be null.
- rawText
  
  public void rawText(String text)
  
  Description copied from interface: Sink
  
  Adds a raw text, ie a text without any special formatting operations.
  
  Specified by:
  
  rawText in interface Sink
  
  Overrides:
  
  rawText in class Xhtml5BaseSink
  
  Parameters:
  
  text - The text to write.
- unknown
  public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
  
  Adds an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Add an unknown event. This can be used to generate html tags for which no corresponding sink event exists.
  If HtmlTools.getHtmlTag(name) does not return null, the corresponding tag will be written.
  
  For example, the div block
  
  <div class="detail" style="display:inline">text</div>
  
  can be generated via the following event sequence:
  
  SinkEventAttributeSet atts = new SinkEventAttributeSet(); atts.addAttribute(SinkEventAttributes.CLASS, "detail"); atts.addAttribute(SinkEventAttributes.STYLE, "display:inline"); sink.unknown("div", new Object[]{new Integer(HtmlMarkup.TAG_TYPE_START)}, atts); sink.text("text"); sink.unknown("div", new Object[]{new Integer(HtmlMarkup.TAG_TYPE_END)}, null);
  Unknown events just log a warning message but are ignored otherwise.
  
  Specified by:
  
  unknown in interface Sink
  
  Overrides:
  
  unknown in class Xhtml5BaseSink
  
  Parameters:
  
  name - the name of the event. If this is not a valid xhtml tag name as defined in HtmlMarkup then the event is ignored.
  
  requiredParams - If this is null or the first argument is not an Integer then the event is ignored. The first argument should indicate the type of the unknown event, its integer value should be one of TAG_TYPE_START, TAG_TYPE_END, TAG_TYPE_SIMPLE, ENTITY_TYPE, or CDATA_TYPE, otherwise the event will be ignored.
  
  attributes - a set of attributes for the event. May be null. The attributes will always be written, no validity check is performed.
  
  See Also:
  
  Sink.unknown(String,Object[],SinkEventAttributes)
- markupLineBreak
  
  public void markupLineBreak(int indentLevel)
  
  Description copied from interface: Sink
  
  Adds a single line break with the specified indentation level. The default implementation does nothing. This is different from emitting a line break with Sink.lineBreak(SinkEventAttributes) or Sink.text(String, SinkEventAttributes) as those line breaks are part of the content (i.e. affect rendering) while this line break is purely for pretty-printing the Sink's output and should not affect the rendering of the content. This is useful for Sinks that emit text-based markup languages (e.g. HTML, XML, etc.) to produce more human-readable output.
  
  Specified by:
  
  markupLineBreak in interface Sink
  
  Overrides:
  
  markupLineBreak in class Xhtml5BaseSink
  
  Parameters:
  
  indentLevel - the indentation level, where 0 means no indentation, 1 means one level of indentation, etc. The sink can decide how many spaces/tabs to use for each level of indentation.
- close
  
  public void close()
  
  Description copied from interface: Sink
  
  Closes the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Sink
  
  Overrides:
  
  close in class Xhtml5BaseSink

Class MarkdownSink

Nested Class Summary

Nested classes/interfaces inherited from class Xhtml5BaseSink

Field Summary

Fields inherited from class Xhtml5BaseSink

Fields inherited from interface HtmlMarkup

Fields inherited from interface MarkdownMarkup

Fields inherited from interface Markup

Fields inherited from interface Sink

Fields inherited from interface TextMarkup

Fields inherited from interface XmlMarkup

Constructor Summary

Method Summary

Methods inherited from class Xhtml5BaseSink

Methods inherited from class AbstractXmlSink

Methods inherited from class SinkAdapter

Methods inherited from class AbstractSink

Methods inherited from class Object

Field Details

LOGGER

authors

title

date

linkName

tableHeaderCellFlag

cellCount

cellJustif

isFirstTableRow

bufferingStackWriter

lineAwareWriter

USE_XHTML_SINK

inlineStack

elementContextStack

figureSrc

isVerbatimHtmlContext

Constructor Details

MarkdownSink

Method Details

newInstance

initInternal

endContext

startContext

toogleToRootContextWithoutBuffering

ensureBeginningOfLine

ensureBlankLine

startBlock

endBlock

getLinePrefix

isInListItem

init

head

head_

body

body_

title_

author_

date_

section

section_

header

header_

sectionTitle

sectionTitle_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definedTerm

definedTerm_

definition

definition_

pageBreak

paragraph

paragraph_