org.apache.maven.doxia.module.xdoc
Class XmlWriterXdocSink

java.lang.Object
  org.apache.maven.doxia.sink.SinkAdapter
      org.apache.maven.doxia.module.xdoc.XmlWriterXdocSink

All Implemented Interfaces:

org.apache.maven.doxia.sink.Sink

public class XmlWriterXdocSink
extends org.apache.maven.doxia.sink.SinkAdapter

A doxia Sink which produces an xdoc document.

Version:

$Id: XmlWriterXdocSink.java 562700 2007-08-04 11:54:11Z vsiveton $

Author:

juan James Taylor, Juan F. Codagnone (replaced println with XmlWriterXdocSink)

Field Summary

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

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

Constructor Summary

XmlWriterXdocSink(org.codehaus.plexus.util.xml.XMLWriter out)
Constructor, initialize the XMLWriter.

Method Summary

void	anchor_()
void	anchor(java.lang.String name)
void	author_()
void	body_()
void	body()
void	bold_()
void	bold()
void	close()
protected void	content(java.lang.String text) Write HTML escaped text to output.
void	date_()
void	definedTerm_()
void	definedTerm()
void	definition_()
void	definition()
void	definitionList_()
void	definitionList()
static java.lang.String	encodeURL(java.lang.String text) Forward to HtmlTools.encodeURL( text ).
static java.lang.String	escapeHTML(java.lang.String text) Forward to HtmlTools.escapeHTML( text ).
void	flush()
void	head_()
void	head()
void	horizontalRule()
void	italic_()
void	italic()
void	lineBreak()
void	link_()
void	link(java.lang.String name)
void	list_()
void	list()
void	listItem_()
void	listItem()
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering)
void	numberedListItem_()
void	numberedListItem()
void	paragraph_()
void	paragraph()
protected void	resetState() Reset all variables.
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	table_()
void	table()
void	tableCaption_()
void	tableCaption()
void	tableCell_()
void	tableCell_(boolean headerRow) Ends a table cell.
void	tableCell()
void	tableCell(boolean headerRow) Starts a table cell.
void	tableHeaderCell_()
void	tableHeaderCell()
void	tableRow_()
void	tableRow()
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(java.lang.String text)
void	title_()
void	verbatim_()
void	verbatim(boolean boxed)
protected void	verbatimContent(java.lang.String text) Write text to output, preserving white space.

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

author, date, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, pageBreak, rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell, title

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriterXdocSink

public XmlWriterXdocSink(org.codehaus.plexus.util.xml.XMLWriter out)

Constructor, initialize the XMLWriter.

Parameters:

out - The XMLWriter to write the result.

Method Detail

resetState

protected void resetState()

Reset all variables.

head

public void head()

Specified by:

head in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

head_

public void head_()

Specified by:

head_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

title_

public void title_()

Specified by:

title_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

author_

public void author_()

Specified by:

author_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

date_

public void date_()

Specified by:

date_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

body

public void body()

Specified by:

body in interface org.apache.maven.doxia.sink.Sink

Overrides:

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

body_

public void body_()

Specified by:

body_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

body_ in class org.apache.maven.doxia.sink.SinkAdapter

section1

public void section1()

Specified by:

section1 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1 in class org.apache.maven.doxia.sink.SinkAdapter

section2

public void section2()

Specified by:

section2 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2 in class org.apache.maven.doxia.sink.SinkAdapter

section3

public void section3()

Specified by:

section3 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3 in class org.apache.maven.doxia.sink.SinkAdapter

section4

public void section4()

Specified by:

section4 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4 in class org.apache.maven.doxia.sink.SinkAdapter

section5

public void section5()

Specified by:

section5 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle

public void sectionTitle()

Specified by:

sectionTitle in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle_

public void sectionTitle_()

Specified by:

sectionTitle_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle_ in class org.apache.maven.doxia.sink.SinkAdapter

section1_

public void section1_()

Specified by:

section1_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1_ in class org.apache.maven.doxia.sink.SinkAdapter

section2_

public void section2_()

Specified by:

section2_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2_ in class org.apache.maven.doxia.sink.SinkAdapter

section3_

public void section3_()

Specified by:

section3_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3_ in class org.apache.maven.doxia.sink.SinkAdapter

section4_

public void section4_()

Specified by:

section4_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4_ in class org.apache.maven.doxia.sink.SinkAdapter

section5_

public void section5_()

Specified by:

section5_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5_ in class org.apache.maven.doxia.sink.SinkAdapter

list

public void list()

Specified by:

list in interface org.apache.maven.doxia.sink.Sink

Overrides:

list in class org.apache.maven.doxia.sink.SinkAdapter

list_

public void list_()

Specified by:

list_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

list_ in class org.apache.maven.doxia.sink.SinkAdapter

listItem

public void listItem()

Specified by:

listItem in interface org.apache.maven.doxia.sink.Sink

Overrides:

listItem in class org.apache.maven.doxia.sink.SinkAdapter

listItem_

public void listItem_()

Specified by:

listItem_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

listItem_ in class org.apache.maven.doxia.sink.SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedList in class org.apache.maven.doxia.sink.SinkAdapter

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedList_ in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedListItem in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedListItem_ in class org.apache.maven.doxia.sink.SinkAdapter

definitionList

public void definitionList()

Specified by:

definitionList in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionList in class org.apache.maven.doxia.sink.SinkAdapter

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionList_ in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface org.apache.maven.doxia.sink.Sink

Overrides:

definedTerm in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definedTerm_ in class org.apache.maven.doxia.sink.SinkAdapter

definition

public void definition()

Specified by:

definition in interface org.apache.maven.doxia.sink.Sink

Overrides:

definition in class org.apache.maven.doxia.sink.SinkAdapter

definition_

public void definition_()

Specified by:

definition_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definition_ in class org.apache.maven.doxia.sink.SinkAdapter

paragraph

public void paragraph()

Specified by:

paragraph in interface org.apache.maven.doxia.sink.Sink

Overrides:

paragraph in class org.apache.maven.doxia.sink.SinkAdapter

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

paragraph_ in class org.apache.maven.doxia.sink.SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface org.apache.maven.doxia.sink.Sink

Overrides:

verbatim in class org.apache.maven.doxia.sink.SinkAdapter

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

verbatim_ in class org.apache.maven.doxia.sink.SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface org.apache.maven.doxia.sink.Sink

Overrides:

horizontalRule in class org.apache.maven.doxia.sink.SinkAdapter

table

public void table()

Specified by:

table in interface org.apache.maven.doxia.sink.Sink

Overrides:

table in class org.apache.maven.doxia.sink.SinkAdapter

table_

public void table_()

Specified by:

table_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

table_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:

tableRows in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRows in class org.apache.maven.doxia.sink.SinkAdapter

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRows_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRow

public void tableRow()

Specified by:

tableRow in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRow in class org.apache.maven.doxia.sink.SinkAdapter

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRow_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCell

public void tableCell()

Specified by:

tableCell in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCell in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableHeaderCell in class org.apache.maven.doxia.sink.SinkAdapter

tableCell

public void tableCell(boolean headerRow)

Starts a table cell.

Parameters:

headerRow - If this cell is part of a header row.

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableHeaderCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCell_

public void tableCell_(boolean headerRow)

Ends a table cell.

Parameters:

headerRow - If this cell is part of a header row.

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCaption in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCaption_ in class org.apache.maven.doxia.sink.SinkAdapter

anchor

public void anchor(java.lang.String name)

Specified by:

anchor in interface org.apache.maven.doxia.sink.Sink

Overrides:

anchor in class org.apache.maven.doxia.sink.SinkAdapter

anchor_

public void anchor_()

Specified by:

anchor_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

anchor_ in class org.apache.maven.doxia.sink.SinkAdapter

link

public void link(java.lang.String name)

Specified by:

link in interface org.apache.maven.doxia.sink.Sink

Overrides:

link in class org.apache.maven.doxia.sink.SinkAdapter

link_

public void link_()

Specified by:

link_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

link_ in class org.apache.maven.doxia.sink.SinkAdapter

italic

public void italic()

Specified by:

italic in interface org.apache.maven.doxia.sink.Sink

Overrides:

italic in class org.apache.maven.doxia.sink.SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

italic_ in class org.apache.maven.doxia.sink.SinkAdapter

bold

public void bold()

Specified by:

bold in interface org.apache.maven.doxia.sink.Sink

Overrides:

bold in class org.apache.maven.doxia.sink.SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

bold_ in class org.apache.maven.doxia.sink.SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface org.apache.maven.doxia.sink.Sink

Overrides:

monospaced in class org.apache.maven.doxia.sink.SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

monospaced_ in class org.apache.maven.doxia.sink.SinkAdapter

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface org.apache.maven.doxia.sink.Sink

Overrides:

lineBreak in class org.apache.maven.doxia.sink.SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink

Overrides:

nonBreakingSpace in class org.apache.maven.doxia.sink.SinkAdapter

text

public void text(java.lang.String text)

Specified by:

text in interface org.apache.maven.doxia.sink.Sink

Overrides:

text in class org.apache.maven.doxia.sink.SinkAdapter

content

protected void content(java.lang.String text)

Write HTML escaped text to output.

Parameters:

text - The text to write.

verbatimContent

protected void verbatimContent(java.lang.String text)

Write text to output, preserving white space.

Parameters:

text - The text to write.

escapeHTML

public static java.lang.String escapeHTML(java.lang.String text)

Forward to HtmlTools.escapeHTML( text ).

Parameters:

text - the String to escape, may be null

Returns:

the text escaped, "" if null String input

See Also:

HtmlTools.escapeHTML(String).

encodeURL

public static java.lang.String encodeURL(java.lang.String text)

Forward to HtmlTools.encodeURL( text ).

Parameters:

text - the String to encode, may be null.

Returns:

the text encoded, null if null String input.

See Also:

HtmlTools.encodeURL(String).

flush

public void flush()

Specified by:

flush in interface org.apache.maven.doxia.sink.Sink

Overrides:

flush in class org.apache.maven.doxia.sink.SinkAdapter

close

public void close()

Specified by:

close in interface org.apache.maven.doxia.sink.Sink

Overrides:

close in class org.apache.maven.doxia.sink.SinkAdapter