Class RandomAccessSink

java.lang.Object
org.apache.maven.doxia.sink.impl.RandomAccessSink
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.sink.Sink

public class RandomAccessSink extends Object implements org.apache.maven.doxia.sink.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
Author:
Robert Scholte
  • Constructor Details

    • RandomAccessSink

      public RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory, OutputStream stream) throws IOException

      Constructor for RandomAccessSink.

      Parameters:
      sinkFactory - a SinkFactory object.
      stream - a OutputStream object.
      Throws:
      IOException - if any.
    • RandomAccessSink

      public RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory, OutputStream stream, String encoding) throws IOException

      Constructor for RandomAccessSink.

      Parameters:
      sinkFactory - a SinkFactory object.
      stream - a OutputStream object.
      encoding - a String object.
      Throws:
      IOException - if any.
    • RandomAccessSink

      public RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory, File outputDirectory, String outputName) throws IOException

      Constructor for RandomAccessSink.

      Parameters:
      sinkFactory - a SinkFactory object.
      outputDirectory - a File object.
      outputName - a String object.
      Throws:
      IOException - if any.
    • RandomAccessSink

      public RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory, File outputDirectory, String outputName, String encoding) throws IOException

      Constructor for RandomAccessSink.

      Parameters:
      sinkFactory - a SinkFactory object.
      outputDirectory - a File object.
      outputName - a String object.
      encoding - a String object.
      Throws:
      IOException - if any.
  • Method Details

    • address

      public void address()
      Specified by:
      address in interface org.apache.maven.doxia.sink.Sink
    • address

      public void address(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      address in interface org.apache.maven.doxia.sink.Sink
    • address_

      public void address_()
      Specified by:
      address_ in interface org.apache.maven.doxia.sink.Sink
    • addSinkHook

      public org.apache.maven.doxia.sink.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(String name)
      Specified by:
      anchor in interface org.apache.maven.doxia.sink.Sink
    • anchor

      public void anchor(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      anchor in interface org.apache.maven.doxia.sink.Sink
    • anchor_

      public void anchor_()
      Specified by:
      anchor_ in interface org.apache.maven.doxia.sink.Sink
    • article

      public void article()
      Specified by:
      article in interface org.apache.maven.doxia.sink.Sink
    • article

      public void article(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      article in interface org.apache.maven.doxia.sink.Sink
    • article_

      public void article_()
      Specified by:
      article_ in interface org.apache.maven.doxia.sink.Sink
    • author

      public void author()
      Specified by:
      author in interface org.apache.maven.doxia.sink.Sink
    • author

      public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      author in interface org.apache.maven.doxia.sink.Sink
    • author_

      public void author_()
      Specified by:
      author_ in interface org.apache.maven.doxia.sink.Sink
    • blockquote

      public void blockquote()
      Specified by:
      blockquote in interface org.apache.maven.doxia.sink.Sink
    • blockquote

      public void blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      blockquote in interface org.apache.maven.doxia.sink.Sink
    • blockquote_

      public void blockquote_()
      Specified by:
      blockquote_ in interface org.apache.maven.doxia.sink.Sink
    • body

      public void body()
      Specified by:
      body in interface org.apache.maven.doxia.sink.Sink
    • body

      public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      body in interface org.apache.maven.doxia.sink.Sink
    • body_

      public void body_()
      Specified by:
      body_ in interface org.apache.maven.doxia.sink.Sink
    • bold

      public void bold()
      Specified by:
      bold in interface org.apache.maven.doxia.sink.Sink
    • bold_

      public void bold_()
      Specified by:
      bold_ in interface org.apache.maven.doxia.sink.Sink
    • close

      public void close()
      Close all sinks
      Specified by:
      close in interface org.apache.maven.doxia.sink.Sink
    • comment

      public void comment(String comment)
      Specified by:
      comment in interface org.apache.maven.doxia.sink.Sink
    • content

      public void content()
      Specified by:
      content in interface org.apache.maven.doxia.sink.Sink
    • content

      public void content(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      content in interface org.apache.maven.doxia.sink.Sink
    • content_

      public void content_()
      Specified by:
      content_ in interface org.apache.maven.doxia.sink.Sink
    • data

      public void data(String value)
      Specified by:
      data in interface org.apache.maven.doxia.sink.Sink
    • data

      public void data(String value, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      data in interface org.apache.maven.doxia.sink.Sink
    • data_

      public void data_()
      Specified by:
      data_ in interface org.apache.maven.doxia.sink.Sink
    • date

      public void date()
      Specified by:
      date in interface org.apache.maven.doxia.sink.Sink
    • date

      public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      date in interface org.apache.maven.doxia.sink.Sink
    • date_

      public void date_()
      Specified by:
      date_ in interface org.apache.maven.doxia.sink.Sink
    • definedTerm

      public void definedTerm()
      Specified by:
      definedTerm in interface org.apache.maven.doxia.sink.Sink
    • definedTerm

      public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      definedTerm in interface org.apache.maven.doxia.sink.Sink
    • definedTerm_

      public void definedTerm_()
      Specified by:
      definedTerm_ in interface org.apache.maven.doxia.sink.Sink
    • definition

      public void definition()
      Specified by:
      definition in interface org.apache.maven.doxia.sink.Sink
    • definition

      public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      definition in interface org.apache.maven.doxia.sink.Sink
    • definitionList

      public void definitionList()
      Specified by:
      definitionList in interface org.apache.maven.doxia.sink.Sink
    • definitionList

      public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      definitionList in interface org.apache.maven.doxia.sink.Sink
    • definitionListItem

      public void definitionListItem()
      Specified by:
      definitionListItem in interface org.apache.maven.doxia.sink.Sink
    • definitionListItem

      public void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      definitionListItem in interface org.apache.maven.doxia.sink.Sink
    • definitionListItem_

      public void definitionListItem_()
      Specified by:
      definitionListItem_ in interface org.apache.maven.doxia.sink.Sink
    • definitionList_

      public void definitionList_()
      Specified by:
      definitionList_ in interface org.apache.maven.doxia.sink.Sink
    • definition_

      public void definition_()
      Specified by:
      definition_ in interface org.apache.maven.doxia.sink.Sink
    • division

      public void division()
      Specified by:
      division in interface org.apache.maven.doxia.sink.Sink
    • division

      public void division(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      division in interface org.apache.maven.doxia.sink.Sink
    • division_

      public void division_()
      Specified by:
      division_ in interface org.apache.maven.doxia.sink.Sink
    • figure

      public void figure()
      Specified by:
      figure in interface org.apache.maven.doxia.sink.Sink
    • figure

      public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      figure in interface org.apache.maven.doxia.sink.Sink
    • figureCaption

      public void figureCaption()
      Specified by:
      figureCaption in interface org.apache.maven.doxia.sink.Sink
    • figureCaption

      public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      figureCaption in interface org.apache.maven.doxia.sink.Sink
    • figureCaption_

      public void figureCaption_()
      Specified by:
      figureCaption_ in interface org.apache.maven.doxia.sink.Sink
    • figureGraphics

      public void figureGraphics(String name)
      Specified by:
      figureGraphics in interface org.apache.maven.doxia.sink.Sink
    • figureGraphics

      public void figureGraphics(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      figureGraphics in interface org.apache.maven.doxia.sink.Sink
    • figure_

      public void figure_()
      Specified by:
      figure_ in interface org.apache.maven.doxia.sink.Sink
    • flush

      public void flush()
      Flush all sinks
      Specified by:
      flush in interface org.apache.maven.doxia.sink.Sink
    • footer

      public void footer()
      Specified by:
      footer in interface org.apache.maven.doxia.sink.Sink
    • footer

      public void footer(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      footer in interface org.apache.maven.doxia.sink.Sink
    • head

      public void head()
      Specified by:
      head in interface org.apache.maven.doxia.sink.Sink
    • head

      public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      head in interface org.apache.maven.doxia.sink.Sink
    • head_

      public void head_()
      Specified by:
      head_ in interface org.apache.maven.doxia.sink.Sink
    • header

      public void header()
      Specified by:
      header in interface org.apache.maven.doxia.sink.Sink
    • header

      public void header(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      header in interface org.apache.maven.doxia.sink.Sink
    • header_

      public void header_()
      Specified by:
      header_ in interface org.apache.maven.doxia.sink.Sink
    • horizontalRule

      public void horizontalRule()
      Specified by:
      horizontalRule in interface org.apache.maven.doxia.sink.Sink
    • horizontalRule

      public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      horizontalRule in interface org.apache.maven.doxia.sink.Sink
    • inline

      public void inline()
      Specified by:
      inline in interface org.apache.maven.doxia.sink.Sink
    • inline

      public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      inline in interface org.apache.maven.doxia.sink.Sink
    • inline_

      public void inline_()
      Specified by:
      inline_ in interface org.apache.maven.doxia.sink.Sink
    • italic

      public void italic()
      Specified by:
      italic in interface org.apache.maven.doxia.sink.Sink
    • italic_

      public void italic_()
      Specified by:
      italic_ in interface org.apache.maven.doxia.sink.Sink
    • lineBreak

      public void lineBreak()
      Specified by:
      lineBreak in interface org.apache.maven.doxia.sink.Sink
    • lineBreak

      public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      lineBreak in interface org.apache.maven.doxia.sink.Sink
    • lineBreakOpportunity

      public void lineBreakOpportunity()
      Specified by:
      lineBreakOpportunity in interface org.apache.maven.doxia.sink.Sink
    • lineBreakOpportunity

      public void lineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      lineBreakOpportunity in interface org.apache.maven.doxia.sink.Sink
    • link

      public void link(String name)
      Specified by:
      link in interface org.apache.maven.doxia.sink.Sink
    • link

      public void link(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      link in interface org.apache.maven.doxia.sink.Sink
    • list

      public void list()
      Specified by:
      list in interface org.apache.maven.doxia.sink.Sink
    • list

      public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      list in interface org.apache.maven.doxia.sink.Sink
    • listItem

      public void listItem()
      Specified by:
      listItem in interface org.apache.maven.doxia.sink.Sink
    • listItem

      public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      listItem in interface org.apache.maven.doxia.sink.Sink
    • listItem_

      public void listItem_()
      Specified by:
      listItem_ in interface org.apache.maven.doxia.sink.Sink
    • list_

      public void list_()
      Specified by:
      list_ in interface org.apache.maven.doxia.sink.Sink
    • monospaced

      public void monospaced()
      Specified by:
      monospaced in interface org.apache.maven.doxia.sink.Sink
    • monospaced_

      public void monospaced_()
      Specified by:
      monospaced_ in interface org.apache.maven.doxia.sink.Sink
    • nonBreakingSpace

      public void nonBreakingSpace()
      Specified by:
      nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink
    • numberedList

      public void numberedList(int numbering)
      Specified by:
      numberedList in interface org.apache.maven.doxia.sink.Sink
    • numberedList

      public void numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      numberedList in interface org.apache.maven.doxia.sink.Sink
    • numberedListItem

      public void numberedListItem()
      Specified by:
      numberedListItem in interface org.apache.maven.doxia.sink.Sink
    • numberedListItem

      public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      numberedListItem in interface org.apache.maven.doxia.sink.Sink
    • numberedListItem_

      public void numberedListItem_()
      Specified by:
      numberedListItem_ in interface org.apache.maven.doxia.sink.Sink
    • numberedList_

      public void numberedList_()
      Specified by:
      numberedList_ in interface org.apache.maven.doxia.sink.Sink
    • pageBreak

      public void pageBreak()
      Specified by:
      pageBreak in interface org.apache.maven.doxia.sink.Sink
    • paragraph

      public void paragraph()
      Specified by:
      paragraph in interface org.apache.maven.doxia.sink.Sink
    • paragraph

      public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      paragraph in interface org.apache.maven.doxia.sink.Sink
    • paragraph_

      public void paragraph_()
      Specified by:
      paragraph_ in interface org.apache.maven.doxia.sink.Sink
    • rawText

      public void rawText(String text)
      Specified by:
      rawText in interface org.apache.maven.doxia.sink.Sink
    • section

      public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      section in interface org.apache.maven.doxia.sink.Sink
    • section1

      public void section1()
      Specified by:
      section1 in interface org.apache.maven.doxia.sink.Sink
    • section1_

      public void section1_()
      Specified by:
      section1_ in interface org.apache.maven.doxia.sink.Sink
    • section2

      public void section2()
      Specified by:
      section2 in interface org.apache.maven.doxia.sink.Sink
    • section2_

      public void section2_()
      Specified by:
      section2_ in interface org.apache.maven.doxia.sink.Sink
    • section3

      public void section3()
      Specified by:
      section3 in interface org.apache.maven.doxia.sink.Sink
    • section3_

      public void section3_()
      Specified by:
      section3_ in interface org.apache.maven.doxia.sink.Sink
    • section4

      public void section4()
      Specified by:
      section4 in interface org.apache.maven.doxia.sink.Sink
    • section4_

      public void section4_()
      Specified by:
      section4_ in interface org.apache.maven.doxia.sink.Sink
    • section5

      public void section5()
      Specified by:
      section5 in interface org.apache.maven.doxia.sink.Sink
    • section5_

      public void section5_()
      Specified by:
      section5_ in interface org.apache.maven.doxia.sink.Sink
    • section6

      public void section6()
      Specified by:
      section6 in interface org.apache.maven.doxia.sink.Sink
    • section6_

      public void section6_()
      Specified by:
      section6_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle

      public void sectionTitle()
      Specified by:
      sectionTitle in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle

      public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      sectionTitle in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle1

      public void sectionTitle1()
      Specified by:
      sectionTitle1 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle1_

      public void sectionTitle1_()
      Specified by:
      sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle2

      public void sectionTitle2()
      Specified by:
      sectionTitle2 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle2_

      public void sectionTitle2_()
      Specified by:
      sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle3

      public void sectionTitle3()
      Specified by:
      sectionTitle3 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle3_

      public void sectionTitle3_()
      Specified by:
      sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle4

      public void sectionTitle4()
      Specified by:
      sectionTitle4 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle4_

      public void sectionTitle4_()
      Specified by:
      sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle5

      public void sectionTitle5()
      Specified by:
      sectionTitle5 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle5_

      public void sectionTitle5_()
      Specified by:
      sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle6

      public void sectionTitle6()
      Specified by:
      sectionTitle6 in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle6_

      public void sectionTitle6_()
      Specified by:
      sectionTitle6_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle_

      public void sectionTitle_()
      Specified by:
      sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
    • sectionTitle_

      public void sectionTitle_(int level)
      Specified by:
      sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
    • section_

      public void section_(int level)
      Specified by:
      section_ in interface org.apache.maven.doxia.sink.Sink
    • sidebar

      public void sidebar()
      Specified by:
      sidebar in interface org.apache.maven.doxia.sink.Sink
    • sidebar

      public void sidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      sidebar in interface org.apache.maven.doxia.sink.Sink
    • table

      public void table()
      Specified by:
      table in interface org.apache.maven.doxia.sink.Sink
    • table

      public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      table in interface org.apache.maven.doxia.sink.Sink
    • tableCaption

      public void tableCaption()
      Specified by:
      tableCaption in interface org.apache.maven.doxia.sink.Sink
    • tableCaption

      public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      tableCaption in interface org.apache.maven.doxia.sink.Sink
    • tableCaption_

      public void tableCaption_()
      Specified by:
      tableCaption_ in interface org.apache.maven.doxia.sink.Sink
    • tableCell

      public void tableCell()
      Specified by:
      tableCell in interface org.apache.maven.doxia.sink.Sink
    • tableCell

      public void tableCell(String width)
      Specified by:
      tableCell in interface org.apache.maven.doxia.sink.Sink
    • tableCell

      public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      tableCell in interface org.apache.maven.doxia.sink.Sink
    • tableCell_

      public void tableCell_()
      Specified by:
      tableCell_ in interface org.apache.maven.doxia.sink.Sink
    • tableHeaderCell

      public void tableHeaderCell()
      Specified by:
      tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
    • tableHeaderCell

      public void tableHeaderCell(String width)
      Specified by:
      tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
    • tableHeaderCell

      public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
    • tableHeaderCell_

      public void tableHeaderCell_()
      Specified by:
      tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink
    • tableRow

      public void tableRow()
      Specified by:
      tableRow in interface org.apache.maven.doxia.sink.Sink
    • tableRow

      public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      tableRow in interface org.apache.maven.doxia.sink.Sink
    • tableRow_

      public void tableRow_()
      Specified by:
      tableRow_ in interface org.apache.maven.doxia.sink.Sink
    • tableRows

      public void tableRows(int[] justification, boolean grid)
      Specified by:
      tableRows in interface org.apache.maven.doxia.sink.Sink
    • tableRows_

      public void tableRows_()
      Specified by:
      tableRows_ in interface org.apache.maven.doxia.sink.Sink
    • table_

      public void table_()
      Specified by:
      table_ in interface org.apache.maven.doxia.sink.Sink
    • text

      public void text(String text)
      Specified by:
      text in interface org.apache.maven.doxia.sink.Sink
    • text

      public void text(String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      text in interface org.apache.maven.doxia.sink.Sink
    • time

      public void time(String datetime)
      Specified by:
      time in interface org.apache.maven.doxia.sink.Sink
    • time

      public void time(String datetime, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      time in interface org.apache.maven.doxia.sink.Sink
    • time_

      public void time_()
      Specified by:
      time_ in interface org.apache.maven.doxia.sink.Sink
    • title

      public void title()
      Specified by:
      title in interface org.apache.maven.doxia.sink.Sink
    • title

      public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      title in interface org.apache.maven.doxia.sink.Sink
    • title_

      public void title_()
      Specified by:
      title_ in interface org.apache.maven.doxia.sink.Sink
    • unknown

      public void unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      unknown in interface org.apache.maven.doxia.sink.Sink
    • verbatim

      public void verbatim(boolean boxed)
      Specified by:
      verbatim in interface org.apache.maven.doxia.sink.Sink
    • verbatim

      public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Specified by:
      verbatim in interface org.apache.maven.doxia.sink.Sink
    • verbatim_

      public void verbatim_()
      Specified by:
      verbatim_ in interface org.apache.maven.doxia.sink.Sink
    • enableLogging

      public void enableLogging(org.apache.maven.doxia.logging.Log log)
      Specified by:
      enableLogging in interface org.apache.maven.doxia.logging.LogEnabled