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 599204 2007-11-28 23:49:33Z hboutemy $

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(XMLWriter out)
Constructor, initialize the XMLWriter.

Method Summary

void	anchor_()
void	anchor(String name)
void	author_()
void	body_()
void	body()
void	bold_()
void	bold()
void	close()
protected void	content(String text) Write HTML escaped text to output.
void	date_()
void	definedTerm_()
void	definedTerm()
void	definition_()
void	definition()
void	definitionList_()
void	definitionList()
static String	encodeURL(String text) Forward to HtmlTools.encodeURL( text ).
static String	escapeHTML(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(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(String text)
void	title_()
void	verbatim_()
void	verbatim(boolean boxed)
protected void	verbatimContent(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(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()

head_

public void head_()

title_

public void title_()

author_

public void author_()

date_

public void date_()

body

public void body()

body_

public void body_()

section1

public void section1()

section2

public void section2()

section3

public void section3()

section4

public void section4()

section5

public void section5()

sectionTitle

public void sectionTitle()

sectionTitle_

public void sectionTitle_()

section1_

public void section1_()

section2_

public void section2_()

section3_

public void section3_()

section4_

public void section4_()

section5_

public void section5_()

list

public void list()

list_

public void list_()

listItem

public void listItem()

listItem_

public void listItem_()

numberedList

public void numberedList(int numbering)

numberedList_

public void numberedList_()

numberedListItem

public void numberedListItem()

numberedListItem_

public void numberedListItem_()

definitionList

public void definitionList()

definitionList_

public void definitionList_()

definedTerm

public void definedTerm()

definedTerm_

public void definedTerm_()

definition

public void definition()

definition_

public void definition_()

paragraph

public void paragraph()

paragraph_

public void paragraph_()

verbatim

public void verbatim(boolean boxed)

verbatim_

public void verbatim_()

horizontalRule

public void horizontalRule()

table

public void table()

table_

public void table_()

tableRows

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

tableRows_

public void tableRows_()

tableRow

public void tableRow()

tableRow_

public void tableRow_()

tableCell

public void tableCell()

tableHeaderCell

public void tableHeaderCell()

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

tableHeaderCell_

public void tableHeaderCell_()

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

tableCaption_

public void tableCaption_()

anchor

public void anchor(String name)

anchor_

public void anchor_()

link

public void link(String name)

link_

public void link_()

italic

public void italic()

italic_

public void italic_()

bold

public void bold()

bold_

public void bold_()

monospaced

public void monospaced()

monospaced_

public void monospaced_()

lineBreak

public void lineBreak()

nonBreakingSpace

public void nonBreakingSpace()

text

public void text(String text)

content

protected void content(String text)

Write HTML escaped text to output.

Parameters:

text - The text to write.

verbatimContent

protected void verbatimContent(String text)

Write text to output, preserving white space.

Parameters:

text - The text to write.

escapeHTML

public static String escapeHTML(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 String encodeURL(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()

close

public void close()