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:

Sink

public class XmlWriterXdocSink
extends 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_() Ending an anchor element.
void	anchor(java.lang.String name) Starting an element which defines an anchor.
void	author_() Ending the author element.
void	body_() Ending the body element.
void	body() Starting the body of a document which contains the document's content.
void	bold_() Ending a bold element.
void	bold() Starting a bold element.
void	close() Close the writer or the stream, if needed.
protected void	content(java.lang.String text) Write HTML escaped text to output.
void	date_() Ending the date element.
void	definedTerm_() Starting a definition term element within a definition list.
void	definedTerm() Starting a definition term element within a definition list.
void	definition_() Ending a definition element within a definition list.
void	definition() Starting a definition element within a definition list.
void	definitionList_() Ending a definition list element.
void	definitionList() Starting a definition list element.
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() Flush the writer or the stream, if needed.
void	head_() Ending the head element.
void	head() Starting the head element which contains information about the current document, such as its title, that is not considered document content.
void	horizontalRule() Adding a separator of sections from a text to each other.
void	italic_() Ending an italic element.
void	italic() Starting an italic element.
void	lineBreak() Adding a line breaks.
void	link_() Ending a link element.
void	link(java.lang.String name) Starting an element which defines a link.
void	list_() Ending an unordered list element.
void	list() Starting an unordered list element.
void	listItem_() Ending a list item element within an unordered list.
void	listItem() Starting a list item element within an unordered list.
void	monospaced_() Ending a monospaced element.
void	monospaced() Starting a monospaced element.
void	nonBreakingSpace() Adding a non breaking space, ie a space without any special formatting operations.
void	numberedList_() Ending an ordered list element.
void	numberedList(int numbering) Starting an ordered list element.
void	numberedListItem_() Ending a list item element within an ordered list.
void	numberedListItem() Starting a list item element within an ordered list.
void	paragraph_() Ending a paragraph element.
void	paragraph() Starting an element which represents a paragraph.
protected void	resetState() Reset all variables.
void	section1_() Ending a first heading element.
void	section1() Starting a first heading element which contains the topic of the section.
void	section2_() Ending a second heading element.
void	section2() Starting a second heading element which contains the topic of the section.
void	section3_() Ending a third heading element.
void	section3() Starting a third heading element which contains the topic of the section.
void	section4_() Ending a 4th heading element.
void	section4() Starting a 4th heading element which contains the topic of the section.
void	section5_() Ending a 5th heading element.
void	section5() Starting a 5th heading element which contains the topic of the section.
void	sectionTitle_() Ending a title heading element.
void	sectionTitle() Starting a title heading element.
void	table_() Ending a table element.
void	table() Starting a table element for marking up tabular information in a document.
void	tableCaption_() Ending a caption element of a table.
void	tableCaption() Starting a caption element of a table.
void	tableCell_() Ending a cell element.
void	tableCell_(boolean headerRow) Ends a table cell.
void	tableCell() Starting a cell element which defines a cell that contains data.
void	tableCell(boolean headerRow) Starts a table cell.
void	tableHeaderCell_() Ending a cell header element.
void	tableHeaderCell() Starting a cell element which defines a cell that contains header information.
void	tableRow_() Ending a row element.
void	tableRow() Starting a row element which acts as a container for a row of table cells.
void	tableRows_() Ending an element contains rows of table data.
void	tableRows(int[] justification, boolean grid) Starting an element contains rows of table data.
void	text(java.lang.String text) Adding a text.
void	title_() Ending the title element.
void	verbatim_() Ending a verbatim element.
void	verbatim(boolean boxed) Starting an element which indicates that whitespace in the enclosed text has semantic relevance.
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()

Starting the head element which contains information about the current document, such as its title, that is not considered document content.

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head_

public void head_()

Ending the head element.

Specified by:

head_ in interface Sink

Overrides:

head_ in class SinkAdapter

title_

public void title_()

Ending the title element.

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author_

public void author_()

Ending the author element.

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date_

public void date_()

Ending the date element.

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

body

public void body()

Starting the body of a document which contains the document's content.

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body_

public void body_()

Ending the body element.

Specified by:

body_ in interface Sink

Overrides:

body_ in class SinkAdapter

section1

public void section1()

Starting a first heading element which contains the topic of the section.

Specified by:

section1 in interface Sink

Overrides:

section1 in class SinkAdapter

section2

public void section2()

Starting a second heading element which contains the topic of the section.

Specified by:

section2 in interface Sink

Overrides:

section2 in class SinkAdapter

section3

public void section3()

Starting a third heading element which contains the topic of the section.

Specified by:

section3 in interface Sink

Overrides:

section3 in class SinkAdapter

section4

public void section4()

Starting a 4th heading element which contains the topic of the section.

Specified by:

section4 in interface Sink

Overrides:

section4 in class SinkAdapter

section5

public void section5()

Starting a 5th heading element which contains the topic of the section.

Specified by:

section5 in interface Sink

Overrides:

section5 in class SinkAdapter

sectionTitle

public void sectionTitle()

Starting a title heading element.

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_()

Ending a title heading element.

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

section1_

public void section1_()

Ending a first heading element.

Specified by:

section1_ in interface Sink

Overrides:

section1_ in class SinkAdapter

section2_

public void section2_()

Ending a second heading element.

Specified by:

section2_ in interface Sink

Overrides:

section2_ in class SinkAdapter

section3_

public void section3_()

Ending a third heading element.

Specified by:

section3_ in interface Sink

Overrides:

section3_ in class SinkAdapter

section4_

public void section4_()

Ending a 4th heading element.

Specified by:

section4_ in interface Sink

Overrides:

section4_ in class SinkAdapter

section5_

public void section5_()

Ending a 5th heading element.

Specified by:

section5_ in interface Sink

Overrides:

section5_ in class SinkAdapter

list

public void list()

Starting an unordered list element.

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list_

public void list_()

Ending an unordered list element.

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem()

Starting a list item element within an unordered list.

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem_

public void listItem_()

Ending a list item element within an unordered list.

Specified by:

listItem_ in interface Sink

Overrides:

listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering)

Starting an ordered list element.

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

Parameters:

numbering - the numbering wanted

See Also:

Sink.NUMBERING_DECIMAL, Sink.NUMBERING_LOWER_ALPHA, Sink.NUMBERING_LOWER_ROMAN, Sink.NUMBERING_UPPER_ALPHA, Sink.NUMBERING_UPPER_ROMAN

numberedList_

public void numberedList_()

Ending an ordered list element.

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem()

Starting a list item element within an ordered list.

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem_

public void numberedListItem_()

Ending a list item element within an ordered list.

Specified by:

numberedListItem_ in interface Sink

Overrides:

numberedListItem_ in class SinkAdapter

definitionList

public void definitionList()

Starting a definition list element.

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList_

public void definitionList_()

Ending a definition list element.

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm()

Starting a definition term element within a definition list.

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm_

public void definedTerm_()

Starting a definition term element within a definition list.

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definition

public void definition()

Starting a definition element within a definition list.

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition_

public void definition_()

Ending a definition element within a definition list.

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

paragraph

public void paragraph()

Starting an element which represents a paragraph.

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph_

public void paragraph_()

Ending a paragraph element.

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Starting an element which indicates that whitespace in the enclosed text has semantic relevance.

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

Parameters:

boxed - true to add a box, false otherwise

verbatim_

public void verbatim_()

Ending a verbatim element.

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule()

Adding a separator of sections from a text to each other.

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

table

public void table()

Starting a table element for marking up tabular information in a document.

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table_

public void table_()

Ending a table element.

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

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

Starting an element contains rows of table data.

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

Parameters:

justification - the justification wanted

grid - true to provide a grid, false otherwise

tableRows_

public void tableRows_()

Ending an element contains rows of table data.

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow()

Starting a row element which acts as a container for a row of table cells.

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow_

public void tableRow_()

Ending a row element.

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell()

Starting a cell element which defines a cell that contains data.

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Starting a cell element which defines a cell that contains header information.

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class 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_()

Ending a cell element.

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Ending a cell header element.

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class 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()

Starting a caption element of a table.

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption_

public void tableCaption_()

Ending a caption element of a table.

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

anchor

public void anchor(java.lang.String name)

Starting an element which defines an anchor.

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

Parameters:

name - the name of the anchor

anchor_

public void anchor_()

Ending an anchor element.

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(java.lang.String name)

Starting an element which defines a link.

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

Parameters:

name - the name of the link

link_

public void link_()

Ending a link element.

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

italic

public void italic()

Starting an italic element.

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Ending an italic element.

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Starting a bold element.

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Ending a bold element.

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Starting a monospaced element.

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Ending a monospaced element.

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()

Adding a line breaks.

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Adding a non breaking space, ie a space without any special formatting operations.

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(java.lang.String text)

Adding a text.

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

Parameters:

text - The text to write.

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

Flush the writer or the stream, if needed.

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Close the writer or the stream, if needed.

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter