Class XdocSink
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.xdoc.XdocSink
- All Implemented Interfaces:
AutoCloseable,org.apache.maven.doxia.markup.HtmlMarkup,org.apache.maven.doxia.markup.Markup,org.apache.maven.doxia.markup.XmlMarkup,XdocMarkup,org.apache.maven.doxia.sink.Sink
- Since:
- 1.0
- Author:
- James Taylor
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode -
Field Summary
Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack, inlineStack, 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.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_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.module.xdoc.XdocMarkup
AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG, XDOC_NAMESPACE, XDOC_SYSTEM_IDFields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor, initialize the Writer.protectedConstructor, initialize the Writer and tells which encoding is used.protectedConstructor, initialize the Writer and tells which encoding and languageId are used. -
Method Summary
Modifier and TypeMethodDescriptionvoidauthor_()voidbody(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidbody_()voidclose()close.voiddate_()voidhead(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidhead_()protected voidinit()protected voidonSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section.protected voidonSection_(int depth) Ends a section.protected voidonSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section title.protected voidonSectionTitle_(int depth) Ends a section title.voidtableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidtableRows(int[] justification, boolean grid) voidtitle(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidtitle_()voidverbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidMethods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address, address_, anchor, anchor_, article, article_, blockquote, blockquote_, bold, bold_, comment, content, content, content_, data, data_, definedTerm, definedTerm_, definition, definition_, definitionList, definitionList_, division, division_, 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_, 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, 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_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
-
Constructor Details
-
XdocSink
Constructor, initialize the Writer.- Parameters:
writer- not null writer to write the result. Should be an UTF-8 Writer. You could usenewXmlWritermethods fromWriterFactory.
-
XdocSink
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 notnull.- Since:
- 1.1
-
XdocSink
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 notnull.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:
initin classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
head
public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
headin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
headin classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
head_
public void head_()- Specified by:
head_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
head_in classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
title
public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
titlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
titlein classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
title_
public void title_()- Specified by:
title_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
title_in classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
author_
public void author_()- Specified by:
author_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
author_in classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
date_
public void date_()- Specified by:
date_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
date_in classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
body
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
bodyin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
bodyin classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
body_
public void body_()- Specified by:
body_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
body_in classorg.apache.maven.doxia.sink.impl.SinkAdapter- See Also:
-
onSection
protected void onSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section.- Overrides:
onSectionin classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
onSection_
protected void onSection_(int depth) Ends a section.- Overrides:
onSection_in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
onSectionTitle
protected void onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Starts a section title.- Overrides:
onSectionTitlein classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
onSectionTitle_
protected void onSectionTitle_(int depth) Ends a section title.- Overrides:
onSectionTitle_in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
verbatimin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatimin classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- Parameters:
attributes- aSinkEventAttributesobject.- See Also:
-
verbatim_
public void verbatim_()- Specified by:
verbatim_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatim_in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
tableRows
public void tableRows(int[] justification, boolean grid) - Specified by:
tableRowsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowsin classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableRowin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowin classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink- See Also:
-
close
public void close()close.
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
closein classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-