Package org.apache.maven.doxia.module.xdoc

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.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, XdocMarkup

Direct Known Subclasses:

XmlWriterXdocSink

public class XdocSink
extends org.apache.maven.doxia.sink.impl.XhtmlBaseSink
implements XdocMarkup

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

Since:

1.0

Version:

$Id: XdocSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

James Taylor

Field Summary

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

A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR

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

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

tableAttributes, tableRows

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(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

Modifier and Type	Method	Description
void	author_()
void	body()
void	body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	body_()
void	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 is top.
void	tableRows(int[] justification, boolean grid)	The default align is center.
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.AbstractSink

enableLogging, getLog, unifyEOLs

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

getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

author, author, date, date, definitionListItem, definitionListItem, definitionListItem_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, title

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

anchor, anchor, anchor_, bold, bold_, comment, content, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, 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

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 use newXmlWriter methods from WriterFactory.

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 not null.

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 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 Detail

init

protected void init()

Overrides:

init in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

head

public void head()

Overrides:

head in class org.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)

Overrides:

head in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

XdocMarkup.DOCUMENT_TAG, XdocMarkup.PROPERTIES_TAG

head_

public void head_()

Overrides:

head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

XdocMarkup.DOCUMENT_TAG, XdocMarkup.PROPERTIES_TAG

title

public void title()

Overrides:

title in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

HTML.Tag.TITLE

title_

public void title_()

Overrides:

title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

HTML.Tag.TITLE

author_

public void author_()

Overrides:

author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

XdocMarkup.AUTHOR_TAG

date_

public void date_()

Overrides:

date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

XdocMarkup.DATE_TAG

body

public void body()

Overrides:

body in class org.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)

Overrides:

body in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

HTML.Tag.BODY

body_

public void body_()

Overrides:

body_ in class org.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 class org.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 class org.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 class org.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 class org.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)

Overrides:

verbatim in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

See Also:

XdocMarkup.SOURCE_TAG, HTML.Tag.PRE

verbatim_

public void verbatim_()

Overrides:

verbatim_ in class org.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 is center.

Overrides:

tableRows in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

See Also:

HTML.Tag.TABLE

tableRow

public void tableRow()

The default valign is top.

Overrides:

tableRow in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

See Also:

HTML.Tag.TR

close

public void close()

Overrides:

close in class org.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.