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.XhtmlBaseSink
-
- org.apache.maven.doxia.module.xdoc.XdocSink
-
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled
,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
- Direct Known Subclasses:
XmlWriterXdocSink
public class XdocSink extends org.apache.maven.doxia.sink.impl.XhtmlBaseSink implements XdocMarkup
- Since:
- 1.0
- Author:
- James Taylor
-
-
Field Summary
-
Fields inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
inlineStack, tableAttributes, tableRows
-
Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BASEFONT, BDI, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIR, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FONT, FOOTER, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, META, METER, NAV, NOFRAMES, 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, STRIKE, STRONG, STYLE, SUB, SUMMARY, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, TT, 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_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, 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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
XdocSink(java.io.Writer writer)
Constructor, initialize the Writer.protected
XdocSink(java.io.Writer writer, java.lang.String encoding)
Constructor, initialize the Writer and tells which encoding is used.protected
XdocSink(java.io.Writer writer, java.lang.String encoding, java.lang.String languageId)
Constructor, initialize the Writer and tells which encoding and languageId are used.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
author_()
void
body()
void
body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void
body_()
void
close()
close.void
date_()
void
head()
void
head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void
head_()
protected void
init()
void
link(java.lang.String name, java.lang.String target)
Adds a link with an optional target.protected void
markup(java.lang.String text)
Deprecated.use write(String)protected void
onSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
Starts a section.protected void
onSection_(int depth)
Ends a section.protected void
onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
Starts a section title.protected void
onSectionTitle_(int depth)
Ends a section title.void
tableRow()
The default valign istop
.void
tableRows(int[] justification, boolean grid)
The default align iscenter
.void
title()
void
title_()
void
verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void
verbatim_()
-
Methods inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
address, address, address_, anchor, anchor, anchor_, blockquote, blockquote, blockquote_, bold, bold_, comment, content, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, division, division, division_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, inline, inline, inline_, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetState, resetTextBuffer, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, setCellCount, setCellJustif, setHeadFlag, setVerbatimFlag, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow_, tableRows_, text, text, unknown, verbatim, 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
article, article, article_, author, author, content, content, content_, data, data, data_, date, date, definitionListItem, definitionListItem, definitionListItem_, footer, footer, footer_, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, navigation, navigation, navigation_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_, title
-
-
-
-
Constructor Detail
-
XdocSink
protected XdocSink(java.io.Writer writer)
Constructor, initialize the Writer.- Parameters:
writer
- not null writer to write the result. Should be an UTF-8 Writer. You could usenewXmlWriter
methods fromWriterFactory
.
-
XdocSink
protected XdocSink(java.io.Writer writer, java.lang.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 notnull
.- Since:
- 1.1
-
XdocSink
protected XdocSink(java.io.Writer writer, java.lang.String encoding, java.lang.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 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 Detail
-
init
protected void init()
- Overrides:
init
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
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:
head(org.apache.maven.doxia.sink.SinkEventAttributes)
-
head
public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
head
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
- See Also:
XdocMarkup.DOCUMENT_TAG
,XdocMarkup.PROPERTIES_TAG
-
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:
XdocMarkup.DOCUMENT_TAG
,XdocMarkup.PROPERTIES_TAG
-
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:
HTML.Tag.TITLE
-
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:
HTML.Tag.TITLE
-
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:
XdocMarkup.AUTHOR_TAG
-
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:
XdocMarkup.DATE_TAG
-
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:
body(org.apache.maven.doxia.sink.SinkEventAttributes)
-
body
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
- See Also:
HTML.Tag.BODY
-
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:
HTML.Tag.BODY
,XdocMarkup.DOCUMENT_TAG
-
onSection
protected void onSection(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
Starts a section.- Overrides:
onSection
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
XdocMarkup.SECTION_TAG
,XdocMarkup.SUBSECTION_TAG
-
onSection_
protected void onSection_(int depth)
Ends a section.- Overrides:
onSection_
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
XdocMarkup.SECTION_TAG
,XdocMarkup.SUBSECTION_TAG
-
onSectionTitle
protected void onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
Starts a section title.- Overrides:
onSectionTitle
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
HTML.Tag.H4
,HTML.Tag.H5
,HTML.Tag.H6
-
onSectionTitle_
protected void onSectionTitle_(int depth)
Ends a section title.- Overrides:
onSectionTitle_
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
HTML.Tag.H4
,HTML.Tag.H5
,HTML.Tag.H6
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- Parameters:
attributes
- aSinkEventAttributes
object.- See Also:
XdocMarkup.SOURCE_TAG
,HTML.Tag.PRE
-
verbatim_
public void verbatim_()
- Specified by:
verbatim_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim_
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
XdocMarkup.SOURCE_TAG
,HTML.Tag.PRE
-
tableRows
public void tableRows(int[] justification, boolean grid)
The default align iscenter
.- Specified by:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
HTML.Tag.TABLE
-
tableRow
public void tableRow()
The default valign istop
.- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- See Also:
HTML.Tag.TR
-
close
public void close()
close.
- Specified by:
close
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
close
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
link
public void link(java.lang.String name, java.lang.String target)
Adds a link with an optional target.- Parameters:
name
- the link name.target
- the link target, may be null.
-
markup
protected void markup(java.lang.String text)
Deprecated.use write(String)Write text to output, preserving white space.- Parameters:
text
- The text to write.
-
-