org.apache.maven.doxia.sink.impl.AbstractSink

org.apache.maven.doxia.sink.impl.SinkWrapper

All Implemented Interfaces:: AutoCloseable, Markup, Sink

Direct Known Subclasses:: IndexingSink, RandomAccessSink, UniqueAnchorNamesValidator

public class SinkWrapper extends AbstractSink

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_DEFAULT, 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

Constructor

Description

SinkWrapper(Sink delegate)
Method Summary

Modifier and Type

Method

Description

void

address(SinkEventAttributes attributes)

void

address_()

void

anchor(String name, SinkEventAttributes attributes)

void

anchor_()

void

article(SinkEventAttributes attributes)

void

article_()

void

author(SinkEventAttributes attributes)

void

author_()

void

blockquote(SinkEventAttributes attributes)

void

blockquote_()

void

body(SinkEventAttributes attributes)

void

body_()

void

bold()

void

bold_()

void

close()

void

comment(String comment)

void

content(SinkEventAttributes attributes)

void

content_()

void

data(String value, SinkEventAttributes attributes)

void

data_()

void

date(SinkEventAttributes attributes)

void

date_()

void

definedTerm(SinkEventAttributes attributes)

void

definedTerm_()

void

definition(SinkEventAttributes attributes)

void

definition_()

void

definitionList(SinkEventAttributes attributes)

void

definitionList_()

void

definitionListItem(SinkEventAttributes attributes)

void

definitionListItem_()

void

division(SinkEventAttributes attributes)

void

division_()

void

figure(SinkEventAttributes attributes)

void

figure_()

void

figureCaption(SinkEventAttributes attributes)

void

figureCaption_()

void

figureGraphics(String src, SinkEventAttributes attributes)

void

flush()

void

footer(SinkEventAttributes attributes)

void

footer_()

Locator

getDocumentLocator()

Sink

getWrappedSink()

void

head(SinkEventAttributes attributes)

void

head_()

void

header(SinkEventAttributes attributes)

void

header_()

void

horizontalRule(SinkEventAttributes attributes)

void

inline(SinkEventAttributes attributes)

void

inline_()

void

italic()

void

italic_()

void

lineBreak(SinkEventAttributes attributes)

void

lineBreakOpportunity(SinkEventAttributes attributes)

void

link(String name, SinkEventAttributes attributes)

void

link_()

void

list(SinkEventAttributes attributes)

void

list_()

void

listItem(SinkEventAttributes attributes)

void

listItem_()

void

markupLineBreak(int indentLevel)

void

monospaced()

void

monospaced_()

void

navigation(SinkEventAttributes attributes)

void

navigation_()

void

nonBreakingSpace()

void

numberedList(int numbering, SinkEventAttributes attributes)

void

numberedList_()

void

numberedListItem(SinkEventAttributes attributes)

void

numberedListItem_()

void

pageBreak()

void

paragraph(SinkEventAttributes attributes)

void

paragraph_()

void

rawText(String text)

void

section(int level, SinkEventAttributes attributes)

void

section_(int level)

void

sectionTitle(int level, SinkEventAttributes attributes)

void

sectionTitle_(int level)

void

setDocumentLocator(Locator locator)

void

setWrappedSink(Sink sink)

void

sidebar(SinkEventAttributes attributes)

void

sidebar_()

void

table(SinkEventAttributes attributes)

void

table_()

void

tableCaption(SinkEventAttributes attributes)

void

tableCaption_()

void

tableCell(SinkEventAttributes attributes)

void

tableCell_()

void

tableHeaderCell(SinkEventAttributes attributes)

void

tableHeaderCell_()

void

tableRow(SinkEventAttributes attributes)

void

tableRow_()

void

tableRows(int[] justification, boolean grid)

void

tableRows_()

void

text(String text, SinkEventAttributes attributes)

void

time(String datetime, SinkEventAttributes attributes)

void

time_()

void

title(SinkEventAttributes attributes)

void

title_()

void

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

void

verbatim(SinkEventAttributes attributes)

void

verbatim_()

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SinkWrapper
  
  public SinkWrapper(Sink delegate)
Method Details
- getWrappedSink
  
  public Sink getWrappedSink()
- setWrappedSink
  
  public void setWrappedSink(Sink sink)
- head
  
  public void head(SinkEventAttributes attributes)
- head_
  
  public void head_()
- title
  
  public void title(SinkEventAttributes attributes)
- title_
  
  public void title_()
- author
  
  public void author(SinkEventAttributes attributes)
- author_
  
  public void author_()
- date
  
  public void date(SinkEventAttributes attributes)
- date_
  
  public void date_()
- body
  
  public void body(SinkEventAttributes attributes)
- body_
  
  public void body_()
- article
  
  public void article(SinkEventAttributes attributes)
- article_
  
  public void article_()
- navigation
  
  public void navigation(SinkEventAttributes attributes)
- navigation_
  
  public void navigation_()
- sidebar
  
  public void sidebar(SinkEventAttributes attributes)
- sidebar_
  
  public void sidebar_()
- section
  
  public void section(int level, SinkEventAttributes attributes)
- section_
  
  public void section_(int level)
- sectionTitle
  
  public void sectionTitle(int level, SinkEventAttributes attributes)
- sectionTitle_
  
  public void sectionTitle_(int level)
- header
  
  public void header(SinkEventAttributes attributes)
- header_
  
  public void header_()
- content
  
  public void content(SinkEventAttributes attributes)
- content_
  
  public void content_()
- footer
  
  public void footer(SinkEventAttributes attributes)
- footer_
  
  public void footer_()
- list
  
  public void list(SinkEventAttributes attributes)
- list_
  
  public void list_()
- listItem
  
  public void listItem(SinkEventAttributes attributes)
- listItem_
  
  public void listItem_()
- numberedList
  
  public void numberedList(int numbering, SinkEventAttributes attributes)
- numberedList_
  
  public void numberedList_()
- numberedListItem
  
  public void numberedListItem(SinkEventAttributes attributes)
- numberedListItem_
  
  public void numberedListItem_()
- definitionList
  
  public void definitionList(SinkEventAttributes attributes)
- definitionList_
  
  public void definitionList_()
- definitionListItem
  
  public void definitionListItem(SinkEventAttributes attributes)
- definitionListItem_
  
  public void definitionListItem_()
- definition
  
  public void definition(SinkEventAttributes attributes)
- definition_
  
  public void definition_()
- definedTerm
  
  public void definedTerm(SinkEventAttributes attributes)
- definedTerm_
  
  public void definedTerm_()
- figure
  
  public void figure(SinkEventAttributes attributes)
- figure_
  
  public void figure_()
- figureCaption
  
  public void figureCaption(SinkEventAttributes attributes)
- figureCaption_
  
  public void figureCaption_()
- figureGraphics
  
  public void figureGraphics(String src, SinkEventAttributes attributes)
- table
  
  public void table(SinkEventAttributes attributes)
- table_
  
  public void table_()
- tableRows
  
  public void tableRows(int[] justification, boolean grid)
- tableRows_
  
  public void tableRows_()
- tableRow
  
  public void tableRow(SinkEventAttributes attributes)
- tableRow_
  
  public void tableRow_()
- tableCell
  
  public void tableCell(SinkEventAttributes attributes)
- tableCell_
  
  public void tableCell_()
- tableHeaderCell
  
  public void tableHeaderCell(SinkEventAttributes attributes)
- tableHeaderCell_
  
  public void tableHeaderCell_()
- tableCaption
  
  public void tableCaption(SinkEventAttributes attributes)
- tableCaption_
  
  public void tableCaption_()
- paragraph
  
  public void paragraph(SinkEventAttributes attributes)
- paragraph_
  
  public void paragraph_()
- data
  
  public void data(String value, SinkEventAttributes attributes)
- data_
  
  public void data_()
- time
  
  public void time(String datetime, SinkEventAttributes attributes)
- time_
  
  public void time_()
- address
  
  public void address(SinkEventAttributes attributes)
- address_
  
  public void address_()
- blockquote
  
  public void blockquote(SinkEventAttributes attributes)
- blockquote_
  
  public void blockquote_()
- division
  
  public void division(SinkEventAttributes attributes)
- division_
  
  public void division_()
- verbatim
  
  public void verbatim(SinkEventAttributes attributes)
- verbatim_
  
  public void verbatim_()
- horizontalRule
  
  public void horizontalRule(SinkEventAttributes attributes)
- pageBreak
  
  public void pageBreak()
- anchor
  
  public void anchor(String name, SinkEventAttributes attributes)
- anchor_
  
  public void anchor_()
- link
  
  public void link(String name, SinkEventAttributes attributes)
- link_
  
  public void link_()
- inline
  
  public void inline(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(SinkEventAttributes attributes)
- lineBreakOpportunity
  
  public void lineBreakOpportunity(SinkEventAttributes attributes)
- nonBreakingSpace
  
  public void nonBreakingSpace()
- text
  
  public void text(String text, SinkEventAttributes attributes)
- rawText
  
  public void rawText(String text)
- comment
  
  public void comment(String comment)
- markupLineBreak
  
  public void markupLineBreak(int indentLevel)
- unknown
  
  public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
- flush
  
  public void flush()
- close
  
  public void close()
- setDocumentLocator
  
  public void setDocumentLocator(Locator locator)
  
  Specified by:
  
  setDocumentLocator in interface Sink
  
  Overrides:
  
  setDocumentLocator in class AbstractSink
- getDocumentLocator
  
  public Locator getDocumentLocator()
  
  Specified by:
  
  getDocumentLocator in interface Sink
  
  Overrides:
  
  getDocumentLocator in class AbstractSink

Class SinkWrapper

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.Markup

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

Methods inherited from class java.lang.Object

Constructor Details

SinkWrapper

Method Details

getWrappedSink

setWrappedSink

head

head_

title

title_

author

author_

date

date_

body

body_

article

article_

navigation

navigation_

sidebar

sidebar_

section

section_

sectionTitle

sectionTitle_

header

header_

content

content_

footer

footer_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definitionListItem

definitionListItem_

definition

definition_

definedTerm

definedTerm_

figure

figure_

figureCaption

figureCaption_

figureGraphics

table

table_

tableRows

tableRows_

tableRow

tableRow_

tableCell

tableCell_

tableHeaderCell

tableHeaderCell_

tableCaption

tableCaption_

paragraph

paragraph_

data

data_

time

time_

address

address_