DocBookSink

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.module.docbook.DocBookSink

All Implemented Interfaces:

org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, DocbookMarkup, SimplifiedDocbookMarkup
```
public class DocBookSink
extends org.apache.maven.doxia.sink.impl.AbstractXmlSink
implements DocbookMarkup, SimplifiedDocbookMarkup
```
Docbook Sink implementation.
It uses the Docbook v4.4 DTD http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd.

Since:

1.0

Version:

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

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DEFAULT_SGML_PUBLIC_ID`	Deprecated. since 1.1, use `DocbookMarkup.DEFAULT_SGML_PUBLIC_ID` instead of.
`static java.lang.String`	`DEFAULT_SGML_SYSTEM_ID`	Deprecated. since 1.1, use `DocbookMarkup.DEFAULT_SGML_SYSTEM_ID` instead of.
`static java.lang.String`	`DEFAULT_XML_PUBLIC_ID`	Deprecated. since 1.1, use `DocbookMarkup.DEFAULT_XML_PUBLIC_ID` instead of.
`static java.lang.String`	`DEFAULT_XML_SYSTEM_ID`	Deprecated. since 1.1, use `DocbookMarkup.DEFAULT_XML_SYSTEM_ID` instead of.

Fields inherited from interface org.apache.maven.doxia.module.docbook.DocbookMarkup
ANCHOR_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, BOOK_TAG, BOOKINFO_TAG, CHAPTER_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, CORPAUTHOR_TAG, DATE_TAG, EMAIL_TAG, ENTRY_TAG, FIGURE_TAG, FILEREF_ATTRIBUTE, FORMALPARA_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFO_TAG, INFORMALFIGURE_TAG, INFORMALTABLE_TAG, ITEMIZEDLIST_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NUMERATION_ATTRIBUTE, ORDEREDLIST_TAG, PARA_TAG, PROGRAMLISTING_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SIMPARA_TAG, TBODY_TAG, TERM_TAG, TGROUP_TAG, THEAD_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, URL_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, XREF_TAG

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.module.docbook.SimplifiedDocbookMarkup
ABBREV_TAG, ABSTRACT_TAG, ACRONYM_TAG, AFFILIATION_TAG, ANCHOR_TAG, APPENDIX_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, ATTRIBUTION_TAG, AUDIODATA_TAG, AUDIOOBJECT_TAG, AUTHOR_TAG, AUTHORBLURB_TAG, AUTHORGROUP_TAG, AUTHORINITIALS_TAG, BIBLIODIV_TAG, BIBLIOGRAPHY_TAG, BIBLIOMISC_TAG, BIBLIOMIXED_TAG, BIBLIOMSET_TAG, BLOCKQUOTE_TAG, CAPTION_TAG, CITETITLE_TAG, COL_TAG, COLGROUP_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, COMMAND_TAG, COMPUTEROUTPUT_TAG, COPYRIGHT_TAG, CORPAUTHOR_TAG, DATE_TAG, EDITION_TAG, EDITOR_TAG, EMAIL_TAG, EMPHASIS_TAG, ENTRY_TAG, ENTRYTBL_TAG, EPIGRAPH_TAG, EXAMPLE_TAG, FIGURE_TAG, FILENAME_TAG, FILEREF_ATTRIBUTE, FIRSTNAME_TAG, FOOTNOTE_TAG, FOOTNOTEREF_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, HOLDER_TAG, HONORIFIC_TAG, ID_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFORMALTABLE_TAG, INLINEMEDIAOBJECT_TAG, ISSUENUM_TAG, ITEMIZEDLIST_TAG, JOBTITLE_TAG, KEYWORD_TAG, KEYWORDSET_TAG, LANG_ATTRIBUTE, LEGALNOTICE_TAG, LINEAGE_TAG, LINEANNOTATION_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LITERAL_TAG, LITERALLAYOUT_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NOTE_TAG, NUMERATION_ATTRIBUTE, OBJECTINFO_TAG, OPTION_TAG, ORDEREDLIST_TAG, ORGNAME_TAG, OTHERCREDIT_TAG, OTHERNAME_TAG, PARA_TAG, PHRASE_TAG, PROGRAMLISTING_TAG, PUBDATE_TAG, PUBLISHERNAME_TAG, QUOTE_TAG, RELEASEINFO_TAG, REMAP_ATTRIBUTE, REPLACEABLE_TAG, REVDESCRIPTION_TAG, REVHISTORY_TAG, REVISION_TAG, REVISIONFLAG_ATTRIBUTE, REVNUMBER_TAG, REVREMARK_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SECTIONINFO_TAG, SIDEBAR_TAG, SPANSPEC_TAG, SUBJECT_TAG, SUBJECTSET_TAG, SUBJECTTERM_TAG, SUBSCRIPT_TAG, SUBTITLE_TAG, SUPERSCRIPT_TAG, SURNAME_TAG, SYSTEMITEM_TAG, TABLE_TAG, TBODY_TAG, TD_TAG, TERM_TAG, TEXTDATA_TAG, TEXTOBJECT_TAG, TFOOT_TAG, TGROUP_TAG, TH_TAG, THEAD_TAG, TITLE_TAG, TITLEABBREV_TAG, TR_TAG, TRADEMARK_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, USERINPUT_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, VIDEODATA_TAG, VIDEOOBJECT_TAG, VOLUMENUM_TAG, XREF_TAG, YEAR_TAG

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.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DocBookSink(java.io.Writer writer)`	Constructor, initialize the Writer.
`protected`	`DocBookSink(java.io.Writer writer, java.lang.String encoding)`	Constructor, initialize the Writer and tells which encoding is used.
`protected`	`DocBookSink(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 Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`
`void`	`anchor_()`
`void`	`author()`
`void`	`author_()`
`void`	`body_()`
`void`	`bold()`
`void`	`bold_()`
`void`	`close()`
`void`	`comment(java.lang.String comment)`
`protected void`	`content(java.lang.String text)`	Write SGML escaped text to output, not preserving white space.
`void`	`date()`
`void`	`date_()`
`void`	`definedTerm()`
`void`	`definedTerm_()`
`void`	`definition()`
`void`	`definition_()`
`void`	`definitionList()`
`void`	`definitionList_()`
`void`	`definitionListItem()`
`void`	`definitionListItem_()`
`static java.lang.String`	`escapeSGML(java.lang.String text, boolean xmlMode)`	Deprecated. Use HtmlTools#escapeHTML(String,boolean).
`void`	`figure()`
`void`	`figure_()`
`void`	`figureCaption()`
`void`	`figureCaption_()`
`void`	`figureGraphics(java.lang.String name)`
`void`	`flush()`
`java.lang.String`	`getBoldElement()`	Returns the current boldBeginTag.
`java.lang.String`	`getEncoding()`	Returns the encoding.
`java.lang.String`	`getHorizontalRuleElement()`	Returns the current horizontalRuleElement.
`java.lang.String`	`getItalicElement()`	Returns the current italicBeginTag.
`java.lang.String`	`getLanguage()`	Returns the current language.
`java.lang.String`	`getLineBreakElement()`	Returns the current lineBreakElement.
`java.lang.String`	`getMonospacedElement()`	Returns the current monospacedBeginTag.
`java.lang.String`	`getPageBreakElement()`	Returns the current pageBreakElement.
`java.lang.String`	`getPublicId()`	Returns the current publicId.
`java.lang.String`	`getStyleSheet()`	Returns the current styleSheet.
`java.lang.String`	`getSystemId()`	Returns the current systemId.
`protected void`	`graphicElement()`	Deprecated. do not use!
`void`	`head()`
`void`	`head_()`
`void`	`horizontalRule()`
`protected void`	`init()`
`boolean`	`isXMLMode()`	Deprecated. xml mode is not used.
`void`	`italic()`
`void`	`italic_()`
`void`	`lineBreak()`
`void`	`link(java.lang.String name)`
`void`	`link_()`
`void`	`list()`
`void`	`list_()`
`void`	`listItem()`
`void`	`listItem_()`
`protected void`	`markup(java.lang.String text)`	Write text to output, preserving white space.
`void`	`monospaced()`
`void`	`monospaced_()`
`void`	`nonBreakingSpace()`
`void`	`numberedList(int numbering)`
`void`	`numberedList_()`
`void`	`numberedListItem()`
`void`	`numberedListItem_()`
`void`	`pageBreak()`
`void`	`paragraph()`
`void`	`paragraph_()`
`protected void`	`resetState()`	Deprecated. since 1.1.2, use `init()` instead of.
`void`	`section1()`
`void`	`section1_()`
`void`	`section2()`
`void`	`section2_()`
`void`	`section3()`
`void`	`section3_()`
`void`	`section4()`
`void`	`section4_()`
`void`	`section5()`
`void`	`section5_()`
`void`	`sectionTitle()`
`void`	`sectionTitle_()`
`void`	`sectionTitle1()`
`void`	`sectionTitle1_()`
`void`	`sectionTitle2()`
`void`	`sectionTitle2_()`
`void`	`sectionTitle3()`
`void`	`sectionTitle3_()`
`void`	`sectionTitle4()`
`void`	`sectionTitle4_()`
`void`	`sectionTitle5()`
`void`	`sectionTitle5_()`
`void`	`setBoldElement(java.lang.String tag)`	Sets the current boldBeginTag and constructs the corresponding end tag from it.
`void`	`setEncoding(java.lang.String enc)`	Sets the encoding.
`void`	`setHorizontalRuleElement(java.lang.String element)`	Sets the current horizontalRuleElement.
`void`	`setItalicElement(java.lang.String tag)`	Sets the current italicBeginTag and constructs the corresponding end tag from it.
`void`	`setLanguage(java.lang.String language)`	Sets the language.
`void`	`setLineBreakElement(java.lang.String element)`	Sets the current lineBreakElement.
`void`	`setMonospacedElement(java.lang.String tag)`	Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
`void`	`setPageBreakElement(java.lang.String element)`	Sets the current pageBreakElement.
`void`	`setPublicId(java.lang.String id)`	Sets the publicId.
`void`	`setSkip(boolean skip)`	Setter for the field `skip`.
`void`	`setStyleSheet(java.lang.String sheet)`	Sets the styleSheet.
`void`	`setSystemId(java.lang.String id)`	Sets the systemId.
`void`	`setXMLMode(boolean mode)`	Deprecated. xml mode is not used.
`void`	`table()`
`void`	`table_()`
`void`	`tableCaption()`
`void`	`tableCaption_()`
`void`	`tableCell()`
`void`	`tableCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell_()`
`void`	`tableRow()`
`void`	`tableRow_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`tableRows_()`
`void`	`text(java.lang.String text)`
`void`	`title()`
`void`	`title_()`
`void`	`unknown(java.lang.String name, java.lang.Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Unknown events just log a warning message but are ignored otherwise.
`void`	`verbatim(boolean boxed)`
`void`	`verbatim_()`
`protected void`	`verbatimContent(java.lang.String text)`	Write SGML escaped text to output, preserving white space.
`protected void`	`write(java.lang.String text)`
`protected javax.swing.text.MutableAttributeSet`	`writeXmlHeader(java.lang.String root)`	writeXmlHeader.

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, writeEndTag, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, 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
anchor, author, body, body, date, definedTerm, definition, definitionList, definitionListItem, figure, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, rawText, section, section_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim

- Field Detail
  - DEFAULT_SGML_PUBLIC_ID
```
public static final java.lang.String DEFAULT_SGML_PUBLIC_ID
```
    Deprecated. since 1.1, use DocbookMarkup.DEFAULT_SGML_PUBLIC_ID instead of.
    
    DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_XML_PUBLIC_ID
```
public static final java.lang.String DEFAULT_XML_PUBLIC_ID
```
    Deprecated. since 1.1, use DocbookMarkup.DEFAULT_XML_PUBLIC_ID instead of.
    
    DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_XML_SYSTEM_ID
```
public static final java.lang.String DEFAULT_XML_SYSTEM_ID
```
    Deprecated. since 1.1, use DocbookMarkup.DEFAULT_XML_SYSTEM_ID instead of.
    
    DocBook XML V4.4 XML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SGML_SYSTEM_ID
```
public static final java.lang.String DEFAULT_SGML_SYSTEM_ID
```
    Deprecated. since 1.1, use DocbookMarkup.DEFAULT_SGML_SYSTEM_ID instead of.
    
    DocBook XML V4.4 SGML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocBookSink
```
protected DocBookSink(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.
  - DocBookSink
```
protected DocBookSink(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.
  - DocBookSink
```
protected DocBookSink(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
  - escapeSGML
```
public static final java.lang.String escapeSGML(java.lang.String text,
                                                boolean xmlMode)
```
    Deprecated. Use HtmlTools#escapeHTML(String,boolean).
    
    escapeSGML
    
    Parameters:
    
    text - The text to escape.
    
    xmlMode - xmlMode.
    
    Returns:
    
    The escaped text.
  - setXMLMode
```
public void setXMLMode(boolean mode)
```
    Deprecated. xml mode is not used.
    
    Sets the xml mode.
    
    Parameters:
    
    mode - the mode to set.
  - isXMLMode
```
public boolean isXMLMode()
```
    Deprecated. xml mode is not used.
    
    Returns the current xmlMode.
    
    Returns:
    
    the current xmlMode.
  - setEncoding
```
public void setEncoding(java.lang.String enc)
```
    Sets the encoding. The encoding specified here must be consistent with then encoding used in the Writer used by this DocBookSink instance.
    
    Parameters:
    
    enc - the encoding to set.
  - getEncoding
```
public java.lang.String getEncoding()
```
    Returns the encoding.
    
    Returns:
    
    the encoding set (can be null).
  - setStyleSheet
```
public void setStyleSheet(java.lang.String sheet)
```
    Sets the styleSheet.
    
    Parameters:
    
    sheet - the styleSheet to set.
  - getStyleSheet
```
public java.lang.String getStyleSheet()
```
    Returns the current styleSheet.
    
    Returns:
    
    the current styleSheet.
  - setPublicId
```
public void setPublicId(java.lang.String id)
```
    Sets the publicId.
    
    Parameters:
    
    id - the publicId to set.
  - getPublicId
```
public java.lang.String getPublicId()
```
    Returns the current publicId.
    
    Returns:
    
    the current publicId.
  - setSystemId
```
public void setSystemId(java.lang.String id)
```
    Sets the systemId.
    
    Parameters:
    
    id - the systemId to set.
  - getSystemId
```
public java.lang.String getSystemId()
```
    Returns the current systemId.
    
    Returns:
    
    the current systemId.
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    Sets the language.
    
    Parameters:
    
    language - the language to set.
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the current language.
    
    Returns:
    
    the current language.
  - setItalicElement
```
public void setItalicElement(java.lang.String tag)
```
    Sets the current italicBeginTag and constructs the corresponding end tag from it.
    
    Parameters:
    
    tag - the tag to set. If tag is null, the empty string is used.
  - getItalicElement
```
public java.lang.String getItalicElement()
```
    Returns the current italicBeginTag.
    
    Returns:
    
    the current italicBeginTag. Defaults to "".
  - setBoldElement
```
public void setBoldElement(java.lang.String tag)
```
    Sets the current boldBeginTag and constructs the corresponding end tag from it.
    
    Parameters:
    
    tag - the tag to set. If tag is null, the empty string is used.
  - getBoldElement
```
public java.lang.String getBoldElement()
```
    Returns the current boldBeginTag.
    
    Returns:
    
    the current boldBeginTag. Defaults to "".
  - setMonospacedElement
```
public void setMonospacedElement(java.lang.String tag)
```
    Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
    
    Parameters:
    
    tag - the tag to set. If tag is null, the empty string is used.
  - getMonospacedElement
```
public java.lang.String getMonospacedElement()
```
    Returns the current monospacedBeginTag.
    
    Returns:
    
    the current monospacedBeginTag. Defaults to ">".
  - setHorizontalRuleElement
```
public void setHorizontalRuleElement(java.lang.String element)
```
    Sets the current horizontalRuleElement.
    
    Parameters:
    
    element - the element to set.
  - getHorizontalRuleElement
```
public java.lang.String getHorizontalRuleElement()
```
    Returns the current horizontalRuleElement.
    
    Returns:
    
    the current horizontalRuleElement. Defaults to "".
  - setPageBreakElement
```
public void setPageBreakElement(java.lang.String element)
```
    Sets the current pageBreakElement.
    
    Parameters:
    
    element - the element to set.
  - getPageBreakElement
```
public java.lang.String getPageBreakElement()
```
    Returns the current pageBreakElement.
    
    Returns:
    
    the current pageBreakElement. Defaults to "".
  - setLineBreakElement
```
public void setLineBreakElement(java.lang.String element)
```
    Sets the current lineBreakElement.
    
    Parameters:
    
    element - the element to set.
  - getLineBreakElement
```
public java.lang.String getLineBreakElement()
```
    Returns the current lineBreakElement.
    
    Returns:
    
    the current lineBreakElement. Defaults to "".
  - resetState
```
protected void resetState()
```
    Deprecated. since 1.1.2, use init() instead of.
    
    Reset all variables.
  - init
```
protected void init()
```
    Overrides:
    
    init in class org.apache.maven.doxia.sink.impl.AbstractSink
  - head
```
public void head()
```
    Overrides:
    
    head in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.DEFAULT_XML_PUBLIC_ID, SimplifiedDocbookMarkup.DEFAULT_XML_SYSTEM_ID, SimplifiedDocbookMarkup.ARTICLE_TAG
  - writeXmlHeader
```
protected javax.swing.text.MutableAttributeSet writeXmlHeader(java.lang.String root)
```
    writeXmlHeader.
    
    Parameters:
    
    root - not null.
    
    Returns:
    
    an attribute set.
    
    Since:
    
    1.1
    
    See Also:
    
    SimplifiedDocbookMarkup.DEFAULT_XML_PUBLIC_ID, SimplifiedDocbookMarkup.DEFAULT_XML_SYSTEM_ID, SimplifiedDocbookMarkup.ARTICLE_TAG
  - head_
```
public void head_()
```
    Overrides:
    
    head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ARTICLEINFO_TAG
  - title
```
public void title()
```
    Overrides:
    
    title in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ARTICLEINFO_TAG, SimplifiedDocbookMarkup.TITLE_TAG
  - title_
```
public void title_()
```
    Overrides:
    
    title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - author
```
public void author()
```
    Overrides:
    
    author in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.CORPAUTHOR_TAG
  - author_
```
public void author_()
```
    Overrides:
    
    author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.CORPAUTHOR_TAG
  - date
```
public void date()
```
    Overrides:
    
    date in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.DATE_TAG
  - date_
```
public void date_()
```
    Overrides:
    
    date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.DATE_TAG
  - body_
```
public void body_()
```
    Overrides:
    
    body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ARTICLE_TAG
  - section1
```
public void section1()
```
    Overrides:
    
    section1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section1_
```
public void section1_()
```
    Overrides:
    
    section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section2
```
public void section2()
```
    Overrides:
    
    section2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section2_
```
public void section2_()
```
    Overrides:
    
    section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section3
```
public void section3()
```
    Overrides:
    
    section3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section3_
```
public void section3_()
```
    Overrides:
    
    section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section4
```
public void section4()
```
    Overrides:
    
    section4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section4_
```
public void section4_()
```
    Overrides:
    
    section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section5
```
public void section5()
```
    Overrides:
    
    section5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - section5_
```
public void section5_()
```
    Overrides:
    
    section5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.SECTION_TAG
  - sectionTitle
```
public void sectionTitle()
```
    Overrides:
    
    sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle_
```
public void sectionTitle_()
```
    Overrides:
    
    sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle1
```
public void sectionTitle1()
```
    Overrides:
    
    sectionTitle1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Overrides:
    
    sectionTitle1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle2
```
public void sectionTitle2()
```
    Overrides:
    
    sectionTitle2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Overrides:
    
    sectionTitle2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle3
```
public void sectionTitle3()
```
    Overrides:
    
    sectionTitle3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Overrides:
    
    sectionTitle3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle4
```
public void sectionTitle4()
```
    Overrides:
    
    sectionTitle4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Overrides:
    
    sectionTitle4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle5
```
public void sectionTitle5()
```
    Overrides:
    
    sectionTitle5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Overrides:
    
    sectionTitle5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - list
```
public void list()
```
    Overrides:
    
    list in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG
  - list_
```
public void list_()
```
    Overrides:
    
    list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG
  - listItem
```
public void listItem()
```
    Overrides:
    
    listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - listItem_
```
public void listItem_()
```
    Overrides:
    
    listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - numberedList
```
public void numberedList(int numbering)
```
    Overrides:
    
    numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ORDEREDLIST_TAG, SimplifiedDocbookMarkup.NUMERATION_ATTRIBUTE
  - numberedList_
```
public void numberedList_()
```
    Overrides:
    
    numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ORDEREDLIST_TAG
  - numberedListItem
```
public void numberedListItem()
```
    Overrides:
    
    numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - numberedListItem_
```
public void numberedListItem_()
```
    Overrides:
    
    numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - definitionList
```
public void definitionList()
```
    Overrides:
    
    definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.VARIABLELIST_TAG
  - definitionList_
```
public void definitionList_()
```
    Overrides:
    
    definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.VARIABLELIST_TAG
  - definitionListItem
```
public void definitionListItem()
```
    Overrides:
    
    definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.VARLISTENTRY_TAG
  - definitionListItem_
```
public void definitionListItem_()
```
    Overrides:
    
    definitionListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.VARLISTENTRY_TAG
  - definedTerm
```
public void definedTerm()
```
    Overrides:
    
    definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TERM_TAG
  - definedTerm_
```
public void definedTerm_()
```
    Overrides:
    
    definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TERM_TAG
  - definition
```
public void definition()
```
    Overrides:
    
    definition in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - definition_
```
public void definition_()
```
    Overrides:
    
    definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.LISTITEM_TAG
  - paragraph
```
public void paragraph()
```
    Overrides:
    
    paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.PARA_TAG
  - paragraph_
```
public void paragraph_()
```
    Overrides:
    
    paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.PARA_TAG
  - verbatim
```
public void verbatim(boolean boxed)
```
    Overrides:
    
    verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.PROGRAMLISTING_TAG
  - verbatim_
```
public void verbatim_()
```
    Overrides:
    
    verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.PROGRAMLISTING_TAG
  - horizontalRule
```
public void horizontalRule()
```
    Overrides:
    
    horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - pageBreak
```
public void pageBreak()
```
    Overrides:
    
    pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figure
```
public void figure()
```
    Overrides:
    
    figure in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figure_
```
public void figure_()
```
    Overrides:
    
    figure_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - graphicElement
```
protected void graphicElement()
```
    Deprecated. do not use!
    
    graphicElement
    
    See Also:
    
    SimplifiedDocbookMarkup.MEDIAOBJECT_TAG, SimplifiedDocbookMarkup.IMAGEOBJECT_TAG, SimplifiedDocbookMarkup.IMAGEDATA_TAG, SimplifiedDocbookMarkup.FORMAT_ATTRIBUTE, SimplifiedDocbookMarkup.FILEREF_ATTRIBUTE
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Overrides:
    
    figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureCaption
```
public void figureCaption()
```
    Overrides:
    
    figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.FIGURE_TAG, SimplifiedDocbookMarkup.TITLE_TAG
  - figureCaption_
```
public void figureCaption_()
```
    Overrides:
    
    figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.FIGURE_TAG, SimplifiedDocbookMarkup.TITLE_TAG
  - table
```
public void table()
```
    Overrides:
    
    table in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table_
```
public void table_()
```
    Overrides:
    
    table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.INFORMALTABLE_TAG, SimplifiedDocbookMarkup.FRAME_ATTRIBUTE, SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE, SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE, SimplifiedDocbookMarkup.TABLE_TAG
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    Overrides:
    
    tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TGROUP_TAG, SimplifiedDocbookMarkup.COLS_ATTRIBUTE, SimplifiedDocbookMarkup.COLSPEC_TAG
  - tableRows_
```
public void tableRows_()
```
    Overrides:
    
    tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TGROUP_TAG, SimplifiedDocbookMarkup.TBODY_TAG
  - tableRow
```
public void tableRow()
```
    Overrides:
    
    tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ROW_TAG
  - tableRow_
```
public void tableRow_()
```
    Overrides:
    
    tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ROW_TAG
  - tableCell
```
public void tableCell()
```
    Overrides:
    
    tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ENTRY_TAG
  - tableCell_
```
public void tableCell_()
```
    Overrides:
    
    tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ENTRY_TAG
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Overrides:
    
    tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ENTRY_TAG
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Overrides:
    
    tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ENTRY_TAG
  - tableCaption
```
public void tableCaption()
```
    Overrides:
    
    tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TABLE_TAG, SimplifiedDocbookMarkup.FRAME_ATTRIBUTE, SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE, SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE, SimplifiedDocbookMarkup.TITLE_TAG
  - tableCaption_
```
public void tableCaption_()
```
    Overrides:
    
    tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.TITLE_TAG
  - anchor
```
public void anchor(java.lang.String name)
```
    Overrides:
    
    anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ANCHOR_TAG
  - anchor_
```
public void anchor_()
```
    Overrides:
    
    anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ANCHOR_TAG
  - link
```
public void link(java.lang.String name)
```
    Overrides:
    
    link in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ULINK_TAG, SimplifiedDocbookMarkup.URL_ATTRIBUTE, SimplifiedDocbookMarkup.LINK_TAG, SimplifiedDocbookMarkup.LINKEND_ATTRIBUTE
  - link_
```
public void link_()
```
    Overrides:
    
    link_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    SimplifiedDocbookMarkup.ULINK_TAG, SimplifiedDocbookMarkup.LINK_TAG
  - italic
```
public void italic()
```
    Overrides:
    
    italic in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - italic_
```
public void italic_()
```
    Overrides:
    
    italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold
```
public void bold()
```
    Overrides:
    
    bold in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold_
```
public void bold_()
```
    Overrides:
    
    bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced
```
public void monospaced()
```
    Overrides:
    
    monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced_
```
public void monospaced_()
```
    Overrides:
    
    monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - lineBreak
```
public void lineBreak()
```
    Overrides:
    
    lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Overrides:
    
    nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - text
```
public void text(java.lang.String text)
```
    Overrides:
    
    text in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - comment
```
public void comment(java.lang.String comment)
```
    Overrides:
    
    comment in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Unknown events just log a warning message but are ignored otherwise.
    
    Overrides:
    
    unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    Sink.unknown(String,Object[],SinkEventAttributes)
  - markup
```
protected void markup(java.lang.String text)
```
    Write text to output, preserving white space.
    
    Parameters:
    
    text - The text to write.
  - content
```
protected void content(java.lang.String text)
```
    Write SGML escaped text to output, not preserving white space.
    
    Parameters:
    
    text - The text to write.
  - verbatimContent
```
protected void verbatimContent(java.lang.String text)
```
    Write SGML escaped text to output, preserving white space.
    
    Parameters:
    
    text - The text to write.
  - flush
```
public void flush()
```
    Overrides:
    
    flush in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - close
```
public void close()
```
    Overrides:
    
    close in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - write
```
protected void write(java.lang.String text)
```
    Specified by:
    
    write in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
  - setSkip
```
public void setSkip(boolean skip)
```
    Setter for the field skip.
    
    Parameters:
    
    skip - the skip to set.
    
    Since:
    
    1.1

Class DocBookSink

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.docbook.DocbookMarkup

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

Fields inherited from interface org.apache.maven.doxia.module.docbook.SimplifiedDocbookMarkup

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SGML_PUBLIC_ID

DEFAULT_XML_PUBLIC_ID

DEFAULT_XML_SYSTEM_ID

DEFAULT_SGML_SYSTEM_ID

Constructor Detail

DocBookSink

DocBookSink

DocBookSink

Method Detail

escapeSGML

setXMLMode

isXMLMode

setEncoding

getEncoding

setStyleSheet

getStyleSheet

setPublicId

getPublicId

setSystemId

getSystemId

setLanguage

getLanguage

setItalicElement

getItalicElement

setBoldElement

getBoldElement

setMonospacedElement

getMonospacedElement

setHorizontalRuleElement

getHorizontalRuleElement

setPageBreakElement

getPageBreakElement

setLineBreakElement

getLineBreakElement

resetState

init

head

writeXmlHeader

head_

title

title_

author

author_

date

date_

body_

section1

section1_

section2

section2_

section3

section3_

section4

section4_

section5

section5_

sectionTitle

sectionTitle_

sectionTitle1

sectionTitle1_

sectionTitle2

sectionTitle2_

sectionTitle3

sectionTitle3_

sectionTitle4

sectionTitle4_