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:

java.lang.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

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(org.apache.maven.doxia.sink.Sink delegate)

Method Summary

Modifier and Type	Method	Description
void	address(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	address_()
void	anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
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	blockquote_()
void	body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	body_()
void	bold()
void	bold_()
void	close()
void	comment(java.lang.String comment)
void	content(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	content_()
void	data(java.lang.String value, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	data_()
void	date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	date_()
void	definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	definedTerm_()
void	definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	definition_()
void	definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	definitionList_()
void	definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	definitionListItem_()
void	division(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	division_()
void	figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	figure_()
void	figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	figureCaption_()
void	figureGraphics(java.lang.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	getDocumentLocator()
org.apache.maven.doxia.sink.Sink	getWrappedSink()
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	link(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	link_()
void	list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	list_()
void	listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	listItem_()
void	markupLineBreak(int indentLevel)
void	monospaced()
void	monospaced_()
void	navigation(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	navigation_()
void	nonBreakingSpace()
void	numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	numberedList_()
void	numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	numberedListItem_()
void	pageBreak()
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	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	tableCaption_()
void	tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	tableCell_()
void	tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	tableHeaderCell_()
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, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	time(java.lang.String datetime, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	time_()
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(org.apache.maven.doxia.sink.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 Detail

SinkWrapper

public SinkWrapper(org.apache.maven.doxia.sink.Sink delegate)

Method Detail

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

navigation

public void navigation(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

navigation_

public void navigation_()

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

footer

public void footer(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

footer_

public void footer_()

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(java.lang.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(java.lang.String value,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)

data_

public void data_()

time

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

anchor_

public void anchor_()

link

public void link(java.lang.String name,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)

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

public void text(java.lang.String text,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)

rawText

public void rawText(java.lang.String text)

comment

public void comment(java.lang.String comment)

markupLineBreak

public void markupLineBreak(int indentLevel)

unknown

public void unknown(java.lang.String name,
                    java.lang.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