org.apache.maven.doxia.module.xdoc.XdocSink

All Implemented Interfaces:: AutoCloseable, HtmlMarkup, Markup, XmlMarkup, XdocMarkup, Sink

public class XdocSink extends Xhtml5BaseSink implements XdocMarkup

Xdoc Sink implementation.
It uses the Xdoc XSD https://maven.apache.org/xsd/xdoc-2.0.xsd.

Since:: 1.0
Author:: James Taylor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Xhtml5BaseSink.VerbatimMode
Field Summary

Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack, inlineStack, tableAttributes

Fields 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, WBR

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_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 org.apache.maven.doxia.module.xdoc.XdocMarkup
AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG, XDOC_NAMESPACE, XDOC_SYSTEM_ID

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

XdocSink(Writer writer)

Constructor, initialize the Writer.

protected

XdocSink(Writer writer, String encoding)

Constructor, initialize the Writer and tells which encoding is used.

protected

XdocSink(Writer writer, String encoding, String languageId)

Constructor, initialize the Writer and tells which encoding and languageId are used.
Method Summary

Modifier and Type

Method

Description

void

author_()

void

body(SinkEventAttributes attributes)

void

body_()

void

close()

close.

void

date_()

void

head(SinkEventAttributes attributes)

void

head_()

protected void

init()

protected void

onSection(int depth, SinkEventAttributes attributes)

Starts a section.

protected void

onSection_(int depth)

Ends a section.

protected void

onSectionTitle(int depth, SinkEventAttributes attributes)

Starts a section title.

protected void

onSectionTitle_(int depth)

Ends a section title.

void

tableRow(SinkEventAttributes attributes)

void

tableRows(int[] justification, boolean grid)

void

title(SinkEventAttributes attributes)

void

title_()

void

verbatim(SinkEventAttributes attributes)

void

verbatim_()

Methods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address, address_, anchor, anchor_, article, article_, blockquote, blockquote_, bold, bold_, comment, content, content, content_, convertAndFilterAttributes, convertToHtml5CompliantAttributes, data, data_, definedTerm, definedTerm_, definition, definition_, definitionList, definitionList_, division, division_, encodeAsHtmlComment, encodeURL, escapeHTML, figure, figure_, figureCaption, figureCaption_, figureGraphics, flush, footer, footer_, getCellCount, getCellJustif, getTextBuffer, getVerbatimMode, header, header_, horizontalRule, inline, inline_, isHeadFlag, isVerbatim, italic, italic_, lineBreak, lineBreakOpportunity, link, link_, list, list_, listItem, listItem_, markupLineBreak, monospaced, monospaced_, navigation, navigation_, nonBreakingSpace, numberedList, numberedList_, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph_, rawText, resetTextBuffer, section, section_, sectionTitle, sectionTitle_, setCellCount, setCellJustif, setHeadFlag, setVerbatimMode, sidebar, sidebar_, table, table_, tableCaption, tableCaption_, tableCell, tableCell_, tableHeaderCell, tableHeaderCell_, tableRow_, tableRows_, text, time, time_, unknown, verbatimContent, write, writeEndTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
author, date, definitionListItem, definitionListItem_

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

Constructor Details
- XdocSink
  
  protected XdocSink(Writer writer)
  
  Constructor, initialize the Writer.
  
  Parameters:
  
  writer - not null writer to write the result. Should be an UTF-8 Writer.
- XdocSink
  
  protected XdocSink(Writer writer, String encoding)
  
  Constructor, initialize the Writer and tells which encoding is used.
  
  Parameters:
  
  writer - not null writer to write the result.
  
  encoding - the encoding used, that should be written to the generated HTML content if not null.
  
  Since:
  
  1.1
- XdocSink
  
  protected XdocSink(Writer writer, String encoding, String languageId)
  
  Constructor, initialize the Writer and tells which encoding and languageId are used.
  
  Parameters:
  
  writer - not null writer to write the result.
  
  encoding - the encoding used, that should be written to the generated HTML content if not null.
  
  languageId - language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.
  
  Since:
  
  1.1
Method Details
- init
  
  protected void init()
  
  Overrides:
  
  init in class Xhtml5BaseSink
- head
  
  public void head(SinkEventAttributes attributes)
  Specified by:
  
  head in interface Sink
  
  Overrides:
  
  head in class SinkAdapter
  
  See Also:
  
  XdocMarkup.DOCUMENT_TAG
  
  XdocMarkup.PROPERTIES_TAG
- head_
  
  public void head_()
  Specified by:
  
  head_ in interface Sink
  
  Overrides:
  
  head_ in class SinkAdapter
  
  See Also:
  
  XdocMarkup.DOCUMENT_TAG
  
  XdocMarkup.PROPERTIES_TAG
- title
  
  public void title(SinkEventAttributes attributes)
  Specified by:
  
  title in interface Sink
  
  Overrides:
  
  title in class SinkAdapter
  
  See Also:
  
  HTML.Tag.TITLE
- title_
  
  public void title_()
  Specified by:
  
  title_ in interface Sink
  
  Overrides:
  
  title_ in class SinkAdapter
  
  See Also:
  
  HTML.Tag.TITLE
- author_
  
  public void author_()
  Specified by:
  
  author_ in interface Sink
  
  Overrides:
  
  author_ in class SinkAdapter
  
  See Also:
  
  XdocMarkup.AUTHOR_TAG
- date_
  
  public void date_()
  Specified by:
  
  date_ in interface Sink
  
  Overrides:
  
  date_ in class SinkAdapter
  
  See Also:
  
  XdocMarkup.DATE_TAG
- body
  
  public void body(SinkEventAttributes attributes)
  Specified by:
  
  body in interface Sink
  
  Overrides:
  
  body in class SinkAdapter
  
  See Also:
  
  HTML.Tag.BODY
- body_
  
  public void body_()
  Specified by:
  
  body_ in interface Sink
  
  Overrides:
  
  body_ in class SinkAdapter
  
  See Also:
  
  HTML.Tag.BODY
  
  XdocMarkup.DOCUMENT_TAG
- onSection
  
  protected void onSection(int depth, SinkEventAttributes attributes)
  
  Starts a section.
  Overrides:
  
  onSection in class Xhtml5BaseSink
  
  See Also:
  
  XdocMarkup.SECTION_TAG
  
  XdocMarkup.SUBSECTION_TAG
- onSection_
  
  protected void onSection_(int depth)
  
  Ends a section.
  Overrides:
  
  onSection_ in class Xhtml5BaseSink
  
  See Also:
  
  XdocMarkup.SECTION_TAG
  
  XdocMarkup.SUBSECTION_TAG
- onSectionTitle
  
  protected void onSectionTitle(int depth, SinkEventAttributes attributes)
  
  Starts a section title.
  Overrides:
  
  onSectionTitle in class Xhtml5BaseSink
  
  See Also:
  
  HtmlMarkup.H3
  
  HtmlMarkup.H4
  
  HtmlMarkup.H5
  
  HtmlMarkup.H6
- onSectionTitle_
  
  protected void onSectionTitle_(int depth)
  
  Ends a section title.
  Overrides:
  
  onSectionTitle_ in class Xhtml5BaseSink
  
  See Also:
  
  HtmlMarkup.H3
  
  HtmlMarkup.H4
  
  HtmlMarkup.H5
  
  HtmlMarkup.H6
- verbatim
  
  public void verbatim(SinkEventAttributes attributes)
  Specified by:
  
  verbatim in interface Sink
  
  Overrides:
  
  verbatim in class Xhtml5BaseSink
  
  Parameters:
  
  attributes - a SinkEventAttributes object.
  
  See Also:
  
  XdocMarkup.SOURCE_TAG
  
  HTML.Tag.PRE
- verbatim_
  
  public void verbatim_()
  Specified by:
  
  verbatim_ in interface Sink
  
  Overrides:
  
  verbatim_ in class Xhtml5BaseSink
  
  See Also:
  
  XdocMarkup.SOURCE_TAG
  
  HTML.Tag.PRE
- tableRows
  
  public void tableRows(int[] justification, boolean grid)
  Specified by:
  
  tableRows in interface Sink
  
  Overrides:
  
  tableRows in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.TABLE
- tableRow
  
  public void tableRow(SinkEventAttributes attributes)
  Specified by:
  
  tableRow in interface Sink
  
  Overrides:
  
  tableRow in class Xhtml5BaseSink
  
  See Also:
  
  HTML.Tag.TR
- close
  
  public void close()
  
  close.
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Sink
  
  Overrides:
  
  close in class Xhtml5BaseSink

Class XdocSink

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

Field Summary

Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

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

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

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

Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Details

XdocSink

XdocSink

XdocSink

Method Details

init

head

head_

title

title_

author_

date_

body

body_

onSection

onSection_

onSectionTitle

onSectionTitle_

verbatim

verbatim_

tableRows

tableRow

close