Package org.apache.maven.doxia.sink.impl
Class SinkWrapper
java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractSink
org.apache.maven.doxia.sink.impl.SinkWrapper
- All Implemented Interfaces:
AutoCloseable
,Markup
,org.apache.maven.doxia.sink.Sink
- Direct Known Subclasses:
IndexingSink
,RandomAccessSink
,UniqueAnchorNamesValidator
By default a
SinkWrapper
just delegates each method to the wrapped sink's method.
For certain sink methods a derived wrapper may modify the sink before/after or instead of calling the delegate's method.
Sink wrappers can either be registered manually via Parser.addSinkWrapperFactory(SinkWrapperFactory)
or
are automatically registered if provided as JSR330 component.
In addition Sink wrappers can be used programmatically without an according factory.- Since:
- 2.0.0
-
Field Summary
Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
Fields inherited from interface org.apache.maven.doxia.sink.Sink
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
address
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
address_()
void
void
anchor_()
void
article
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
article_()
void
author
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
author_()
void
blockquote
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
body
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
body_()
void
bold()
void
bold_()
void
close()
void
void
content
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
content_()
void
void
data_()
void
date
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
date_()
void
definedTerm
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
definition
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
definitionList
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
definitionListItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
division
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
figure
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
figure_()
void
figureCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
figureGraphics
(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
flush()
void
footer
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
footer_()
org.apache.maven.doxia.sink.Locator
org.apache.maven.doxia.sink.Sink
void
head
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
head_()
void
header
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
header_()
void
horizontalRule
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
inline
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
inline_()
void
italic()
void
italic_()
void
lineBreak
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
lineBreakOpportunity
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
link_()
void
list
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
list_()
void
listItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
void
navigation
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
numberedList
(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
numberedListItem
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
paragraph
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
void
section
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
section_
(int level) void
sectionTitle
(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
sectionTitle_
(int level) void
setDocumentLocator
(org.apache.maven.doxia.sink.Locator locator) void
setWrappedSink
(org.apache.maven.doxia.sink.Sink sink) void
sidebar
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
sidebar_()
void
table
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
table_()
void
tableCaption
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableHeaderCell
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableRow
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
void
tableRows
(int[] justification, boolean grid) void
void
void
void
time_()
void
title
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
title_()
void
unknown
(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
verbatim
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
address, anchor, article, author, blockquote, body, content, data, date, definedTerm, definition, definitionList, definitionListItem, division, figure, figureCaption, figureGraphics, footer, formatLocation, getLocationLogPrefix, head, header, horizontalRule, init, inline, lineBreak, lineBreakOpportunity, link, list, listItem, navigation, numberedList, numberedListItem, paragraph, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle6, sectionTitle6_, sidebar, table, tableCaption, tableCell, tableHeaderCell, tableRow, tableRows, text, time, title, unifyEOLs, verbatim
-
Constructor Details
-
SinkWrapper
public SinkWrapper(org.apache.maven.doxia.sink.Sink delegate)
-
-
Method Details
-
getWrappedSink
public org.apache.maven.doxia.sink.Sink getWrappedSink() -
setWrappedSink
public void setWrappedSink(org.apache.maven.doxia.sink.Sink sink) -
head
public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
head_
public void head_() -
title
public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
title_
public void title_() -
author
public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
author_
public void author_() -
date
public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
date_
public void date_() -
body
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
body_
public void body_() -
article
public void article(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
article_
public void article_() -
sidebar
public void sidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
sidebar_
public void sidebar_() -
section
public void section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
section_
public void section_(int level) -
sectionTitle
public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
sectionTitle_
public void sectionTitle_(int level) -
header
public void header(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
header_
public void header_() -
content
public void content(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
content_
public void content_() -
list
public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
list_
public void list_() -
listItem
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
listItem_
public void listItem_() -
numberedList
public void numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
numberedList_
public void numberedList_() -
numberedListItem
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
numberedListItem_
public void numberedListItem_() -
definitionList
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
definitionList_
public void definitionList_() -
definitionListItem
public void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
definitionListItem_
public void definitionListItem_() -
definition
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
definition_
public void definition_() -
definedTerm
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
definedTerm_
public void definedTerm_() -
figure
public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
figure_
public void figure_() -
figureCaption
public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
figureCaption_
public void figureCaption_() -
figureGraphics
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
table_
public void table_() -
tableRows
public void tableRows(int[] justification, boolean grid) -
tableRows_
public void tableRows_() -
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
tableRow_
public void tableRow_() -
tableCell
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
tableCell_
public void tableCell_() -
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
tableHeaderCell_
public void tableHeaderCell_() -
tableCaption
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
tableCaption_
public void tableCaption_() -
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
paragraph_
public void paragraph_() -
data
-
data_
public void data_() -
time
-
time_
public void time_() -
address
public void address(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
address_
public void address_() -
blockquote
public void blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
blockquote_
public void blockquote_() -
division
public void division(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
division_
public void division_() -
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
verbatim_
public void verbatim_() -
horizontalRule
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
pageBreak
public void pageBreak() -
anchor
-
anchor_
public void anchor_() -
link
-
link_
public void link_() -
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
inline_
public void inline_() -
italic
public void italic() -
italic_
public void italic_() -
bold
public void bold() -
bold_
public void bold_() -
monospaced
public void monospaced() -
monospaced_
public void monospaced_() -
lineBreak
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
lineBreakOpportunity
public void lineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes) -
nonBreakingSpace
public void nonBreakingSpace() -
text
-
rawText
-
comment
-
unknown
-
flush
public void flush() -
close
public void close() -
setDocumentLocator
public void setDocumentLocator(org.apache.maven.doxia.sink.Locator locator) - Specified by:
setDocumentLocator
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
setDocumentLocator
in classAbstractSink
-
getDocumentLocator
public org.apache.maven.doxia.sink.Locator getDocumentLocator()- Specified by:
getDocumentLocator
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
getDocumentLocator
in classAbstractSink
-