java.lang.Object
- org.apache.maven.doxia.sink.impl.AbstractSink
- - org.apache.maven.doxia.sink.impl.SinkAdapter

All Implemented Interfaces:

LogEnabled, Markup, Sink

Direct Known Subclasses:

AbstractTextSink, AbstractXhtmlSink, AbstractXmlSink, IndexingSink
```
public class SinkAdapter
extends AbstractSink
```
Empty implementation of the Sink interface. Useful for testing purposes.

Since:

1.0

Version:

$Id: SinkAdapter.java 1726565 2016-01-24 21:10:19Z rfscholte $

Author:

Jason van Zyl, Vincent Siveton

Field Summary
- Fields inherited from interface org.apache.maven.doxia.markup.Markup
  COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
- Fields inherited from interface org.apache.maven.doxia.sink.Sink
  JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, 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, SECTION_LEVEL_6

Constructor Summary

Constructors
Constructor Description

SinkAdapter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`	Starts an element which defines an anchor.
`void`	`anchor(java.lang.String name, SinkEventAttributes attributes)`	Starts an element which defines an anchor.
`void`	`anchor_()`	Ends an anchor element.
`void`	`author()`	Starts an author element.
`void`	`author(SinkEventAttributes attributes)`	Starts an author element.
`void`	`author_()`	Ends an author element.
`void`	`body()`	Starts the body of a document.
`void`	`body(SinkEventAttributes attributes)`	Starts the body of a document.
`void`	`body_()`	Ends the body element.
`void`	`bold()`	Starts a bold element.
`void`	`bold_()`	Ends a bold element.
`void`	`close()`	Close the writer or the stream, if needed.
`void`	`comment(java.lang.String comment)`	Add a comment.
`void`	`date()`	Starts the date element.
`void`	`date(SinkEventAttributes attributes)`	Starts the date element.
`void`	`date_()`	Ends the date element.
`void`	`definedTerm()`	Starts a definition term element within a definition list.
`void`	`definedTerm(SinkEventAttributes attributes)`	Starts a definition term element within a definition list.
`void`	`definedTerm_()`	Starts a definition term element within a definition list.
`void`	`definition()`	Starts a definition element within a definition list.
`void`	`definition(SinkEventAttributes attributes)`	Starts a definition element within a definition list.
`void`	`definition_()`	Ends a definition element within a definition list.
`void`	`definitionList()`	Starts a definition list element.
`void`	`definitionList(SinkEventAttributes attributes)`	Starts a definition list.
`void`	`definitionList_()`	Ends a definition list element.
`void`	`definitionListItem()`	Starts a list item element within a definition list.
`void`	`definitionListItem(SinkEventAttributes attributes)`	Starts a list item element within a definition list.
`void`	`definitionListItem_()`	Ends a list item element within a definition list.
`void`	`figure()`	Starts a basic image embedding element.
`void`	`figure(SinkEventAttributes attributes)`	Starts a basic image embedding element.
`void`	`figure_()`	Ends a basic image embedding element.
`void`	`figureCaption()`	Starts a caption of an image element.
`void`	`figureCaption(SinkEventAttributes attributes)`	Starts a figure caption.
`void`	`figureCaption_()`	Ends a caption of an image.
`void`	`figureGraphics(java.lang.String name)`	Adding a source of a graphic.
`void`	`figureGraphics(java.lang.String src, SinkEventAttributes attributes)`	Adds a graphic element.
`void`	`flush()`	Flush the writer or the stream, if needed.
`void`	`head()`	Starts the head element.
`void`	`head(SinkEventAttributes attributes)`	Starts the head element.
`void`	`head_()`	Ends the head element.
`void`	`horizontalRule()`	Adding a separator of sections from a text to each other.
`void`	`horizontalRule(SinkEventAttributes attributes)`	Adds a horizontal separator rule.
`void`	`italic()`	Starts an italic element.
`void`	`italic_()`	Ends an italic element.
`void`	`lineBreak()`	Adds a line break.
`void`	`lineBreak(SinkEventAttributes attributes)`	Adds a line break.
`void`	`link(java.lang.String name)`	Starts an element which defines a link.
`void`	`link(java.lang.String name, SinkEventAttributes attributes)`	Starts a link.
`void`	`link_()`	Ends a link element.
`void`	`list()`	Starts an unordered list element.
`void`	`list(SinkEventAttributes attributes)`	Starts an unordered list.
`void`	`list_()`	Ends an unordered list element.
`void`	`listItem()`	Starts a list item element within an unordered list.
`void`	`listItem(SinkEventAttributes attributes)`	Starts a list item element within an unordered list.
`void`	`listItem_()`	Ends a list item element within an unordered list.
`void`	`monospaced()`	Starts a monospaced element.
`void`	`monospaced_()`	Ends a monospaced element.
`void`	`nonBreakingSpace()`	Adding a non breaking space, ie a space without any special formatting operations.
`void`	`numberedList(int numbering)`	Starts an ordered list element.
`void`	`numberedList(int numbering, SinkEventAttributes attributes)`	Starts an ordered list element.
`void`	`numberedList_()`	Ends an ordered list element.
`void`	`numberedListItem()`	Starts a list item element within an ordered list.
`void`	`numberedListItem(SinkEventAttributes attributes)`	Starts a list item element within an ordered list.
`void`	`numberedListItem_()`	Ends a list item element within an ordered list.
`void`	`pageBreak()`	Adding a new page separator.
`void`	`paragraph()`	Starts an element which represents a paragraph.
`void`	`paragraph(SinkEventAttributes attributes)`	Starts a paragraph.
`void`	`paragraph_()`	Ends a paragraph element.
`void`	`rawText(java.lang.String text)`	Adding a raw text, ie a text without any special formatting operations.
`void`	`section(int level, SinkEventAttributes attributes)`	Start a new section at the given level.
`void`	`section_(int level)`	Ends a section at the given level.
`void`	`section1()`	Starts a first heading element which contains the topic of the section.
`void`	`section1_()`	Ends a first heading element.
`void`	`section2()`	Starts a second heading element which contains the topic of the section.
`void`	`section2_()`	Ends a second heading element.
`void`	`section3()`	Starts a third heading element which contains the topic of the section.
`void`	`section3_()`	Ends a third heading element.
`void`	`section4()`	Starts a 4th heading element which contains the topic of the section.
`void`	`section4_()`	Ends a 4th heading element.
`void`	`section5()`	Starts a 5th heading element which contains the topic of the section.
`void`	`section5_()`	Ends a 5th heading element.
`void`	`section6()`	Starts a 6th heading element which contains the topic of the section.
`void`	`section6_()`	Ends a 6th heading element.
`void`	`sectionTitle()`	Starts a title heading element.
`void`	`sectionTitle(int level, SinkEventAttributes attributes)`	Start a new section title at the given level.
`void`	`sectionTitle_()`	Ends a title heading element.
`void`	`sectionTitle_(int level)`	Ends a section title at the given level.
`void`	`sectionTitle1()`	Starts a first title heading element.
`void`	`sectionTitle1_()`	Ends a first title heading element.
`void`	`sectionTitle2()`	Starts a second title heading element.
`void`	`sectionTitle2_()`	Ends a second title heading element.
`void`	`sectionTitle3()`	Starts a third title heading element.
`void`	`sectionTitle3_()`	Ends a third title heading element.
`void`	`sectionTitle4()`	Starts a 4th title heading element.
`void`	`sectionTitle4_()`	Ends a 4th title heading element.
`void`	`sectionTitle5()`	Starts a 5th title heading element.
`void`	`sectionTitle5_()`	Ends a 5th title heading element.
`void`	`sectionTitle6()`	Starts a 6th title heading element.
`void`	`sectionTitle6_()`	Ends a 6th title heading element.
`void`	`table()`	Starts a table element for marking up tabular information in a document.
`void`	`table(SinkEventAttributes attributes)`	Starts a table.
`void`	`table_()`	Ends a table element.
`void`	`tableCaption()`	Starts a caption element of a table.
`void`	`tableCaption(SinkEventAttributes attributes)`	Starts a table caption.
`void`	`tableCaption_()`	Ends a caption element of a table.
`void`	`tableCell()`	Starts a cell element which defines a cell that contains data.
`void`	`tableCell(java.lang.String width)`	Starts a cell element which defines a cell that contains data.
`void`	`tableCell(SinkEventAttributes attributes)`	Starts a table cell.
`void`	`tableCell_()`	Ends a cell element.
`void`	`tableHeaderCell()`	Starts a cell element which defines a cell that contains header information.
`void`	`tableHeaderCell(java.lang.String width)`	Starts a cell element which defines a cell that contains header information.
`void`	`tableHeaderCell(SinkEventAttributes attributes)`	Starts a table header cell.
`void`	`tableHeaderCell_()`	Ends a cell header element.
`void`	`tableRow()`	Starts a row element which acts as a container for a row of table cells.
`void`	`tableRow(SinkEventAttributes attributes)`	Starts a table row.
`void`	`tableRow_()`	Ends a row element.
`void`	`tableRows(int[] justification, boolean grid)`	Starts an element that contains rows of table data.
`void`	`tableRows_()`	Ends an element that contains rows of table data.
`void`	`text(java.lang.String text)`	Adding a text.
`void`	`text(java.lang.String text, SinkEventAttributes attributes)`	Adds a text.
`void`	`title()`	Starts the title element.
`void`	`title(SinkEventAttributes attributes)`	Starts the title element.
`void`	`title_()`	Ends the title element.
`void`	`unknown(java.lang.String name, java.lang.Object[] requiredParams, SinkEventAttributes attributes)`	Add an unknown event.
`void`	`verbatim(boolean boxed)`	Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
`void`	`verbatim(SinkEventAttributes attributes)`	Starts a verbatim block, ie a block where whitespace has semantic relevance.
`void`	`verbatim_()`	Ends a verbatim element.

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, init, unifyEOLs

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()
```
    Description copied from interface: Sink
    
    Starts the head element.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - head_
```
public void head_()
```
    Description copied from interface: Sink
    
    Ends the head element.
  - body
```
public void body()
```
    Description copied from interface: Sink
    
    Starts the body of a document.
    
    See Also:
    
    Sink.body(SinkEventAttributes)
  - body_
```
public void body_()
```
    Description copied from interface: Sink
    
    Ends the body element.
  - section1
```
public void section1()
```
    Description copied from interface: Sink
    
    Starts a first heading element which contains the topic of the section.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section1_
```
public void section1_()
```
    Description copied from interface: Sink
    
    Ends a first heading element.
  - section2
```
public void section2()
```
    Description copied from interface: Sink
    
    Starts a second heading element which contains the topic of the section. This has to be contained within a Sink.section1() element.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section2_
```
public void section2_()
```
    Description copied from interface: Sink
    
    Ends a second heading element.
  - section3
```
public void section3()
```
    Description copied from interface: Sink
    
    Starts a third heading element which contains the topic of the section. This has to be contained within a Sink.section2() element.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section3_
```
public void section3_()
```
    Description copied from interface: Sink
    
    Ends a third heading element.
  - section4
```
public void section4()
```
    Description copied from interface: Sink
    
    Starts a 4th heading element which contains the topic of the section. This has to be contained within a Sink.section3() element.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section4_
```
public void section4_()
```
    Description copied from interface: Sink
    
    Ends a 4th heading element.
  - section5
```
public void section5()
```
    Description copied from interface: Sink
    
    Starts a 5th heading element which contains the topic of the section. This has to be contained within a Sink.section4() element.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section5_
```
public void section5_()
```
    Description copied from interface: Sink
    
    Ends a 5th heading element.
  - section6
```
public void section6()
```
    Description copied from interface: Sink
    
    Starts a 6th heading element which contains the topic of the section. This has to be contained within a Sink.section5() element.
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section6_
```
public void section6_()
```
    Description copied from interface: Sink
    
    Ends a 6th heading element.
  - list
```
public void list()
```
    Description copied from interface: Sink
    
    Starts an unordered list element.
    
    See Also:
    
    Sink.list(SinkEventAttributes)
  - list_
```
public void list_()
```
    Description copied from interface: Sink
    
    Ends an unordered list element.
  - listItem
```
public void listItem()
```
    Description copied from interface: Sink
    
    Starts a list item element within an unordered list.
    
    See Also:
    
    Sink.listItem(SinkEventAttributes)
  - listItem_
```
public void listItem_()
```
    Description copied from interface: Sink
    
    Ends a list item element within an unordered list.
  - numberedList
```
public void numberedList(int numbering)
```
    Description copied from interface: Sink
    
    Starts an ordered list element.
    
    Parameters:
    
    numbering - the numbering style.
    
    See Also:
    
    Sink.numberedList(int,SinkEventAttributes)
  - numberedList_
```
public void numberedList_()
```
    Description copied from interface: Sink
    
    Ends an ordered list element.
  - numberedListItem
```
public void numberedListItem()
```
    Description copied from interface: Sink
    
    Starts a list item element within an ordered list.
    
    See Also:
    
    Sink.numberedListItem(SinkEventAttributes)
  - numberedListItem_
```
public void numberedListItem_()
```
    Description copied from interface: Sink
    
    Ends a list item element within an ordered list.
  - definitionList
```
public void definitionList()
```
    Description copied from interface: Sink
    
    Starts a definition list element.
    
    See Also:
    
    Sink.definitionList(SinkEventAttributes)
  - definitionList_
```
public void definitionList_()
```
    Description copied from interface: Sink
    
    Ends a definition list element.
  - definitionListItem
```
public void definitionListItem()
```
    Description copied from interface: Sink
    
    Starts a list item element within a definition list.
    
    See Also:
    
    Sink.definitionListItem(SinkEventAttributes)
  - definitionListItem_
```
public void definitionListItem_()
```
    Description copied from interface: Sink
    
    Ends a list item element within a definition list.
  - definition
```
public void definition()
```
    Description copied from interface: Sink
    
    Starts a definition element within a definition list.
    
    See Also:
    
    Sink.definition(SinkEventAttributes)
  - definition_
```
public void definition_()
```
    Description copied from interface: Sink
    
    Ends a definition element within a definition list.
  - figure
```
public void figure()
```
    Description copied from interface: Sink
    
    Starts a basic image embedding element.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figure_
```
public void figure_()
```
    Description copied from interface: Sink
    
    Ends a basic image embedding element.
  - table
```
public void table()
```
    Description copied from interface: Sink
    
    Starts a table element for marking up tabular information in a document.
    
    See Also:
    
    Sink.table(SinkEventAttributes)
  - table_
```
public void table_()
```
    Description copied from interface: Sink
    
    Ends a table element.
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    Description copied from interface: Sink
    
    Starts an element that contains rows of table data.
    
    Parameters:
    
    justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.
    
    grid - true to provide a grid, false otherwise.
    
    See Also:
    
    Sink.table(SinkEventAttributes), Sink.JUSTIFY_CENTER, Sink.JUSTIFY_LEFT, Sink.JUSTIFY_RIGHT
  - tableRows_
```
public void tableRows_()
```
    Description copied from interface: Sink
    
    Ends an element that contains rows of table data.
  - tableRow
```
public void tableRow()
```
    Description copied from interface: Sink
    
    Starts a row element which acts as a container for a row of table cells.
    
    See Also:
    
    Sink.tableRow(SinkEventAttributes)
  - tableRow_
```
public void tableRow_()
```
    Description copied from interface: Sink
    
    Ends a row element.
  - title
```
public void title()
```
    Description copied from interface: Sink
    
    Starts the title element.
    
    See Also:
    
    Sink.title(SinkEventAttributes)
  - title_
```
public void title_()
```
    Description copied from interface: Sink
    
    Ends the title element.
  - author
```
public void author()
```
    Description copied from interface: Sink
    
    Starts an author element.
    
    See Also:
    
    Sink.author(SinkEventAttributes)
  - author_
```
public void author_()
```
    Description copied from interface: Sink
    
    Ends an author element.
  - date
```
public void date()
```
    Description copied from interface: Sink
    Starts the date element.
    The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.:
    YYYY-MM-DD
    where
    
    YYYY is the year in the Gregorian calendar
    
    MM is the month of the year between 01 (January) and 12 (December)
    
    and DD is the day of the month between 01 and 31
    See Also:
    
    Sink.date(SinkEventAttributes)
  - date_
```
public void date_()
```
    Description copied from interface: Sink
    
    Ends the date element.
  - sectionTitle
```
public void sectionTitle()
```
    Description copied from interface: Sink
    
    Starts a title heading element.
  - sectionTitle_
```
public void sectionTitle_()
```
    Description copied from interface: Sink
    
    Ends a title heading element.
  - sectionTitle1
```
public void sectionTitle1()
```
    Description copied from interface: Sink
    
    Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Description copied from interface: Sink
    
    Ends a first title heading element.
  - sectionTitle2
```
public void sectionTitle2()
```
    Description copied from interface: Sink
    
    Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Description copied from interface: Sink
    
    Ends a second title heading element.
  - sectionTitle3
```
public void sectionTitle3()
```
    Description copied from interface: Sink
    
    Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Description copied from interface: Sink
    
    Ends a third title heading element.
  - sectionTitle4
```
public void sectionTitle4()
```
    Description copied from interface: Sink
    
    Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Description copied from interface: Sink
    
    Ends a 4th title heading element.
  - sectionTitle5
```
public void sectionTitle5()
```
    Description copied from interface: Sink
    
    Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Description copied from interface: Sink
    
    Ends a 5th title heading element.
  - sectionTitle6
```
public void sectionTitle6()
```
    Description copied from interface: Sink
    
    Starts a 6th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section6() element.
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle6_
```
public void sectionTitle6_()
```
    Description copied from interface: Sink
    
    Ends a 6th title heading element.
  - paragraph
```
public void paragraph()
```
    Description copied from interface: Sink
    
    Starts an element which represents a paragraph.
    
    See Also:
    
    Sink.paragraph(SinkEventAttributes)
  - paragraph_
```
public void paragraph_()
```
    Description copied from interface: Sink
    
    Ends a paragraph element.
  - verbatim
```
public void verbatim(boolean boxed)
```
    Description copied from interface: Sink
    
    Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
    
    Parameters:
    
    boxed - true to add a box, false otherwise
  - verbatim_
```
public void verbatim_()
```
    Description copied from interface: Sink
    
    Ends a verbatim element.
  - definedTerm
```
public void definedTerm()
```
    Description copied from interface: Sink
    
    Starts a definition term element within a definition list.
    
    See Also:
    
    Sink.definedTerm(SinkEventAttributes)
  - definedTerm_
```
public void definedTerm_()
```
    Description copied from interface: Sink
    
    Starts a definition term element within a definition list.
  - figureCaption
```
public void figureCaption()
```
    Description copied from interface: Sink
    
    Starts a caption of an image element.
    
    See Also:
    
    Sink.figureCaption(SinkEventAttributes)
  - figureCaption_
```
public void figureCaption_()
```
    Description copied from interface: Sink
    
    Ends a caption of an image.
  - tableCell
```
public void tableCell()
```
    Description copied from interface: Sink
    
    Starts a cell element which defines a cell that contains data.
    
    See Also:
    
    Sink.tableCell(SinkEventAttributes)
  - tableCell
```
public void tableCell(java.lang.String width)
```
    Description copied from interface: Sink
    
    Starts a cell element which defines a cell that contains data.
    
    Parameters:
    
    width - the size of the cell.
  - tableCell_
```
public void tableCell_()
```
    Description copied from interface: Sink
    
    Ends a cell element.
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Description copied from interface: Sink
    
    Starts a cell element which defines a cell that contains header information.
    
    See Also:
    
    Sink.tableHeaderCell(SinkEventAttributes)
  - tableHeaderCell
```
public void tableHeaderCell(java.lang.String width)
```
    Description copied from interface: Sink
    
    Starts a cell element which defines a cell that contains header information.
    
    Parameters:
    
    width - the size of the header cell.
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Description copied from interface: Sink
    
    Ends a cell header element.
  - tableCaption
```
public void tableCaption()
```
    Description copied from interface: Sink
    
    Starts a caption element of a table.
    
    See Also:
    
    Sink.tableCaption(SinkEventAttributes)
  - tableCaption_
```
public void tableCaption_()
```
    Description copied from interface: Sink
    
    Ends a caption element of a table.
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Description copied from interface: Sink
    
    Adding a source of a graphic.
    
    Parameters:
    
    name - the source
  - horizontalRule
```
public void horizontalRule()
```
    Description copied from interface: Sink
    
    Adding a separator of sections from a text to each other.
    
    See Also:
    
    Sink.horizontalRule(SinkEventAttributes)
  - pageBreak
```
public void pageBreak()
```
    Description copied from interface: Sink
    
    Adding a new page separator.
  - anchor
```
public void anchor(java.lang.String name)
```
    Description copied from interface: Sink
    
    Starts an element which defines an anchor.
    
    Parameters:
    
    name - the name of the anchor.
    
    See Also:
    
    Sink.anchor(String,SinkEventAttributes)
  - anchor_
```
public void anchor_()
```
    Description copied from interface: Sink
    
    Ends an anchor element.
  - link
```
public void link(java.lang.String name)
```
    Description copied from interface: Sink
    
    Starts an element which defines a link.
    
    Parameters:
    
    name - the name of the link.
    
    See Also:
    
    Sink.link(String,SinkEventAttributes)
  - link_
```
public void link_()
```
    Description copied from interface: Sink
    
    Ends a link element.
  - italic
```
public void italic()
```
    Description copied from interface: Sink
    
    Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - italic_
```
public void italic_()
```
    Description copied from interface: Sink
    
    Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - bold
```
public void bold()
```
    Description copied from interface: Sink
    
    Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - bold_
```
public void bold_()
```
    Description copied from interface: Sink
    
    Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - monospaced
```
public void monospaced()
```
    Description copied from interface: Sink
    
    Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - monospaced_
```
public void monospaced_()
```
    Description copied from interface: Sink
    
    Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
  - lineBreak
```
public void lineBreak()
```
    Description copied from interface: Sink
    
    Adds a line break.
    
    See Also:
    
    Sink.lineBreak(SinkEventAttributes)
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Description copied from interface: Sink
    
    Adding a non breaking space, ie a space without any special formatting operations.
  - text
```
public void text(java.lang.String text)
```
    Description copied from interface: Sink
    
    Adding a text.
    
    Parameters:
    
    text - The text to write.
    
    See Also:
    
    Sink.text(String,SinkEventAttributes)
  - rawText
```
public void rawText(java.lang.String text)
```
    Description copied from interface: Sink
    
    Adding a raw text, ie a text without any special formatting operations.
    
    Parameters:
    
    text - The text to write.
  - comment
```
public void comment(java.lang.String comment)
```
    Description copied from interface: Sink
    
    Add a comment.
    
    Parameters:
    
    comment - The comment to write.
  - flush
```
public void flush()
```
    Description copied from interface: Sink
    
    Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.
  - close
```
public void close()
```
    Description copied from interface: Sink
    
    Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
  - head
```
public void head(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    Starts the head element.
    This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.
    
    The canonical sequence of events for the head element is:
    
    sink.head(); sink.title(); sink.text( "Title" ); sink.title_(); sink.author(); sink.text( "Author" ); sink.author_(); sink.date(); sink.text( "Date" ); sink.date_(); sink.head_();
    
    but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).
    
    Supported attributes are:
    
    PROFILE, LANG.
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - title
```
public void title(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts the title element. This is used to identify the document.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - author
```
public void author(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts an author element. This is used to identify the author of the document.
    Supported attributes are: EMAIL.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - date
```
public void date(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts the date element. This is used to identify the date of the document.
    Supported attributes are: none.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - body
```
public void body(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts the body of a document. This contains the document's content.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - section
```
public void section(int level,
                    SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Start a new section at the given level.
    Sections with higher level have to be entirely contained within sections of lower level.
    
    Supported attributes are the base attributes.
    
    Parameters:
    
    level - the section level.
    
    attributes - A set of SinkEventAttributes, may be null.
  - section_
```
public void section_(int level)
```
    Description copied from interface: Sink
    
    Ends a section at the given level.
    
    Parameters:
    
    level - the section level.
  - sectionTitle
```
public void sectionTitle(int level,
                         SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Start a new section title at the given level.
    This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.
    
    NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).
    
    Supported attributes are the base attributes plus ALIGN.
    
    Parameters:
    
    level - the section title level.
    
    attributes - A set of SinkEventAttributes, may be null.
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Description copied from interface: Sink
    
    Ends a section title at the given level.
    
    Parameters:
    
    level - the section title level.
  - list
```
public void list(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts an unordered list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - listItem
```
public void listItem(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a list item element within an unordered list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - numberedList
```
public void numberedList(int numbering,
                         SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts an ordered list element.
    Supported attributes are the base attributes.
    
    Parameters:
    
    numbering - the numbering style.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.NUMBERING_DECIMAL, Sink.NUMBERING_LOWER_ALPHA, Sink.NUMBERING_LOWER_ROMAN, Sink.NUMBERING_UPPER_ALPHA, Sink.NUMBERING_UPPER_ROMAN
  - numberedListItem
```
public void numberedListItem(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a list item element within an ordered list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definitionList
```
public void definitionList(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a definition list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definitionListItem
```
public void definitionListItem(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a list item element within a definition list.
    Every definitionListItem has to contain exactly one Sink.definedTerm(SinkEventAttributes) and one Sink.definition(SinkEventAttributes), in this order.
    
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definition
```
public void definition(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a definition element within a definition list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definedTerm
```
public void definedTerm(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a definition term element within a definition list.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - figure
```
public void figure(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    Starts a basic image embedding element.
    The canonical sequence of events for the figure element is:
    
    sink.figure(); sink.figureGraphics( "figure.png" ); sink.figureCaption(); sink.text( "Figure caption",); sink.figureCaption_(); sink.figure_();
    
    where the figureCaption element is optional.
    
    However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.
    
    NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).
    
    Supported attributes are the base attributes.
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - figureCaption
```
public void figureCaption(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a figure caption.
    Supported attributes are the base attributes.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figureGraphics
```
public void figureGraphics(java.lang.String src,
                           SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Adds a graphic element.
    The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.
    
    Supported attributes are the base attributes plus:
    
    SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.
    
    If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.
    
    Parameters:
    
    src - the image source, a valid URL.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - table
```
public void table(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    Starts a table.
    The canonical sequence of events for the table element is:
    
    sink.table(); sink.tableRows( justify, true ); sink.tableRow(); sink.tableCell(); sink.text( "cell 1,1" ); sink.tableCell_(); sink.tableCell(); sink.text( "cell 1,2" ); sink.tableCell_(); sink.tableRow_(); sink.tableRows_(); sink.tableCaption(); sink.text( "Table caption" ); sink.tableCaption_(); sink.table_();
    
    where the tableCaption element is optional.
    
    However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
    
    Supported attributes are the base attributes plus:
    
    ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableRow
```
public void tableRow(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a table row.
    Supported attributes are the base attributes plus:
    
    ALIGN, BGCOLOR, VALIGN.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableCell
```
public void tableCell(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a table cell.
    Supported attributes are the base attributes plus:
    
    ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableHeaderCell
```
public void tableHeaderCell(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a table header cell.
    Supported attributes are the same as for tableCell.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableCaption
```
public void tableCaption(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a table caption.
    Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.
    
    Supported attributes are the base attributes plus ALIGN.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.table(SinkEventAttributes)
  - paragraph
```
public void paragraph(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a paragraph.
    Supported attributes are the base attributes plus ALIGN.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - verbatim
```
public void verbatim(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a verbatim block, ie a block where whitespace has semantic relevance.
    Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.
    
    Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.
    
    Supported attributes are the base attributes plus:
    
    DECORATION (value: "boxed"), ALIGN, WIDTH.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - horizontalRule
```
public void horizontalRule(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Adds a horizontal separator rule.
    Supported attributes are the base attributes plus:
    
    ALIGN, NOSHADE, SIZE, WIDTH.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - anchor
```
public void anchor(java.lang.String name,
                   SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts an element which defines an anchor.
    The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:
    
    ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
    
    Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
    
    Parameters:
    
    name - the name of the anchor. This has to be a valid SGML NAME token.
    
    attributes - A set of SinkEventAttributes, may be null.
  - link
```
public void link(java.lang.String name,
                 SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Starts a link.
    The name parameter has to be a valid html href parameter, ie for internal links (links to an anchor within the same source document), name should start with the character "#".
    
    Supported attributes are the base attributes plus:
    
    CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.
    
    If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.
    
    Parameters:
    
    name - the name of the link.
    
    attributes - A set of SinkEventAttributes, may be null.
  - lineBreak
```
public void lineBreak(SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Adds a line break.
    Supported attributes are:
    
    ID, CLASS, TITLE, STYLE.
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - text
```
public void text(java.lang.String text,
                 SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Adds a text.
    The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.
    
    If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.
    
    Supported attributes are the base attributes plus
    
    VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
    
    Parameters:
    
    text - The text to write.
    
    attributes - A set of SinkEventAttributes, may be null.
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    SinkEventAttributes attributes)
```
    Description copied from interface: Sink
    
    Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.
    
    Parameters:
    
    name - The name of the event.
    
    requiredParams - An optional array of required parameters to the event. May be null.
    
    attributes - A set of SinkEventAttributes, may be null.

Class SinkAdapter

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.Markup

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

Methods inherited from class java.lang.Object

Constructor Detail

SinkAdapter

Method Detail

head

head_

body

body_

section1

section1_

section2

section2_

section3

section3_

section4

section4_

section5

section5_

section6

section6_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definitionListItem

definitionListItem_

definition

definition_

figure

figure_

table

table_

tableRows

tableRows_

tableRow

tableRow_

title

title_

author

author_

date

date_

sectionTitle

sectionTitle_

sectionTitle1

sectionTitle1_

sectionTitle2

sectionTitle2_

sectionTitle3

sectionTitle3_

sectionTitle4

sectionTitle4_

sectionTitle5

sectionTitle5_

sectionTitle6

sectionTitle6_

paragraph

paragraph_

verbatim

verbatim_

definedTerm

definedTerm_

figureCaption

figureCaption_

tableCell

tableCell

tableCell_