org.apache.maven.doxia.sink
Class SinkAdapter

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
All Implemented Interfaces:
Sink
Direct Known Subclasses:
AbstractTextSink, AbstractXhtmlSink, AbstractXmlSink, IndexingSink, ITextSink, RtfSink, XmlWriterXdocSink

public class SinkAdapter
extends java.lang.Object
implements Sink

Empty implementation of the Sink interface. Useful for testing purposes.

Since:
1.0
Version:
$Id: SinkAdapter.java 559578 2007-07-25 20:12:56Z ltheussl $
Author:
Jason van Zyl, Vincent Siveton

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
SinkAdapter()
           
 
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 author()
          Starting the author element which is used to identify the author of the document.
 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.
 void date_()
          Ending the date element.
 void date()
          Starting the date element which is used to identify the date of the document.
 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.
 void definitionListItem_()
          Ending a list item element within a definition list.
 void definitionListItem()
          Starting a list item element within a definition list.
 void figure_()
          Ending a basic image embedding element.
 void figure()
          Starting a basic image embedding element.
 void figureCaption_()
          Ending a caption of an image.
 void figureCaption()
          Starting a caption of an image element.
 void figureGraphics(java.lang.String name)
          Adding a source of a graphic.
 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 pageBreak()
          Adding a new page separator.
 void paragraph_()
          Ending a paragraph element.
 void paragraph()
          Starting an element which represents a paragraph.
 void rawText(java.lang.String text)
          Adding a raw text, ie a text without any special formatting operations.
 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 sectionTitle1_()
          Ending a first title heading element.
 void sectionTitle1()
          Starting a first title heading element.
 void sectionTitle2_()
          Ending a second title heading element.
 void sectionTitle2()
          Starting a second title heading element.
 void sectionTitle3_()
          Ending a third title heading element.
 void sectionTitle3()
          Starting a third title heading element.
 void sectionTitle4_()
          Ending a 4th title heading element.
 void sectionTitle4()
          Starting a 4th title heading element.
 void sectionTitle5_()
          Ending a 5th title heading element.
 void sectionTitle5()
          Starting a 5th 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()
          Starting a cell element which defines a cell that contains data.
 void tableCell(java.lang.String width)
          Starting a cell element which defines a cell that contains data.
 void tableHeaderCell_()
          Ending a cell header element.
 void tableHeaderCell()
          Starting a cell element which defines a cell that contains header information.
 void tableHeaderCell(java.lang.String width)
          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 title()
          Starting the title element which is used to identify the document.
 void verbatim_()
          Ending a verbatim element.
 void verbatim(boolean boxed)
          Starting an element which indicates that whitespace in the enclosed text has semantic relevance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SinkAdapter

public SinkAdapter()
Method Detail

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

head_

public void head_()
Ending the head element.

Specified by:
head_ in interface Sink

body

public void body()
Starting the body of a document which contains the document's content.

Specified by:
body in interface Sink

body_

public void body_()
Ending the body element.

Specified by:
body_ in interface Sink

section1

public void section1()
Starting a first heading element which contains the topic of the section.

Specified by:
section1 in interface Sink

section1_

public void section1_()
Ending a first heading element.

Specified by:
section1_ in interface Sink

section2

public void section2()
Starting a second heading element which contains the topic of the section.

Specified by:
section2 in interface Sink

section2_

public void section2_()
Ending a second heading element.

Specified by:
section2_ in interface Sink

section3

public void section3()
Starting a third heading element which contains the topic of the section.

Specified by:
section3 in interface Sink

section3_

public void section3_()
Ending a third heading element.

Specified by:
section3_ in interface Sink

section4

public void section4()
Starting a 4th heading element which contains the topic of the section.

Specified by:
section4 in interface Sink

section4_

public void section4_()
Ending a 4th heading element.

Specified by:
section4_ in interface Sink

section5

public void section5()
Starting a 5th heading element which contains the topic of the section.

Specified by:
section5 in interface Sink

section5_

public void section5_()
Ending a 5th heading element.

Specified by:
section5_ in interface Sink

list

public void list()
Starting an unordered list element.

Specified by:
list in interface Sink

list_

public void list_()
Ending an unordered list element.

Specified by:
list_ in interface Sink

listItem

public void listItem()
Starting a list item element within an unordered list.

Specified by:
listItem in interface Sink

listItem_

public void listItem_()
Ending a list item element within an unordered list.

Specified by:
listItem_ in interface Sink

numberedList

public void numberedList(int numbering)
Starting an ordered list element.

Specified by:
numberedList in interface Sink
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

numberedListItem

public void numberedListItem()
Starting a list item element within an ordered list.

Specified by:
numberedListItem in interface Sink

numberedListItem_

public void numberedListItem_()
Ending a list item element within an ordered list.

Specified by:
numberedListItem_ in interface Sink

definitionList

public void definitionList()
Starting a definition list element.

Specified by:
definitionList in interface Sink

definitionList_

public void definitionList_()
Ending a definition list element.

Specified by:
definitionList_ in interface Sink

definitionListItem

public void definitionListItem()
Starting a list item element within a definition list.

Specified by:
definitionListItem in interface Sink

definitionListItem_

public void definitionListItem_()
Ending a list item element within a definition list.

Specified by:
definitionListItem_ in interface Sink

definition

public void definition()
Starting a definition element within a definition list.

Specified by:
definition in interface Sink

definition_

public void definition_()
Ending a definition element within a definition list.

Specified by:
definition_ in interface Sink

figure

public void figure()
Starting a basic image embedding element.

Specified by:
figure in interface Sink

figure_

public void figure_()
Ending a basic image embedding element.

Specified by:
figure_ in interface Sink

table

public void table()
Starting a table element for marking up tabular information in a document.

Specified by:
table in interface Sink

table_

public void table_()
Ending a table element.

Specified by:
table_ in interface Sink

tableRows

public void tableRows(int[] justification,
                      boolean grid)
Starting an element contains rows of table data.

Specified by:
tableRows in interface Sink
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

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

tableRow_

public void tableRow_()
Ending a row element.

Specified by:
tableRow_ in interface Sink

title

public void title()
Starting the title element which is used to identify the document.

Specified by:
title in interface Sink

title_

public void title_()
Ending the title element.

Specified by:
title_ in interface Sink

author

public void author()
Starting the author element which is used to identify the author of the document.

Specified by:
author in interface Sink

author_

public void author_()
Ending the author element.

Specified by:
author_ in interface Sink

date

public void date()
Starting the date element which is used to identify the date of the document.

Specified by:
date in interface Sink

date_

public void date_()
Ending the date element.

Specified by:
date_ in interface Sink

sectionTitle

public void sectionTitle()
Starting a title heading element.

Specified by:
sectionTitle in interface Sink

sectionTitle_

public void sectionTitle_()
Ending a title heading element.

Specified by:
sectionTitle_ in interface Sink

sectionTitle1

public void sectionTitle1()
Starting a first title heading element.

Specified by:
sectionTitle1 in interface Sink

sectionTitle1_

public void sectionTitle1_()
Ending a first title heading element.

Specified by:
sectionTitle1_ in interface Sink

sectionTitle2

public void sectionTitle2()
Starting a second title heading element.

Specified by:
sectionTitle2 in interface Sink

sectionTitle2_

public void sectionTitle2_()
Ending a second title heading element.

Specified by:
sectionTitle2_ in interface Sink

sectionTitle3

public void sectionTitle3()
Starting a third title heading element.

Specified by:
sectionTitle3 in interface Sink

sectionTitle3_

public void sectionTitle3_()
Ending a third title heading element.

Specified by:
sectionTitle3_ in interface Sink

sectionTitle4

public void sectionTitle4()
Starting a 4th title heading element.

Specified by:
sectionTitle4 in interface Sink

sectionTitle4_

public void sectionTitle4_()
Ending a 4th title heading element.

Specified by:
sectionTitle4_ in interface Sink

sectionTitle5

public void sectionTitle5()
Starting a 5th title heading element.

Specified by:
sectionTitle5 in interface Sink

sectionTitle5_

public void sectionTitle5_()
Ending a 5th title heading element.

Specified by:
sectionTitle5_ in interface Sink

paragraph

public void paragraph()
Starting an element which represents a paragraph.

Specified by:
paragraph in interface Sink

paragraph_

public void paragraph_()
Ending a paragraph element.

Specified by:
paragraph_ in interface Sink

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
Parameters:
boxed - true to add a box, false otherwise

verbatim_

public void verbatim_()
Ending a verbatim element.

Specified by:
verbatim_ in interface Sink

definedTerm

public void definedTerm()
Starting a definition term element within a definition list.

Specified by:
definedTerm in interface Sink

definedTerm_

public void definedTerm_()
Starting a definition term element within a definition list.

Specified by:
definedTerm_ in interface Sink

figureCaption

public void figureCaption()
Starting a caption of an image element.

Specified by:
figureCaption in interface Sink

figureCaption_

public void figureCaption_()
Ending a caption of an image.

Specified by:
figureCaption_ in interface Sink

tableCell

public void tableCell()
Starting a cell element which defines a cell that contains data.

Specified by:
tableCell in interface Sink

tableCell

public void tableCell(java.lang.String width)
Starting a cell element which defines a cell that contains data.

Specified by:
tableCell in interface Sink
Parameters:
width - the size of the cell

tableCell_

public void tableCell_()
Ending a cell element.

Specified by:
tableCell_ in interface Sink

tableHeaderCell

public void tableHeaderCell()
Starting a cell element which defines a cell that contains header information.

Specified by:
tableHeaderCell in interface Sink

tableHeaderCell

public void tableHeaderCell(java.lang.String width)
Starting a cell element which defines a cell that contains header information.

Specified by:
tableHeaderCell in interface Sink
Parameters:
width - the size of the header cell

tableHeaderCell_

public void tableHeaderCell_()
Ending a cell header element.

Specified by:
tableHeaderCell_ in interface Sink

tableCaption

public void tableCaption()
Starting a caption element of a table.

Specified by:
tableCaption in interface Sink

tableCaption_

public void tableCaption_()
Ending a caption element of a table.

Specified by:
tableCaption_ in interface Sink

figureGraphics

public void figureGraphics(java.lang.String name)
Adding a source of a graphic.

Specified by:
figureGraphics in interface Sink
Parameters:
name - the source

horizontalRule

public void horizontalRule()
Adding a separator of sections from a text to each other.

Specified by:
horizontalRule in interface Sink

pageBreak

public void pageBreak()
Adding a new page separator.

Specified by:
pageBreak in interface Sink

anchor

public void anchor(java.lang.String name)
Starting an element which defines an anchor.

Specified by:
anchor in interface Sink
Parameters:
name - the name of the anchor

anchor_

public void anchor_()
Ending an anchor element.

Specified by:
anchor_ in interface Sink

link

public void link(java.lang.String name)
Starting an element which defines a link.

Specified by:
link in interface Sink
Parameters:
name - the name of the link

link_

public void link_()
Ending a link element.

Specified by:
link_ in interface Sink

italic

public void italic()
Starting an italic element.

Specified by:
italic in interface Sink

italic_

public void italic_()
Ending an italic element.

Specified by:
italic_ in interface Sink

bold

public void bold()
Starting a bold element.

Specified by:
bold in interface Sink

bold_

public void bold_()
Ending a bold element.

Specified by:
bold_ in interface Sink

monospaced

public void monospaced()
Starting a monospaced element.

Specified by:
monospaced in interface Sink

monospaced_

public void monospaced_()
Ending a monospaced element.

Specified by:
monospaced_ in interface Sink

lineBreak

public void lineBreak()
Adding a line breaks.

Specified by:
lineBreak in interface Sink

nonBreakingSpace

public void nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations.

Specified by:
nonBreakingSpace in interface Sink

text

public void text(java.lang.String text)
Adding a text.

Specified by:
text in interface Sink
Parameters:
text - The text to write.

rawText

public void rawText(java.lang.String text)
Adding a raw text, ie a text without any special formatting operations.

Specified by:
rawText in interface Sink
Parameters:
text - The text to write.

flush

public void flush()
Flush the writer or the stream, if needed.

Specified by:
flush in interface Sink

close

public void close()
Close the writer or the stream, if needed.

Specified by:
close in interface Sink


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.