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

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
  • 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)
    • 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_()
    • footer

      public void footer(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • 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

      public void figureGraphics(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • 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

      public void data(String value, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • data_

      public void data_()
    • time

      public void time(String datetime, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • 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

      public void anchor(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • anchor_

      public void anchor_()
    • link

      public void link(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • 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

      public void text(String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • rawText

      public void rawText(String text)
    • comment

      public void comment(String comment)
    • unknown

      public void unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
    • flush

      public void flush()
    • close

      public void close()
    • setDocumentLocator

      public void setDocumentLocator(org.apache.maven.doxia.sink.Locator locator)
      Specified by:
      setDocumentLocator in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      setDocumentLocator in class AbstractSink
    • getDocumentLocator

      public org.apache.maven.doxia.sink.Locator getDocumentLocator()
      Specified by:
      getDocumentLocator in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      getDocumentLocator in class AbstractSink