org.apache.maven.doxia.sink
Class RandomAccessSink

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

All Implemented Interfaces:

LogEnabled, Sink

public class RandomAccessSink
extends 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

Author:

Robert Scholte

Field Summary

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

Constructor Summary

RandomAccessSink(SinkFactory sinkFactory, File outputDirectory, String outputName)

RandomAccessSink(SinkFactory sinkFactory, File outputDirectory, String outputName, String encoding)

RandomAccessSink(SinkFactory sinkFactory, OutputStream stream)

RandomAccessSink(SinkFactory sinkFactory, OutputStream stream, String encoding)

Method Summary

Sink	addSinkHook() By calling this method a sink reference is added at the current position.
void	anchor_()
void	anchor(String name)
void	anchor(String name, SinkEventAttributes attributes)
void	author_()
void	author()
void	author(SinkEventAttributes attributes)
void	body_()
void	body()
void	body(SinkEventAttributes attributes)
void	bold_()
void	bold()
void	close() Close all sinks
void	comment(String comment)
void	date_()
void	date()
void	date(SinkEventAttributes attributes)
void	definedTerm_()
void	definedTerm()
void	definedTerm(SinkEventAttributes attributes)
void	definition_()
void	definition()
void	definition(SinkEventAttributes attributes)
void	definitionList_()
void	definitionList()
void	definitionList(SinkEventAttributes attributes)
void	definitionListItem_()
void	definitionListItem()
void	definitionListItem(SinkEventAttributes attributes)
void	enableLogging(Log log)
void	figure_()
void	figure()
void	figure(SinkEventAttributes attributes)
void	figureCaption_()
void	figureCaption()
void	figureCaption(SinkEventAttributes attributes)
void	figureGraphics(String name)
void	figureGraphics(String src, SinkEventAttributes attributes)
void	flush() Flush all sinks
void	head_()
void	head()
void	head(SinkEventAttributes attributes)
void	horizontalRule()
void	horizontalRule(SinkEventAttributes attributes)
void	italic_()
void	italic()
void	lineBreak()
void	lineBreak(SinkEventAttributes attributes)
void	link_()
void	link(String name)
void	link(String name, SinkEventAttributes attributes)
void	list_()
void	list()
void	list(SinkEventAttributes attributes)
void	listItem_()
void	listItem()
void	listItem(SinkEventAttributes attributes)
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering)
void	numberedList(int numbering, SinkEventAttributes attributes)
void	numberedListItem_()
void	numberedListItem()
void	numberedListItem(SinkEventAttributes attributes)
void	pageBreak()
void	paragraph_()
void	paragraph()
void	paragraph(SinkEventAttributes attributes)
void	rawText(String text)
void	section_(int level)
void	section(int level, SinkEventAttributes attributes)
void	section1_()
void	section1()
void	section2_()
void	section2()
void	section3_()
void	section3()
void	section4_()
void	section4()
void	section5_()
void	section5()
void	sectionTitle_()
void	sectionTitle_(int level)
void	sectionTitle()
void	sectionTitle(int level, SinkEventAttributes attributes)
void	sectionTitle1_()
void	sectionTitle1()
void	sectionTitle2_()
void	sectionTitle2()
void	sectionTitle3_()
void	sectionTitle3()
void	sectionTitle4_()
void	sectionTitle4()
void	sectionTitle5_()
void	sectionTitle5()
void	table_()
void	table()
void	table(SinkEventAttributes attributes)
void	tableCaption_()
void	tableCaption()
void	tableCaption(SinkEventAttributes attributes)
void	tableCell_()
void	tableCell()
void	tableCell(SinkEventAttributes attributes)
void	tableCell(String width)
void	tableHeaderCell_()
void	tableHeaderCell()
void	tableHeaderCell(SinkEventAttributes attributes)
void	tableHeaderCell(String width)
void	tableRow_()
void	tableRow()
void	tableRow(SinkEventAttributes attributes)
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(String text)
void	text(String text, SinkEventAttributes attributes)
void	title_()
void	title()
void	title(SinkEventAttributes attributes)
void	unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
void	verbatim_()
void	verbatim(boolean boxed)
void	verbatim(SinkEventAttributes attributes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RandomAccessSink

public RandomAccessSink(SinkFactory sinkFactory,
                        OutputStream stream)
                 throws IOException

Throws:

IOException

RandomAccessSink

public RandomAccessSink(SinkFactory sinkFactory,
                        OutputStream stream,
                        String encoding)
                 throws IOException

Throws:

IOException

RandomAccessSink

public RandomAccessSink(SinkFactory sinkFactory,
                        File outputDirectory,
                        String outputName)
                 throws IOException

Throws:

IOException

RandomAccessSink

public RandomAccessSink(SinkFactory sinkFactory,
                        File outputDirectory,
                        String outputName,
                        String encoding)
                 throws IOException

Throws:

IOException

Method Detail

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(String name)

Specified by:

anchor in interface Sink

anchor

public void anchor(String name,
                   SinkEventAttributes attributes)

Specified by:

anchor in interface Sink

anchor_

public void anchor_()

Specified by:

anchor_ in interface Sink

author

public void author()

Specified by:

author in interface Sink

author

public void author(SinkEventAttributes attributes)

Specified by:

author in interface Sink

author_

public void author_()

Specified by:

author_ in interface Sink

body

public void body()

Specified by:

body in interface Sink

body

public void body(SinkEventAttributes attributes)

Specified by:

body in interface Sink

body_

public void body_()

Specified by:

body_ in interface Sink

bold

public void bold()

Specified by:

bold in interface Sink

bold_

public void bold_()

Specified by:

bold_ in interface Sink

close

public void close()

Close all sinks

Specified by:

close in interface Sink

comment

public void comment(String comment)

Specified by:

comment in interface Sink

date

public void date()

Specified by:

date in interface Sink

date

public void date(SinkEventAttributes attributes)

Specified by:

date in interface Sink

date_

public void date_()

Specified by:

date_ in interface Sink

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface Sink

definedTerm

public void definedTerm(SinkEventAttributes attributes)

Specified by:

definedTerm in interface Sink

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface Sink

definition

public void definition()

Specified by:

definition in interface Sink

definition

public void definition(SinkEventAttributes attributes)

Specified by:

definition in interface Sink

definitionList

public void definitionList()

Specified by:

definitionList in interface Sink

definitionList

public void definitionList(SinkEventAttributes attributes)

Specified by:

definitionList in interface Sink

definitionListItem

public void definitionListItem()

Specified by:

definitionListItem in interface Sink

definitionListItem

public void definitionListItem(SinkEventAttributes attributes)

Specified by:

definitionListItem in interface Sink

definitionListItem_

public void definitionListItem_()

Specified by:

definitionListItem_ in interface Sink

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface Sink

definition_

public void definition_()

Specified by:

definition_ in interface Sink

figure

public void figure()

Specified by:

figure in interface Sink

figure

public void figure(SinkEventAttributes attributes)

Specified by:

figure in interface Sink

figureCaption

public void figureCaption()

Specified by:

figureCaption in interface Sink

figureCaption

public void figureCaption(SinkEventAttributes attributes)

Specified by:

figureCaption in interface Sink

figureCaption_

public void figureCaption_()

Specified by:

figureCaption_ in interface Sink

figureGraphics

public void figureGraphics(String name)

Specified by:

figureGraphics in interface Sink

figureGraphics

public void figureGraphics(String src,
                           SinkEventAttributes attributes)

Specified by:

figureGraphics in interface Sink

figure_

public void figure_()

Specified by:

figure_ in interface Sink

flush

public void flush()

Flush all sinks

Specified by:

flush in interface Sink

head

public void head()

Specified by:

head in interface Sink

head

public void head(SinkEventAttributes attributes)

Specified by:

head in interface Sink

head_

public void head_()

Specified by:

head_ in interface Sink

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface Sink

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)

Specified by:

horizontalRule in interface Sink

italic

public void italic()

Specified by:

italic in interface Sink

italic_

public void italic_()

Specified by:

italic_ in interface Sink

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface Sink

lineBreak

public void lineBreak(SinkEventAttributes attributes)

Specified by:

lineBreak in interface Sink

link

public void link(String name)

Specified by:

link in interface Sink

link

public void link(String name,
                 SinkEventAttributes attributes)

Specified by:

link in interface Sink

link_

public void link_()

Specified by:

link_ in interface Sink

list

public void list()

Specified by:

list in interface Sink

list

public void list(SinkEventAttributes attributes)

Specified by:

list in interface Sink

listItem

public void listItem()

Specified by:

listItem in interface Sink

listItem

public void listItem(SinkEventAttributes attributes)

Specified by:

listItem in interface Sink

listItem_

public void listItem_()

Specified by:

listItem_ in interface Sink

list_

public void list_()

Specified by:

list_ in interface Sink

monospaced

public void monospaced()

Specified by:

monospaced in interface Sink

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface Sink

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface Sink

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface Sink

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)

Specified by:

numberedList in interface Sink

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface Sink

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)

Specified by:

numberedListItem in interface Sink

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface Sink

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface Sink

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface Sink

paragraph

public void paragraph()

Specified by:

paragraph in interface Sink

paragraph

public void paragraph(SinkEventAttributes attributes)

Specified by:

paragraph in interface Sink

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface Sink

rawText

public void rawText(String text)

Specified by:

rawText in interface Sink

section

public void section(int level,
                    SinkEventAttributes attributes)

Specified by:

section in interface Sink

section1

public void section1()

Specified by:

section1 in interface Sink

section1_

public void section1_()

Specified by:

section1_ in interface Sink

section2

public void section2()

Specified by:

section2 in interface Sink

section2_

public void section2_()

Specified by:

section2_ in interface Sink

section3

public void section3()

Specified by:

section3 in interface Sink

section3_

public void section3_()

Specified by:

section3_ in interface Sink

section4

public void section4()

Specified by:

section4 in interface Sink

section4_

public void section4_()

Specified by:

section4_ in interface Sink

section5

public void section5()

Specified by:

section5 in interface Sink

section5_

public void section5_()

Specified by:

section5_ in interface Sink

sectionTitle

public void sectionTitle()

Specified by:

sectionTitle in interface Sink

sectionTitle

public void sectionTitle(int level,
                         SinkEventAttributes attributes)

Specified by:

sectionTitle in interface Sink

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface Sink

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface Sink

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface Sink

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface Sink

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface Sink

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface Sink

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface Sink

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface Sink

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface Sink

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface Sink

sectionTitle_

public void sectionTitle_()

Specified by:

sectionTitle_ in interface Sink

sectionTitle_

public void sectionTitle_(int level)

Specified by:

sectionTitle_ in interface Sink

section_

public void section_(int level)

Specified by:

section_ in interface Sink

table

public void table()

Specified by:

table in interface Sink

table

public void table(SinkEventAttributes attributes)

Specified by:

table in interface Sink

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface Sink

tableCaption

public void tableCaption(SinkEventAttributes attributes)

Specified by:

tableCaption in interface Sink

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface Sink

tableCell

public void tableCell()

Specified by:

tableCell in interface Sink

tableCell

public void tableCell(String width)

Specified by:

tableCell in interface Sink

tableCell

public void tableCell(SinkEventAttributes attributes)

Specified by:

tableCell in interface Sink

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface Sink

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface Sink

tableHeaderCell

public void tableHeaderCell(String width)

Specified by:

tableHeaderCell in interface Sink

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)

Specified by:

tableHeaderCell in interface Sink

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface Sink

tableRow

public void tableRow()

Specified by:

tableRow in interface Sink

tableRow

public void tableRow(SinkEventAttributes attributes)

Specified by:

tableRow in interface Sink

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface Sink

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:

tableRows in interface Sink

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface Sink

table_

public void table_()

Specified by:

table_ in interface Sink

text

public void text(String text)

Specified by:

text in interface Sink

text

public void text(String text,
                 SinkEventAttributes attributes)

Specified by:

text in interface Sink

title

public void title()

Specified by:

title in interface Sink

title

public void title(SinkEventAttributes attributes)

Specified by:

title in interface Sink

title_

public void title_()

Specified by:

title_ in interface Sink

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Specified by:

unknown in interface Sink

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface Sink

verbatim

public void verbatim(SinkEventAttributes attributes)

Specified by:

verbatim in interface Sink

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface Sink

enableLogging

public void enableLogging(Log log)

Specified by:

enableLogging in interface LogEnabled