java.lang.Object
- org.apache.maven.doxia.sink.impl.RandomAccessSink

All Implemented Interfaces:

LogEnabled, Sink
```
public class RandomAccessSink
extends java.lang.Object
implements Sink
```
The RandomAccessSink provides the ability to create a Sink with hooks. A page can be prepared by first creating its structure and specifying the positions of these hooks. After specifying the structure, the page can be filled with content from one or more models. These hooks can prevent you to have to loop over the model multiple times to build the page as desired.

Since:

1.3

Field Summary

Fields
Modifier and Type	Field	Description
`private java.io.OutputStream`	`coreOutputStream`
`private Sink`	`coreSink`
`private Sink`	`currentSink`
`private java.lang.String`	`encoding`
`private java.util.List<java.io.ByteArrayOutputStream>`	`outputStreams`
`private SinkFactory`	`sinkFactory`
`private java.util.List<Sink>`	`sinks`

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
`RandomAccessSink(SinkFactory sinkFactory, java.io.File outputDirectory, java.lang.String outputName)`	Constructor for RandomAccessSink.
`RandomAccessSink(SinkFactory sinkFactory, java.io.File outputDirectory, java.lang.String outputName, java.lang.String encoding)`	Constructor for RandomAccessSink.
`RandomAccessSink(SinkFactory sinkFactory, java.io.OutputStream stream)`	Constructor for RandomAccessSink.
`RandomAccessSink(SinkFactory sinkFactory, java.io.OutputStream stream, java.lang.String encoding)`	Constructor for RandomAccessSink.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`address()`	Starts an address element.
`void`	`address(SinkEventAttributes attributes)`	Starts an address element.
`void`	`address_()`	Ends an address element.
`Sink`	`addSinkHook()`	By calling this method a sink reference is added at the current position.
`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`	`article()`	Starts an article within a document.
`void`	`article(SinkEventAttributes attributes)`	Starts an article within a document.
`void`	`article_()`	Ends the article element.
`void`	`author()`	Starts an author element.
`void`	`author(SinkEventAttributes attributes)`	Starts an author element.
`void`	`author_()`	Ends an author element.
`void`	`blockquote()`	Starts a blockquote element.
`void`	`blockquote(SinkEventAttributes attributes)`	Starts a blockquote element.
`void`	`blockquote_()`	Ends an blockquote 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 all sinks
`void`	`comment(java.lang.String comment)`	Add a comment.
`void`	`content()`	Start the main content section between the header and the footer within the sections and/or body.
`void`	`content(SinkEventAttributes attributes)`	Start the main content section between the header and the footer within the sections and/or body.
`void`	`content_()`	Ends a main content section.
`void`	`data(java.lang.String value)`	Starts a data element which groups together other elements representing microformats.
`void`	`data(java.lang.String value, SinkEventAttributes attributes)`	Starts a data element which groups together other elements representing microformats.
`void`	`data_()`	Ends an data element.
`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_()`	Ends 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`	`division()`	Starts a division element grouping together other elements.
`void`	`division(SinkEventAttributes attributes)`	Starts a division element grouping together other elements.
`void`	`division_()`	Ends a division element.
`void`	`enableLogging(Log log)`	Enable a `Doxia` logger for this `Doxia` component.
`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 all sinks
`void`	`footer()`	Start a new footer within the section or body.
`void`	`footer(SinkEventAttributes attributes)`	Start a new footer within the section or body.
`void`	`footer_()`	Ends a footer element.
`void`	`head()`	Starts the head element.
`void`	`head(SinkEventAttributes attributes)`	Starts the head element.
`void`	`head_()`	Ends the head element.
`void`	`header()`	Start a new header within the section or body.
`void`	`header(SinkEventAttributes attributes)`	Start a new header within the section or body.
`void`	`header_()`	Ends a header element.
`void`	`horizontalRule()`	Adding a separator of sections from a text to each other.
`void`	`horizontalRule(SinkEventAttributes attributes)`	Adds a horizontal separator rule.
`void`	`inline()`	Starts an inline element.
`void`	`inline(SinkEventAttributes attributes)`	Starts an inline element.
`void`	`inline_()`	Ends an inline element.
`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`	`lineBreakOpportunity()`	Adds a line break opportunity.
`void`	`lineBreakOpportunity(SinkEventAttributes attributes)`	Adds a line break opportunity.
`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`	`navigation()`	Starts a navigation section within a document.
`void`	`navigation(SinkEventAttributes attributes)`	Starts a navigation section within a document.
`void`	`navigation_()`	Ends the navigation 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`	`sidebar()`	Starts a sidebar section within a document.
`void`	`sidebar(SinkEventAttributes attributes)`	Starts a sidebar section within a document.
`void`	`sidebar_()`	Ends the sidebar 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`	`time(java.lang.String datetime)`	Starts a time element which groups together other elements representing a time.
`void`	`time(java.lang.String datetime, SinkEventAttributes attributes)`	Starts a time element which groups together other elements representing a time.
`void`	`time_()`	Ends a time element.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sinkFactory
```
private SinkFactory sinkFactory
```
  - encoding
```
private java.lang.String encoding
```
  - coreOutputStream
```
private java.io.OutputStream coreOutputStream
```
  - coreSink
```
private Sink coreSink
```
  - sinks
```
private java.util.List<Sink> sinks
```
  - outputStreams
```
private java.util.List<java.io.ByteArrayOutputStream> outputStreams
```
  - currentSink
```
private Sink currentSink
```
- Constructor Detail
  - RandomAccessSink
```
public RandomAccessSink(SinkFactory sinkFactory,
                        java.io.OutputStream stream)
                 throws java.io.IOException
```
    Constructor for RandomAccessSink.
    
    Parameters:
    
    sinkFactory - a SinkFactory object.
    
    stream - a OutputStream object.
    
    Throws:
    
    java.io.IOException - if any.
  - RandomAccessSink
```
public RandomAccessSink(SinkFactory sinkFactory,
                        java.io.OutputStream stream,
                        java.lang.String encoding)
                 throws java.io.IOException
```
    Constructor for RandomAccessSink.
    
    Parameters:
    
    sinkFactory - a SinkFactory object.
    
    stream - a OutputStream object.
    
    encoding - a String object.
    
    Throws:
    
    java.io.IOException - if any.
  - RandomAccessSink
```
public RandomAccessSink(SinkFactory sinkFactory,
                        java.io.File outputDirectory,
                        java.lang.String outputName)
                 throws java.io.IOException
```
    Constructor for RandomAccessSink.
    
    Parameters:
    
    sinkFactory - a SinkFactory object.
    
    outputDirectory - a File object.
    
    outputName - a String object.
    
    Throws:
    
    java.io.IOException - if any.
  - RandomAccessSink
```
public RandomAccessSink(SinkFactory sinkFactory,
                        java.io.File outputDirectory,
                        java.lang.String outputName,
                        java.lang.String encoding)
                 throws java.io.IOException
```
    Constructor for RandomAccessSink.
    
    Parameters:
    
    sinkFactory - a SinkFactory object.
    
    outputDirectory - a File object.
    
    outputName - a String object.
    
    encoding - a String object.
    
    Throws:
    
    java.io.IOException - if any.
- Method Detail
  - address
```
public void address()
```
    Starts an address element.
    
    Specified by:
    
    address in interface Sink
    
    See Also:
    
    Sink.address(SinkEventAttributes)
  - address
```
public void address(SinkEventAttributes attributes)
```
    Starts an address element.
    
    Specified by:
    
    address in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - address_
```
public void address_()
```
    Ends an address element.
    
    Specified by:
    
    address_ in interface Sink
  - addSinkHook
```
public Sink addSinkHook()
```
    By calling this method a sink reference is added at the current position. You can write to both the new sink reference and the original sink. After flushing all sinks will be flushed in the right order.
    
    Returns:
    
    a subsink reference you can write to
  - anchor
```
public void anchor(java.lang.String name)
```
    Starts an element which defines an anchor.
    
    Specified by:
    
    anchor in interface Sink
    
    Parameters:
    
    name - the name of the anchor.
    
    See Also:
    
    Sink.anchor(String,SinkEventAttributes)
  - anchor
```
public void anchor(java.lang.String name,
                   SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    anchor in interface Sink
    
    Parameters:
    
    name - the name of the anchor. This has to be a valid SGML NAME token.
    
    attributes - A set of SinkEventAttributes, may be null.
  - anchor_
```
public void anchor_()
```
    Ends an anchor element.
    
    Specified by:
    
    anchor_ in interface Sink
  - article
```
public void article()
```
    Starts an article within a document.
    
    Specified by:
    
    article in interface Sink
    
    See Also:
    
    Sink.article(SinkEventAttributes)
  - article
```
public void article(SinkEventAttributes attributes)
```
    Starts an article within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    article in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - article_
```
public void article_()
```
    Ends the article element.
    
    Specified by:
    
    article_ in interface Sink
  - author
```
public void author()
```
    Starts an author element.
    
    Specified by:
    
    author in interface Sink
    
    See Also:
    
    Sink.author(SinkEventAttributes)
  - author
```
public void author(SinkEventAttributes attributes)
```
    Starts an author element. This is used to identify the author of the document.
    Supported attributes are: EMAIL.
    
    Specified by:
    
    author in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - author_
```
public void author_()
```
    Ends an author element.
    
    Specified by:
    
    author_ in interface Sink
  - blockquote
```
public void blockquote()
```
    Starts a blockquote element.
    
    Specified by:
    
    blockquote in interface Sink
    
    See Also:
    
    Sink.blockquote(SinkEventAttributes)
  - blockquote
```
public void blockquote(SinkEventAttributes attributes)
```
    Starts a blockquote element.
    Supported attributes are the base attributes.
    
    Specified by:
    
    blockquote in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - blockquote_
```
public void blockquote_()
```
    Ends an blockquote element.
    
    Specified by:
    
    blockquote_ in interface Sink
  - body
```
public void body()
```
    Starts the body of a document.
    
    Specified by:
    
    body in interface Sink
    
    See Also:
    
    Sink.body(SinkEventAttributes)
  - body
```
public void body(SinkEventAttributes attributes)
```
    Starts the body of a document. This contains the document's content.
    Supported attributes are the base attributes.
    
    Specified by:
    
    body in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - body_
```
public void body_()
```
    Ends the body element.
    
    Specified by:
    
    body_ in interface Sink
  - bold
```
public void bold()
```
    Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    bold in interface Sink
  - bold_
```
public void bold_()
```
    Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    bold_ in interface Sink
  - close
```
public void close()
```
    Close all sinks
    
    Specified by:
    
    close in interface Sink
  - comment
```
public void comment(java.lang.String comment)
```
    Add a comment.
    
    Specified by:
    
    comment in interface Sink
    
    Parameters:
    
    comment - The comment to write.
  - content
```
public void content()
```
    Start the main content section between the header and the footer within the sections and/or body.
    
    Specified by:
    
    content in interface Sink
  - content
```
public void content(SinkEventAttributes attributes)
```
    Start the main content section between the header and the footer within the sections and/or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    content in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - content_
```
public void content_()
```
    Ends a main content section.
    
    Specified by:
    
    content_ in interface Sink
  - data
```
public void data(java.lang.String value)
```
    Starts a data element which groups together other elements representing microformats.
    
    Specified by:
    
    data in interface Sink
    
    Parameters:
    
    value - a String object.
    
    See Also:
    
    Sink.data(String, SinkEventAttributes)
  - data
```
public void data(java.lang.String value,
                 SinkEventAttributes attributes)
```
    Starts a data element which groups together other elements representing microformats.
    Supported attributes are the base attributes plus VALUE.
    
    Specified by:
    
    data in interface Sink
    
    Parameters:
    
    value - the machine readable value of the data, may be null.
    
    attributes - A set of SinkEventAttributes, may be null.
  - data_
```
public void data_()
```
    Ends an data element.
    
    Specified by:
    
    data_ in interface Sink
  - date
```
public void date()
```
    Starts the date element.
    
    Specified by:
    
    date in interface Sink
    
    See Also:
    
    Sink.date(SinkEventAttributes)
  - date
```
public void date(SinkEventAttributes attributes)
```
    Starts the date element. This is used to identify the date of the document: there is no strict definition if it is creation date or last modification date, which are the 2 classical semantics. There is no formal formatting requirements either.
    The date is recommended (but it is not a requirement) to be aligned 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.
    
    Supported attributes are: none.
    Specified by:
    
    date in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - date_
```
public void date_()
```
    Ends the date element.
    
    Specified by:
    
    date_ in interface Sink
  - definedTerm
```
public void definedTerm()
```
    Starts a definition term element within a definition list.
    
    Specified by:
    
    definedTerm in interface Sink
    
    See Also:
    
    Sink.definedTerm(SinkEventAttributes)
  - definedTerm
```
public void definedTerm(SinkEventAttributes attributes)
```
    Starts a definition term element within a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definedTerm in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definedTerm_
```
public void definedTerm_()
```
    Ends a definition term element within a definition list.
    
    Specified by:
    
    definedTerm_ in interface Sink
  - definition
```
public void definition()
```
    Starts a definition element within a definition list.
    
    Specified by:
    
    definition in interface Sink
    
    See Also:
    
    Sink.definition(SinkEventAttributes)
  - definition
```
public void definition(SinkEventAttributes attributes)
```
    Starts a definition element within a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definition in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definitionList
```
public void definitionList()
```
    Starts a definition list element.
    
    Specified by:
    
    definitionList in interface Sink
    
    See Also:
    
    Sink.definitionList(SinkEventAttributes)
  - definitionList
```
public void definitionList(SinkEventAttributes attributes)
```
    Starts a definition list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    definitionList in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definitionListItem
```
public void definitionListItem()
```
    Starts a list item element within a definition list.
    
    Specified by:
    
    definitionListItem in interface Sink
    
    See Also:
    
    Sink.definitionListItem(SinkEventAttributes)
  - definitionListItem
```
public void definitionListItem(SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    definitionListItem in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - definitionListItem_
```
public void definitionListItem_()
```
    Ends a list item element within a definition list.
    
    Specified by:
    
    definitionListItem_ in interface Sink
  - definitionList_
```
public void definitionList_()
```
    Ends a definition list element.
    
    Specified by:
    
    definitionList_ in interface Sink
  - definition_
```
public void definition_()
```
    Ends a definition element within a definition list.
    
    Specified by:
    
    definition_ in interface Sink
  - division
```
public void division()
```
    Starts a division element grouping together other elements.
    
    Specified by:
    
    division in interface Sink
    
    See Also:
    
    Sink.division(SinkEventAttributes)
  - division
```
public void division(SinkEventAttributes attributes)
```
    Starts a division element grouping together other elements.
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    division in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - division_
```
public void division_()
```
    Ends a division element.
    
    Specified by:
    
    division_ in interface Sink
  - figure
```
public void figure()
```
    Starts a basic image embedding element.
    
    Specified by:
    
    figure in interface Sink
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figure
```
public void figure(SinkEventAttributes attributes)
```
    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.
    Specified by:
    
    figure in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - figureCaption
```
public void figureCaption()
```
    Starts a caption of an image element.
    
    Specified by:
    
    figureCaption in interface Sink
    
    See Also:
    
    Sink.figureCaption(SinkEventAttributes)
  - figureCaption
```
public void figureCaption(SinkEventAttributes attributes)
```
    Starts a figure caption.
    Supported attributes are the base attributes.
    
    Specified by:
    
    figureCaption in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figureCaption_
```
public void figureCaption_()
```
    Ends a caption of an image.
    
    Specified by:
    
    figureCaption_ 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
  - figureGraphics
```
public void figureGraphics(java.lang.String src,
                           SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    figureGraphics in interface Sink
    
    Parameters:
    
    src - the image source, a valid URL.
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.figure(SinkEventAttributes)
  - figure_
```
public void figure_()
```
    Ends a basic image embedding element.
    
    Specified by:
    
    figure_ in interface Sink
  - flush
```
public void flush()
```
    Flush all sinks
    
    Specified by:
    
    flush in interface Sink
  - footer
```
public void footer()
```
    Start a new footer within the section or body.
    
    Specified by:
    
    footer in interface Sink
  - footer
```
public void footer(SinkEventAttributes attributes)
```
    Start a new footer within the section or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    footer in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - footer_
```
public void footer_()
```
    Ends a footer element.
    
    Specified by:
    
    footer_ in interface Sink
  - head
```
public void head()
```
    Starts the head element.
    
    Specified by:
    
    head in interface Sink
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - head
```
public void head(SinkEventAttributes attributes)
```
    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.
    Specified by:
    
    head in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - head_
```
public void head_()
```
    Ends the head element.
    
    Specified by:
    
    head_ in interface Sink
  - header
```
public void header()
```
    Start a new header within the section or body.
    
    Specified by:
    
    header in interface Sink
  - header
```
public void header(SinkEventAttributes attributes)
```
    Start a new header within the section or body.
    Supported attributes are the base attributes.
    
    Specified by:
    
    header in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - header_
```
public void header_()
```
    Ends a header element.
    
    Specified by:
    
    header_ in interface Sink
  - horizontalRule
```
public void horizontalRule()
```
    Adding a separator of sections from a text to each other.
    
    Specified by:
    
    horizontalRule in interface Sink
    
    See Also:
    
    Sink.horizontalRule(SinkEventAttributes)
  - horizontalRule
```
public void horizontalRule(SinkEventAttributes attributes)
```
    Adds a horizontal separator rule.
    Supported attributes are the base attributes plus:
    
    ALIGN, NOSHADE, SIZE, WIDTH.
    
    Specified by:
    
    horizontalRule in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - inline
```
public void inline()
```
    Starts an inline element.
    
    Specified by:
    
    inline in interface Sink
    
    See Also:
    
    Sink.inline(SinkEventAttributes)
  - inline
```
public void inline(SinkEventAttributes attributes)
```
    Starts an inline element.
    The inline method is similar to Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.
    
    Supported attributes are the base attributes plus
    
    SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
    
    Specified by:
    
    inline in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - inline_
```
public void inline_()
```
    Ends an inline element.
    
    Specified by:
    
    inline_ in interface Sink
  - italic
```
public void italic()
```
    Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    italic in interface Sink
  - italic_
```
public void italic_()
```
    Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    italic_ in interface Sink
  - lineBreak
```
public void lineBreak()
```
    Adds a line break.
    
    Specified by:
    
    lineBreak in interface Sink
    
    See Also:
    
    Sink.lineBreak(SinkEventAttributes)
  - lineBreak
```
public void lineBreak(SinkEventAttributes attributes)
```
    Adds a line break.
    Supported attributes are:
    
    ID, CLASS, TITLE, STYLE.
    
    Specified by:
    
    lineBreak in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - lineBreakOpportunity
```
public void lineBreakOpportunity()
```
    Adds a line break opportunity.
    
    Specified by:
    
    lineBreakOpportunity in interface Sink
    
    See Also:
    
    Sink.lineBreak(SinkEventAttributes)
  - lineBreakOpportunity
```
public void lineBreakOpportunity(SinkEventAttributes attributes)
```
    Adds a line break opportunity.
    Supported attributes are:
    
    ID, CLASS, TITLE, STYLE.
    
    Specified by:
    
    lineBreakOpportunity in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - link
```
public void link(java.lang.String name)
```
    Starts an element which defines a link.
    
    Specified by:
    
    link in interface Sink
    
    Parameters:
    
    name - the name of the link.
    
    See Also:
    
    Sink.link(String,SinkEventAttributes)
  - link
```
public void link(java.lang.String name,
                 SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    link in interface Sink
    
    Parameters:
    
    name - the name of the link.
    
    attributes - A set of SinkEventAttributes, may be null.
  - link_
```
public void link_()
```
    Ends a link element.
    
    Specified by:
    
    link_ in interface Sink
  - list
```
public void list()
```
    Starts an unordered list element.
    
    Specified by:
    
    list in interface Sink
    
    See Also:
    
    Sink.list(SinkEventAttributes)
  - list
```
public void list(SinkEventAttributes attributes)
```
    Starts an unordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    list in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - listItem
```
public void listItem()
```
    Starts a list item element within an unordered list.
    
    Specified by:
    
    listItem in interface Sink
    
    See Also:
    
    Sink.listItem(SinkEventAttributes)
  - listItem
```
public void listItem(SinkEventAttributes attributes)
```
    Starts a list item element within an unordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    listItem in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - listItem_
```
public void listItem_()
```
    Ends a list item element within an unordered list.
    
    Specified by:
    
    listItem_ in interface Sink
  - list_
```
public void list_()
```
    Ends an unordered list element.
    
    Specified by:
    
    list_ in interface Sink
  - monospaced
```
public void monospaced()
```
    Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    monospaced in interface Sink
  - monospaced_
```
public void monospaced_()
```
    Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
    
    Specified by:
    
    monospaced_ in interface Sink
  - navigation
```
public void navigation()
```
    Starts a navigation section within a document.
    
    Specified by:
    
    navigation in interface Sink
    
    See Also:
    
    Sink.navigation(SinkEventAttributes)
  - navigation
```
public void navigation(SinkEventAttributes attributes)
```
    Starts a navigation section within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    navigation in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.navigation(SinkEventAttributes)
  - navigation_
```
public void navigation_()
```
    Ends the navigation element.
    
    Specified by:
    
    navigation_ 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
  - numberedList
```
public void numberedList(int numbering)
```
    Starts an ordered list element.
    
    Specified by:
    
    numberedList in interface Sink
    
    Parameters:
    
    numbering - the numbering style.
    
    See Also:
    
    Sink.numberedList(int,SinkEventAttributes)
  - numberedList
```
public void numberedList(int numbering,
                         SinkEventAttributes attributes)
```
    Starts an ordered list element.
    Supported attributes are the base attributes.
    
    Specified by:
    
    numberedList in interface Sink
    
    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()
```
    Starts a list item element within an ordered list.
    
    Specified by:
    
    numberedListItem in interface Sink
    
    See Also:
    
    Sink.numberedListItem(SinkEventAttributes)
  - numberedListItem
```
public void numberedListItem(SinkEventAttributes attributes)
```
    Starts a list item element within an ordered list.
    Supported attributes are the base attributes.
    
    Specified by:
    
    numberedListItem in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - numberedListItem_
```
public void numberedListItem_()
```
    Ends a list item element within an ordered list.
    
    Specified by:
    
    numberedListItem_ in interface Sink
  - numberedList_
```
public void numberedList_()
```
    Ends an ordered list element.
    
    Specified by:
    
    numberedList_ in interface Sink
  - pageBreak
```
public void pageBreak()
```
    Adding a new page separator.
    
    Specified by:
    
    pageBreak in interface Sink
  - paragraph
```
public void paragraph()
```
    Starts an element which represents a paragraph.
    
    Specified by:
    
    paragraph in interface Sink
    
    See Also:
    
    Sink.paragraph(SinkEventAttributes)
  - paragraph
```
public void paragraph(SinkEventAttributes attributes)
```
    Starts a paragraph.
    Supported attributes are the base attributes plus ALIGN.
    
    Specified by:
    
    paragraph in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - paragraph_
```
public void paragraph_()
```
    Ends a paragraph element.
    
    Specified by:
    
    paragraph_ in interface Sink
  - 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.
  - section
```
public void section(int level,
                    SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    section in interface Sink
    
    Parameters:
    
    level - the section level.
    
    attributes - A set of SinkEventAttributes, may be null.
  - section1
```
public void section1()
```
    Starts a first heading element which contains the topic of the section.
    
    Specified by:
    
    section1 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section1_
```
public void section1_()
```
    Ends a first heading element.
    
    Specified by:
    
    section1_ in interface Sink
  - section2
```
public void section2()
```
    Starts a second heading element which contains the topic of the section. This has to be contained within a Sink.section1() element.
    
    Specified by:
    
    section2 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section2_
```
public void section2_()
```
    Ends a second heading element.
    
    Specified by:
    
    section2_ in interface Sink
  - section3
```
public void section3()
```
    Starts a third heading element which contains the topic of the section. This has to be contained within a Sink.section2() element.
    
    Specified by:
    
    section3 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section3_
```
public void section3_()
```
    Ends a third heading element.
    
    Specified by:
    
    section3_ in interface Sink
  - section4
```
public void section4()
```
    Starts a 4th heading element which contains the topic of the section. This has to be contained within a Sink.section3() element.
    
    Specified by:
    
    section4 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section4_
```
public void section4_()
```
    Ends a 4th heading element.
    
    Specified by:
    
    section4_ in interface Sink
  - section5
```
public void section5()
```
    Starts a 5th heading element which contains the topic of the section. This has to be contained within a Sink.section4() element.
    
    Specified by:
    
    section5 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section5_
```
public void section5_()
```
    Ends a 5th heading element.
    
    Specified by:
    
    section5_ in interface Sink
  - section6
```
public void section6()
```
    Starts a 6th heading element which contains the topic of the section. This has to be contained within a Sink.section5() element.
    
    Specified by:
    
    section6 in interface Sink
    
    See Also:
    
    Sink.section(int,SinkEventAttributes)
  - section6_
```
public void section6_()
```
    Ends a 6th heading element.
    
    Specified by:
    
    section6_ in interface Sink
  - sectionTitle
```
public void sectionTitle()
```
    Starts a title heading element.
    
    Specified by:
    
    sectionTitle in interface Sink
  - sectionTitle
```
public void sectionTitle(int level,
                         SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    sectionTitle in interface Sink
    
    Parameters:
    
    level - the section title level.
    
    attributes - A set of SinkEventAttributes, may be null.
  - sectionTitle1
```
public void sectionTitle1()
```
    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.
    
    Specified by:
    
    sectionTitle1 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Ends a first title heading element.
    
    Specified by:
    
    sectionTitle1_ in interface Sink
  - sectionTitle2
```
public void sectionTitle2()
```
    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.
    
    Specified by:
    
    sectionTitle2 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Ends a second title heading element.
    
    Specified by:
    
    sectionTitle2_ in interface Sink
  - sectionTitle3
```
public void sectionTitle3()
```
    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.
    
    Specified by:
    
    sectionTitle3 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Ends a third title heading element.
    
    Specified by:
    
    sectionTitle3_ in interface Sink
  - sectionTitle4
```
public void sectionTitle4()
```
    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.
    
    Specified by:
    
    sectionTitle4 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Ends a 4th title heading element.
    
    Specified by:
    
    sectionTitle4_ in interface Sink
  - sectionTitle5
```
public void sectionTitle5()
```
    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.
    
    Specified by:
    
    sectionTitle5 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Ends a 5th title heading element.
    
    Specified by:
    
    sectionTitle5_ in interface Sink
  - sectionTitle6
```
public void sectionTitle6()
```
    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.
    
    Specified by:
    
    sectionTitle6 in interface Sink
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle6_
```
public void sectionTitle6_()
```
    Ends a 6th title heading element.
    
    Specified by:
    
    sectionTitle6_ in interface Sink
  - sectionTitle_
```
public void sectionTitle_()
```
    Ends a title heading element.
    
    Specified by:
    
    sectionTitle_ in interface Sink
  - sectionTitle_
```
public void sectionTitle_(int level)
```
    Ends a section title at the given level.
    
    Specified by:
    
    sectionTitle_ in interface Sink
    
    Parameters:
    
    level - the section title level.
  - section_
```
public void section_(int level)
```
    Ends a section at the given level.
    
    Specified by:
    
    section_ in interface Sink
    
    Parameters:
    
    level - the section level.
  - sidebar
```
public void sidebar()
```
    Starts a sidebar section within a document.
    
    Specified by:
    
    sidebar in interface Sink
    
    See Also:
    
    Sink.sidebar(SinkEventAttributes)
  - sidebar
```
public void sidebar(SinkEventAttributes attributes)
```
    Starts a sidebar section within a document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    sidebar in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - sidebar_
```
public void sidebar_()
```
    Ends the sidebar element.
    
    Specified by:
    
    sidebar_ in interface Sink
  - table
```
public void table()
```
    Starts a table element for marking up tabular information in a document.
    
    Specified by:
    
    table in interface Sink
    
    See Also:
    
    Sink.table(SinkEventAttributes)
  - table
```
public void table(SinkEventAttributes attributes)
```
    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.
    Specified by:
    
    table in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableCaption
```
public void tableCaption()
```
    Starts a caption element of a table.
    
    Specified by:
    
    tableCaption in interface Sink
    
    See Also:
    
    Sink.tableCaption(SinkEventAttributes)
  - tableCaption
```
public void tableCaption(SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    tableCaption in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.table(SinkEventAttributes)
  - tableCaption_
```
public void tableCaption_()
```
    Ends a caption element of a table.
    
    Specified by:
    
    tableCaption_ in interface Sink
  - tableCell
```
public void tableCell()
```
    Starts a cell element which defines a cell that contains data.
    
    Specified by:
    
    tableCell in interface Sink
    
    See Also:
    
    Sink.tableCell(SinkEventAttributes)
  - tableCell
```
public void tableCell(java.lang.String width)
```
    Starts 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(SinkEventAttributes attributes)
```
    Starts a table cell.
    Supported attributes are the base attributes plus:
    
    ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
    
    Specified by:
    
    tableCell in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableCell_
```
public void tableCell_()
```
    Ends a cell element.
    
    Specified by:
    
    tableCell_ in interface Sink
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Starts a cell element which defines a cell that contains header information.
    
    Specified by:
    
    tableHeaderCell in interface Sink
    
    See Also:
    
    Sink.tableHeaderCell(SinkEventAttributes)
  - tableHeaderCell
```
public void tableHeaderCell(java.lang.String width)
```
    Starts 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(SinkEventAttributes attributes)
```
    Starts a table header cell.
    Supported attributes are the same as for tableCell.
    
    Specified by:
    
    tableHeaderCell in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Ends a cell header element.
    
    Specified by:
    
    tableHeaderCell_ in interface Sink
  - tableRow
```
public void tableRow()
```
    Starts a row element which acts as a container for a row of table cells.
    
    Specified by:
    
    tableRow in interface Sink
    
    See Also:
    
    Sink.tableRow(SinkEventAttributes)
  - tableRow
```
public void tableRow(SinkEventAttributes attributes)
```
    Starts a table row.
    Supported attributes are the base attributes plus:
    
    ALIGN, BGCOLOR, VALIGN.
    
    Specified by:
    
    tableRow in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - tableRow_
```
public void tableRow_()
```
    Ends a row element.
    
    Specified by:
    
    tableRow_ in interface Sink
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    Starts an element that contains rows of table data.
    
    Specified by:
    
    tableRows in interface Sink
    
    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_()
```
    Ends an element that contains rows of table data.
    
    Specified by:
    
    tableRows_ in interface Sink
  - table_
```
public void table_()
```
    Ends a table element.
    
    Specified by:
    
    table_ 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.
    
    See Also:
    
    Sink.text(String,SinkEventAttributes)
  - text
```
public void text(java.lang.String text,
                 SinkEventAttributes attributes)
```
    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
    
    SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
    
    The following attributes are deprecated:
    
    VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
    
    Specified by:
    
    text in interface Sink
    
    Parameters:
    
    text - The text to write.
    
    attributes - A set of SinkEventAttributes, may be null.
  - time
```
public void time(java.lang.String datetime)
```
    Starts a time element which groups together other elements representing a time.
    
    Specified by:
    
    time in interface Sink
    
    See Also:
    
    Sink.time(String, SinkEventAttributes)
  - time
```
public void time(java.lang.String datetime,
                 SinkEventAttributes attributes)
```
    Starts a time element which groups together other elements representing a time.
    Supported attributes are the base attributes plus DATETIME.
    
    Specified by:
    
    time in interface Sink
    
    Parameters:
    
    datetime - the machine readable value of the time, may be null.
    
    attributes - A set of SinkEventAttributes, may be null.
  - time_
```
public void time_()
```
    Ends a time element.
    
    Specified by:
    
    time_ in interface Sink
  - title
```
public void title()
```
    Starts the title element.
    
    Specified by:
    
    title in interface Sink
    
    See Also:
    
    Sink.title(SinkEventAttributes)
  - title
```
public void title(SinkEventAttributes attributes)
```
    Starts the title element. This is used to identify the document.
    Supported attributes are the base attributes.
    
    Specified by:
    
    title in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
    
    See Also:
    
    Sink.head(SinkEventAttributes)
  - title_
```
public void title_()
```
    Ends the title element.
    
    Specified by:
    
    title_ in interface Sink
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    unknown in interface Sink
    
    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.
  - verbatim
```
public void verbatim(boolean boxed)
```
    Starts 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(SinkEventAttributes attributes)
```
    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.
    
    Specified by:
    
    verbatim in interface Sink
    
    Parameters:
    
    attributes - A set of SinkEventAttributes, may be null.
  - verbatim_
```
public void verbatim_()
```
    Ends a verbatim element.
    
    Specified by:
    
    verbatim_ in interface Sink
  - enableLogging
```
public void enableLogging(Log log)
```
    Enable a Doxia logger for this Doxia component.
    
    Specified by:
    
    enableLogging in interface LogEnabled
    
    Parameters:
    
    log - a Log.

Class RandomAccessSink

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sinkFactory

encoding

coreOutputStream

coreSink

sinks

outputStreams

currentSink

Constructor Detail

RandomAccessSink

RandomAccessSink

RandomAccessSink

RandomAccessSink

Method Detail

address

address

address_

addSinkHook

anchor

anchor

anchor_

article

article

article_

author

author

author_

blockquote

blockquote

blockquote_

body

body

body_

bold

bold_

close

comment

content

content

content_

data

data

data_

date

date

date_

definedTerm

definedTerm

definedTerm_

definition

definition

definitionList

definitionList

definitionListItem

definitionListItem

definitionListItem_

definitionList_

definition_

division

division

division_

figure

figure

figureCaption

figureCaption

figureCaption_

figureGraphics

figureGraphics

figure_

flush

footer

footer

footer_

head