org.apache.maven.doxia.sink
public interface Sink
Doxia allows you to parse any supported input document format (ie for which a parser exists) and generate any supported output document format (ie for which a sink exists).
The upshot is that you can parse any front-end format, the parser is responsible for emitting the standard Doxia events which can then be consumed by any Doxia Sink. This is what allow us to parse the front- end format like APT, FML, and Xdoc for the Maven site plugin and have them all contribute to the final XHTML version of a site. All documents being parsed results in a stream of Doxia events (paragraph, bold, italic, text) which are then fed in the XHTML sink which results in a set of XHTML pages.
A sink is ultimately responsible for the final format and structure. So, for example, you can take a series of APT documents and have that be fed into a Sink which makes a single PDF, a book, a site, or a Word document. The Sink is fully responsible for the final output. Once you have Doxia events you can leverage any existing Sink. So if you wanted to integrate your custom XML format, or custom Wiki format, you would create a Doxia parser which could then be fed into any Sink to produce your desired final output.
Since: 1.0
Version: $Id: Sink.java 566748 2007-08-16 15:24:39Z ltheussl $
Field Summary | |
---|---|
int | NUMBERING_DECIMAL
A numbering to handle a number list. |
int | NUMBERING_LOWER_ALPHA
A numbering to handle a lower alpha list. |
int | NUMBERING_LOWER_ROMAN
A numbering to handle a lower roman list. |
int | NUMBERING_UPPER_ALPHA
A numbering to handle a upper alpha list. |
int | NUMBERING_UPPER_ROMAN
A numbering to handle a upper roman list. |
String | ROLE
The Plexus Sink Role |
int | SECTION_LEVEL_1
A level 1 section (section). |
int | SECTION_LEVEL_2
A level 2 section (subsection). |
int | SECTION_LEVEL_3
A level 3 section (sub-subsection). |
int | SECTION_LEVEL_4
A level 4 section (sub-sub-subsection). |
int | SECTION_LEVEL_5
A level 5 section (sub-sub-sub-subsection). |
Method Summary | |
---|---|
void | anchor(String name)
Starting an element which defines an anchor.
|
void | anchor_()
Ending an anchor element. |
void | author()
Starting the author element which is used to identify the author of the document. |
void | author_()
Ending the author element. |
void | body()
Starting the body of a document which contains the document's content. |
void | body_()
Ending the body element. |
void | bold()
Starting a bold element. |
void | bold_()
Ending a bold element. |
void | close()
Close the writer or the stream, if needed. |
void | date()
Starting the date element which is used to identify the date of the document. |
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()
Starting a definition element within a definition list. |
void | definitionList()
Starting a definition list element. |
void | definitionListItem()
Starting a list item element within a definition list. |
void | definitionListItem_()
Ending a list item element within a definition list. |
void | definitionList_()
Ending a definition list element. |
void | definition_()
Ending a definition element within a definition list. |
void | figure()
Starting a basic image embedding element. |
void | figureCaption()
Starting a caption of an image element. |
void | figureCaption_()
Ending a caption of an image. |
void | figureGraphics(String name)
Adding a source of a graphic.
|
void | figure_()
Ending a basic image embedding element. |
void | flush()
Flush the writer or the stream, if needed. |
void | head()
Starting the head element which contains information about the current document,
such as its title, that is not considered document content. |
void | head_()
Ending the head element. |
void | horizontalRule()
Adding a separator of sections from a text to each other. |
void | italic()
Starting an italic element. |
void | italic_()
Ending an italic element. |
void | lineBreak()
Adding a line breaks. |
void | link(String name)
Starting an element which defines a link.
|
void | link_()
Ending a link element. |
void | list()
Starting an unordered list element. |
void | listItem()
Starting a list item element within an unordered list. |
void | listItem_()
Ending a list item element within an unordered list. |
void | list_()
Ending an unordered list element. |
void | monospaced()
Starting a monospaced element. |
void | monospaced_()
Ending a monospaced element. |
void | nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations. |
void | numberedList(int numbering)
Starting an ordered list element.
|
void | numberedListItem()
Starting a list item element within an ordered list. |
void | numberedListItem_()
Ending a list item element within an ordered list. |
void | numberedList_()
Ending an ordered list element. |
void | pageBreak()
Adding a new page separator. |
void | paragraph()
Starting an element which represents a paragraph. |
void | paragraph_()
Ending a paragraph element. |
void | rawText(String text)
Adding a raw text, ie a text without any special formatting operations.
|
void | section1()
Starting a first heading element which contains the topic of the section. |
void | section1_()
Ending a first heading element. |
void | section2()
Starting a second heading element which contains the topic of the section. |
void | section2_()
Ending a second heading element. |
void | section3()
Starting a third heading element which contains the topic of the section. |
void | section3_()
Ending a third heading element. |
void | section4()
Starting a 4th heading element which contains the topic of the section. |
void | section4_()
Ending a 4th heading element. |
void | section5()
Starting a 5th heading element which contains the topic of the section. |
void | section5_()
Ending a 5th heading element. |
void | sectionTitle()
Starting a title heading element. |
void | sectionTitle1()
Starting a first title heading element. |
void | sectionTitle1_()
Ending a first title heading element. |
void | sectionTitle2()
Starting a second title heading element. |
void | sectionTitle2_()
Ending a second title heading element. |
void | sectionTitle3()
Starting a third title heading element. |
void | sectionTitle3_()
Ending a third title heading element. |
void | sectionTitle4()
Starting a 4th title heading element. |
void | sectionTitle4_()
Ending a 4th title heading element. |
void | sectionTitle5()
Starting a 5th title heading element. |
void | sectionTitle5_()
Ending a 5th title heading element. |
void | sectionTitle_()
Ending a title heading element. |
void | table()
Starting a table element for marking up tabular information in a document. |
void | tableCaption()
Starting a caption element of a table. |
void | tableCaption_()
Ending a caption element of a table. |
void | tableCell()
Starting a cell element which defines a cell that contains data. |
void | tableCell(String width)
Starting a cell element which defines a cell that contains data.
|
void | tableCell_()
Ending a cell element. |
void | tableHeaderCell()
Starting a cell element which defines a cell that contains header information. |
void | tableHeaderCell(String width)
Starting a cell element which defines a cell that contains header information.
|
void | tableHeaderCell_()
Ending a cell header element. |
void | tableRow()
Starting a row element which acts as a container for a row of table cells. |
void | tableRows(int[] justification, boolean grid)
Starting an element contains rows of table data.
|
void | tableRows_()
Ending an element contains rows of table data. |
void | tableRow_()
Ending a row element. |
void | table_()
Ending a table element. |
void | text(String text)
Adding a text.
|
void | title()
Starting the title element which is used to identify the document. |
void | title_()
Ending the title element. |
void | verbatim(boolean boxed)
Starting an element which indicates that whitespace in the enclosed text has semantic relevance.
|
void | verbatim_()
Ending a verbatim element. |
See Also: Sink
See Also: Sink
See Also: Sink
See Also: Sink
See Also: Sink
See Also: section1
See Also: section2
See Also: section3
See Also: section4
See Also: section5
Parameters: name the name of the anchor
Parameters: name the source
Parameters: name the name of the link
Parameters: numbering the numbering wanted
See Also: NUMBERING_DECIMAL NUMBERING_LOWER_ALPHA NUMBERING_LOWER_ROMAN NUMBERING_UPPER_ALPHA NUMBERING_UPPER_ROMAN
Parameters: text The text to write.
Parameters: width the size of the cell
Parameters: width the size of the header cell
Parameters: justification the justification wanted grid true to provide a grid, false otherwise
Parameters: text The text to write.
Parameters: boxed true to add a box, false otherwise