org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.sink.Sinkpublic class RandomAccessSink
extends java.lang.Object
implements org.apache.maven.doxia.sink.Sink
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.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 | Description |
|---|---|
RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.File outputDirectory,
java.lang.String outputName) |
|
RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.File outputDirectory,
java.lang.String outputName,
java.lang.String encoding) |
|
RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.OutputStream stream) |
|
RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.OutputStream stream,
java.lang.String encoding) |
| Modifier and Type | Method | Description |
|---|---|---|
org.apache.maven.doxia.sink.Sink |
addSinkHook() |
By calling this method a sink reference is added at the current position.
|
void |
anchor(java.lang.String name) |
|
void |
anchor(java.lang.String name,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
anchor_() |
|
void |
author() |
|
void |
author(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
author_() |
|
void |
body() |
|
void |
body(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
body_() |
|
void |
bold() |
|
void |
bold_() |
|
void |
close() |
Close all sinks
|
void |
comment(java.lang.String comment) |
|
void |
date() |
|
void |
date(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
date_() |
|
void |
definedTerm() |
|
void |
definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
definedTerm_() |
|
void |
definition() |
|
void |
definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
definition_() |
|
void |
definitionList() |
|
void |
definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
definitionList_() |
|
void |
definitionListItem() |
|
void |
definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
definitionListItem_() |
|
void |
enableLogging(org.apache.maven.doxia.logging.Log log) |
|
void |
figure() |
|
void |
figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
figure_() |
|
void |
figureCaption() |
|
void |
figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
figureCaption_() |
|
void |
figureGraphics(java.lang.String name) |
|
void |
figureGraphics(java.lang.String src,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
flush() |
Flush all sinks
|
void |
head() |
|
void |
head(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
head_() |
|
void |
horizontalRule() |
|
void |
horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
italic() |
|
void |
italic_() |
|
void |
lineBreak() |
|
void |
lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
link(java.lang.String name) |
|
void |
link(java.lang.String name,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
link_() |
|
void |
list() |
|
void |
list(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
list_() |
|
void |
listItem() |
|
void |
listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
listItem_() |
|
void |
monospaced() |
|
void |
monospaced_() |
|
void |
nonBreakingSpace() |
|
void |
numberedList(int numbering) |
|
void |
numberedList(int numbering,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
numberedList_() |
|
void |
numberedListItem() |
|
void |
numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
numberedListItem_() |
|
void |
pageBreak() |
|
void |
paragraph() |
|
void |
paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
paragraph_() |
|
void |
rawText(java.lang.String text) |
|
void |
section(int level,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
section_(int level) |
|
void |
section1() |
|
void |
section1_() |
|
void |
section2() |
|
void |
section2_() |
|
void |
section3() |
|
void |
section3_() |
|
void |
section4() |
|
void |
section4_() |
|
void |
section5() |
|
void |
section5_() |
|
void |
section6() |
|
void |
section6_() |
|
void |
sectionTitle() |
|
void |
sectionTitle(int level,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
sectionTitle_() |
|
void |
sectionTitle_(int level) |
|
void |
sectionTitle1() |
|
void |
sectionTitle1_() |
|
void |
sectionTitle2() |
|
void |
sectionTitle2_() |
|
void |
sectionTitle3() |
|
void |
sectionTitle3_() |
|
void |
sectionTitle4() |
|
void |
sectionTitle4_() |
|
void |
sectionTitle5() |
|
void |
sectionTitle5_() |
|
void |
sectionTitle6() |
|
void |
sectionTitle6_() |
|
void |
table() |
|
void |
table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
table_() |
|
void |
tableCaption() |
|
void |
tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
tableCaption_() |
|
void |
tableCell() |
|
void |
tableCell(java.lang.String width) |
|
void |
tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
tableCell_() |
|
void |
tableHeaderCell() |
|
void |
tableHeaderCell(java.lang.String width) |
|
void |
tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
tableHeaderCell_() |
|
void |
tableRow() |
|
void |
tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
tableRow_() |
|
void |
tableRows(int[] justification,
boolean grid) |
|
void |
tableRows_() |
|
void |
text(java.lang.String text) |
|
void |
text(java.lang.String text,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
title() |
|
void |
title(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
title_() |
|
void |
unknown(java.lang.String name,
java.lang.Object[] requiredParams,
org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
verbatim(boolean boxed) |
|
void |
verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) |
|
void |
verbatim_() |
public RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.OutputStream stream)
throws java.io.IOException
java.io.IOExceptionpublic RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.OutputStream stream,
java.lang.String encoding)
throws java.io.IOException
java.io.IOExceptionpublic RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.File outputDirectory,
java.lang.String outputName)
throws java.io.IOException
java.io.IOExceptionpublic RandomAccessSink(org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.io.File outputDirectory,
java.lang.String outputName,
java.lang.String encoding)
throws java.io.IOException
java.io.IOExceptionpublic org.apache.maven.doxia.sink.Sink addSinkHook()
public void anchor(java.lang.String name)
anchor in interface org.apache.maven.doxia.sink.Sinkpublic void anchor(java.lang.String name,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
anchor in interface org.apache.maven.doxia.sink.Sinkpublic void anchor_()
anchor_ in interface org.apache.maven.doxia.sink.Sinkpublic void author()
author in interface org.apache.maven.doxia.sink.Sinkpublic void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
author in interface org.apache.maven.doxia.sink.Sinkpublic void author_()
author_ in interface org.apache.maven.doxia.sink.Sinkpublic void body()
body in interface org.apache.maven.doxia.sink.Sinkpublic void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
body in interface org.apache.maven.doxia.sink.Sinkpublic void body_()
body_ in interface org.apache.maven.doxia.sink.Sinkpublic void bold()
bold in interface org.apache.maven.doxia.sink.Sinkpublic void bold_()
bold_ in interface org.apache.maven.doxia.sink.Sinkpublic void close()
close in interface org.apache.maven.doxia.sink.Sinkpublic void comment(java.lang.String comment)
comment in interface org.apache.maven.doxia.sink.Sinkpublic void date()
date in interface org.apache.maven.doxia.sink.Sinkpublic void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
date in interface org.apache.maven.doxia.sink.Sinkpublic void date_()
date_ in interface org.apache.maven.doxia.sink.Sinkpublic void definedTerm()
definedTerm in interface org.apache.maven.doxia.sink.Sinkpublic void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
definedTerm in interface org.apache.maven.doxia.sink.Sinkpublic void definedTerm_()
definedTerm_ in interface org.apache.maven.doxia.sink.Sinkpublic void definition()
definition in interface org.apache.maven.doxia.sink.Sinkpublic void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
definition in interface org.apache.maven.doxia.sink.Sinkpublic void definitionList()
definitionList in interface org.apache.maven.doxia.sink.Sinkpublic void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
definitionList in interface org.apache.maven.doxia.sink.Sinkpublic void definitionListItem()
definitionListItem in interface org.apache.maven.doxia.sink.Sinkpublic void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
definitionListItem in interface org.apache.maven.doxia.sink.Sinkpublic void definitionListItem_()
definitionListItem_ in interface org.apache.maven.doxia.sink.Sinkpublic void definitionList_()
definitionList_ in interface org.apache.maven.doxia.sink.Sinkpublic void definition_()
definition_ in interface org.apache.maven.doxia.sink.Sinkpublic void figure()
figure in interface org.apache.maven.doxia.sink.Sinkpublic void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
figure in interface org.apache.maven.doxia.sink.Sinkpublic void figureCaption()
figureCaption in interface org.apache.maven.doxia.sink.Sinkpublic void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
figureCaption in interface org.apache.maven.doxia.sink.Sinkpublic void figureCaption_()
figureCaption_ in interface org.apache.maven.doxia.sink.Sinkpublic void figureGraphics(java.lang.String name)
figureGraphics in interface org.apache.maven.doxia.sink.Sinkpublic void figureGraphics(java.lang.String src,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
figureGraphics in interface org.apache.maven.doxia.sink.Sinkpublic void figure_()
figure_ in interface org.apache.maven.doxia.sink.Sinkpublic void flush()
flush in interface org.apache.maven.doxia.sink.Sinkpublic void head()
head in interface org.apache.maven.doxia.sink.Sinkpublic void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
head in interface org.apache.maven.doxia.sink.Sinkpublic void head_()
head_ in interface org.apache.maven.doxia.sink.Sinkpublic void horizontalRule()
horizontalRule in interface org.apache.maven.doxia.sink.Sinkpublic void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
horizontalRule in interface org.apache.maven.doxia.sink.Sinkpublic void italic()
italic in interface org.apache.maven.doxia.sink.Sinkpublic void italic_()
italic_ in interface org.apache.maven.doxia.sink.Sinkpublic void lineBreak()
lineBreak in interface org.apache.maven.doxia.sink.Sinkpublic void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
lineBreak in interface org.apache.maven.doxia.sink.Sinkpublic void link(java.lang.String name)
link in interface org.apache.maven.doxia.sink.Sinkpublic void link(java.lang.String name,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
link in interface org.apache.maven.doxia.sink.Sinkpublic void link_()
link_ in interface org.apache.maven.doxia.sink.Sinkpublic void list()
list in interface org.apache.maven.doxia.sink.Sinkpublic void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
list in interface org.apache.maven.doxia.sink.Sinkpublic void listItem()
listItem in interface org.apache.maven.doxia.sink.Sinkpublic void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
listItem in interface org.apache.maven.doxia.sink.Sinkpublic void listItem_()
listItem_ in interface org.apache.maven.doxia.sink.Sinkpublic void list_()
list_ in interface org.apache.maven.doxia.sink.Sinkpublic void monospaced()
monospaced in interface org.apache.maven.doxia.sink.Sinkpublic void monospaced_()
monospaced_ in interface org.apache.maven.doxia.sink.Sinkpublic void nonBreakingSpace()
nonBreakingSpace in interface org.apache.maven.doxia.sink.Sinkpublic void numberedList(int numbering)
numberedList in interface org.apache.maven.doxia.sink.Sinkpublic void numberedList(int numbering,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
numberedList in interface org.apache.maven.doxia.sink.Sinkpublic void numberedListItem()
numberedListItem in interface org.apache.maven.doxia.sink.Sinkpublic void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
numberedListItem in interface org.apache.maven.doxia.sink.Sinkpublic void numberedListItem_()
numberedListItem_ in interface org.apache.maven.doxia.sink.Sinkpublic void numberedList_()
numberedList_ in interface org.apache.maven.doxia.sink.Sinkpublic void pageBreak()
pageBreak in interface org.apache.maven.doxia.sink.Sinkpublic void paragraph()
paragraph in interface org.apache.maven.doxia.sink.Sinkpublic void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
paragraph in interface org.apache.maven.doxia.sink.Sinkpublic void paragraph_()
paragraph_ in interface org.apache.maven.doxia.sink.Sinkpublic void rawText(java.lang.String text)
rawText in interface org.apache.maven.doxia.sink.Sinkpublic void section(int level,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
section in interface org.apache.maven.doxia.sink.Sinkpublic void section1()
section1 in interface org.apache.maven.doxia.sink.Sinkpublic void section1_()
section1_ in interface org.apache.maven.doxia.sink.Sinkpublic void section2()
section2 in interface org.apache.maven.doxia.sink.Sinkpublic void section2_()
section2_ in interface org.apache.maven.doxia.sink.Sinkpublic void section3()
section3 in interface org.apache.maven.doxia.sink.Sinkpublic void section3_()
section3_ in interface org.apache.maven.doxia.sink.Sinkpublic void section4()
section4 in interface org.apache.maven.doxia.sink.Sinkpublic void section4_()
section4_ in interface org.apache.maven.doxia.sink.Sinkpublic void section5()
section5 in interface org.apache.maven.doxia.sink.Sinkpublic void section5_()
section5_ in interface org.apache.maven.doxia.sink.Sinkpublic void section6()
section6 in interface org.apache.maven.doxia.sink.Sinkpublic void section6_()
section6_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle()
sectionTitle in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle(int level,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
sectionTitle in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle1()
sectionTitle1 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle1_()
sectionTitle1_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle2()
sectionTitle2 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle2_()
sectionTitle2_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle3()
sectionTitle3 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle3_()
sectionTitle3_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle4()
sectionTitle4 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle4_()
sectionTitle4_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle5()
sectionTitle5 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle5_()
sectionTitle5_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle6()
sectionTitle6 in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle6_()
sectionTitle6_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle_()
sectionTitle_ in interface org.apache.maven.doxia.sink.Sinkpublic void sectionTitle_(int level)
sectionTitle_ in interface org.apache.maven.doxia.sink.Sinkpublic void section_(int level)
section_ in interface org.apache.maven.doxia.sink.Sinkpublic void table()
table in interface org.apache.maven.doxia.sink.Sinkpublic void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
table in interface org.apache.maven.doxia.sink.Sinkpublic void tableCaption()
tableCaption in interface org.apache.maven.doxia.sink.Sinkpublic void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
tableCaption in interface org.apache.maven.doxia.sink.Sinkpublic void tableCaption_()
tableCaption_ in interface org.apache.maven.doxia.sink.Sinkpublic void tableCell()
tableCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableCell(java.lang.String width)
tableCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
tableCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableCell_()
tableCell_ in interface org.apache.maven.doxia.sink.Sinkpublic void tableHeaderCell()
tableHeaderCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableHeaderCell(java.lang.String width)
tableHeaderCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
tableHeaderCell in interface org.apache.maven.doxia.sink.Sinkpublic void tableHeaderCell_()
tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sinkpublic void tableRow()
tableRow in interface org.apache.maven.doxia.sink.Sinkpublic void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
tableRow in interface org.apache.maven.doxia.sink.Sinkpublic void tableRow_()
tableRow_ in interface org.apache.maven.doxia.sink.Sinkpublic void tableRows(int[] justification,
boolean grid)
tableRows in interface org.apache.maven.doxia.sink.Sinkpublic void tableRows_()
tableRows_ in interface org.apache.maven.doxia.sink.Sinkpublic void table_()
table_ in interface org.apache.maven.doxia.sink.Sinkpublic void text(java.lang.String text)
text in interface org.apache.maven.doxia.sink.Sinkpublic void text(java.lang.String text,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
text in interface org.apache.maven.doxia.sink.Sinkpublic void title()
title in interface org.apache.maven.doxia.sink.Sinkpublic void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
title in interface org.apache.maven.doxia.sink.Sinkpublic void title_()
title_ in interface org.apache.maven.doxia.sink.Sinkpublic void unknown(java.lang.String name,
java.lang.Object[] requiredParams,
org.apache.maven.doxia.sink.SinkEventAttributes attributes)
unknown in interface org.apache.maven.doxia.sink.Sinkpublic void verbatim(boolean boxed)
verbatim in interface org.apache.maven.doxia.sink.Sinkpublic void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
verbatim in interface org.apache.maven.doxia.sink.Sinkpublic void verbatim_()
verbatim_ in interface org.apache.maven.doxia.sink.Sinkpublic void enableLogging(org.apache.maven.doxia.logging.Log log)
enableLogging in interface org.apache.maven.doxia.logging.LogEnabled