Package org.apache.maven.doxia.sink.impl

Class AbstractSink

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable, Markup, Sink

Direct Known Subclasses:

SinkAdapter, SinkWrapper

public abstract class AbstractSink
extends Object
implements Sink, Markup

An abstract base class that defines some convenience methods for sinks. Also acts as compatibility bridge for Doxia 1.0 methods which have overloaded variants in Doxia > 1.0 (taking an additional argument SinkEventAttributes). This implementation just delegates the former to the latter with argument SinkEventAttributes being null.

Since:

1.1

Author:

ltheussl, Vincent Siveton

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

Method Summary

Modifier and Type	Method	Description
final void	address()	Starts an address element.
final void	anchor(String name)	Starts an element which defines an anchor.
final void	article()	Starts an article within a document.
final void	author()	Starts an author element.
final void	blockquote()	Starts a blockquote element.
final void	body()	Starts the body of a document.
final void	content()	Start the main content section between the header and the footer within the sections and/or body.
final void	data(String value)	Starts a data element which groups together other elements representing microformats.
final void	date()	Starts the date element.
final void	definedTerm()	Starts a definition term element within a definition list.
final void	definition()	Starts a definition element within a definition list.
final void	definitionList()	Starts a definition list element.
final void	definitionListItem()	Starts a list item element within a definition list.
final void	division()	Starts a division element grouping together other elements.
final void	figure()	Starts a basic image embedding element.
final void	figureCaption()	Starts a caption of an image element.
final void	figureGraphics(String name)	Adds a graphic element.
final void	footer()	Start a new footer within the section or body.
static String	formatLocation(Locator locator)	Creates a string with line/column information.
Locator	getDocumentLocator()	Returns the locator which exposes location information for a particular Sink event.
protected String	getLocationLogPrefix()
final void	head()	Starts the head element.
final void	header()	Start a new header within the section or body.
final void	horizontalRule()	Adds a separator of sections from a text to each other.
protected void	init()	This is called in head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
final void	inline()	Starts an inline element.
final void	lineBreak()	Adds a line break.
final void	lineBreakOpportunity()	Adds a line break opportunity.
final void	link(String name)	Starts an element which defines a link.
final void	list()	Starts an unordered list element.
final void	listItem()	Starts a list item element within an unordered list.
final void	navigation()	Starts a navigation section within a document.
final void	numberedList(int numbering)	Starts an ordered list element.
final void	numberedListItem()	Starts a list item element within an ordered list.
final void	paragraph()	Starts an element which represents a paragraph.
final void	section1()	Starts a first heading element which contains the topic of the section.
final void	section1_()	Ends a first heading element.
final void	section2()	Starts a second heading element which contains the topic of the section.
final void	section2_()	Ends a second heading element.
final void	section3()	Starts a third heading element which contains the topic of the section.
final void	section3_()	Ends a third heading element.
final void	section4()	Starts a 4th heading element which contains the topic of the section.
final void	section4_()	Ends a 4th heading element.
final void	section5()	Starts a 5th heading element which contains the topic of the section.
final void	section5_()	Ends a 5th heading element.
final void	section6()	Starts a 6th heading element which contains the topic of the section.
final void	section6_()	Ends a 6th heading element.
final void	sectionTitle()	Was never properly evaluated by any Sink implementation because section titles (and sections) always started from 1 (not from 0).
final void	sectionTitle_()	Was never properly evaluated by any Sink implementation because section titles (and sections) always started from 1 (not from 0).
final void	sectionTitle1()	Starts a first title heading element.
final void	sectionTitle1_()	Ends a first title heading element.
final void	sectionTitle2()	Starts a second title heading element.
final void	sectionTitle2_()	Ends a second title heading element.
final void	sectionTitle3()	Starts a third title heading element.
final void	sectionTitle3_()	Ends a third title heading element.
final void	sectionTitle4()	Starts a 4th title heading element.
final void	sectionTitle4_()	Ends a 4th title heading element.
final void	sectionTitle5()	Starts a 5th title heading element.
final void	sectionTitle5_()	Ends a 5th title heading element.
final void	sectionTitle6()	Starts a 6th title heading element.
final void	sectionTitle6_()	Ends a 6th title heading element.
void	setDocumentLocator(Locator locator)	Sets the locator which exposes location information for a particular Sink event.
final void	sidebar()	Starts a sidebar section within a document.
final void	table()	Starts a table element for marking up tabular information in a document.
final void	tableCaption()	Starts a caption element of a table.
final void	tableCell()	Starts a cell element which defines a cell that contains data.
final void	tableHeaderCell()	Starts a cell element which defines a cell that contains header information.
final void	tableRow()	Starts a row element which acts as a container for a row of table cells.
final void	tableRows()	Starts an element that contains rows of table data.
final void	text(String text)	Adds a text.
final void	time(String datetime)	Starts a time element which groups together other elements representing a time.
final void	title()	Starts the title element.
protected static String	unifyEOLs(String text)	Parses the given String and replaces all occurrences of '\n', '\r' and '\r\n' with the system EOL.
final void	verbatim()	Starts a verbatim block, ie a block where whitespace has semantic relevance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

address, address_, anchor, anchor_, article, article_, author, author_, blockquote, blockquote_, body, body_, bold, bold_, close, comment, content, content_, data, data_, date, date_, definedTerm, definedTerm_, definition, definition_, definitionList, definitionList_, definitionListItem, definitionListItem_, division, division_, figure, figure_, figureCaption, figureCaption_, figureGraphics, flush, footer, footer_, head, head_, header, header_, horizontalRule, inline, inline_, italic, italic_, lineBreak, lineBreakOpportunity, link, link_, list, list_, listItem, listItem_, markupLineBreak, monospaced, monospaced_, navigation, navigation_, nonBreakingSpace, numberedList, numberedList_, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph_, rawText, section, section_, sectionTitle, sectionTitle_, sidebar, sidebar_, table, table_, tableCaption, tableCaption_, tableCell, tableCell_, tableHeaderCell, tableHeaderCell_, tableRow, tableRow_, tableRows, tableRows_, text, time, time_, title, title_, unknown, verbatim, verbatim_

Constructor Details

AbstractSink

public AbstractSink()

Method Details

head

public final void head()

Description copied from interface: Sink

Starts the head element. Shortcut for Sink.head(SinkEventAttributes) with first argument being null.

Specified by:

head in interface Sink

See Also:

• Sink.head(SinkEventAttributes)

title

public final void title()

Description copied from interface: Sink

Starts the title element. Shortcut for Sink.title(SinkEventAttributes) with first argument being null.

Specified by:

title in interface Sink

See Also:

• Sink.title(SinkEventAttributes)

author

public final void author()

Description copied from interface: Sink

Starts an author element. Shortcut for Sink.author(SinkEventAttributes) with first argument being null.

Specified by:

author in interface Sink

See Also:

• Sink.author(SinkEventAttributes)

date

public final void date()

Description copied from interface: Sink

Starts the date element. Shortcut for Sink.date(SinkEventAttributes) with first argument being null.

Specified by:

date in interface Sink

See Also:

• Sink.date(SinkEventAttributes)

body

public final void body()

Description copied from interface: Sink

Starts the body of a document. Shortcut for Sink.body(SinkEventAttributes) with first argument being null.

Specified by:

body in interface Sink

See Also:

• Sink.body(SinkEventAttributes)

article

public final void article()

Description copied from interface: Sink

Starts an article within a document. Shortcut for Sink.article(SinkEventAttributes) with first argument being null.

Specified by:

article in interface Sink

See Also:

• Sink.article(SinkEventAttributes)

navigation

public final void navigation()

Description copied from interface: Sink

Starts a navigation section within a document. Shortcut for Sink.navigation(SinkEventAttributes) with first argument being null.

Specified by:

navigation in interface Sink

See Also:

• Sink.navigation(SinkEventAttributes)

sidebar

public final void sidebar()

Description copied from interface: Sink

Starts a sidebar section within a document. Shortcut for Sink.sidebar(SinkEventAttributes) with first argument being null.

Specified by:

sidebar in interface Sink

See Also:

• Sink.sidebar(SinkEventAttributes)

sectionTitle

public final void sectionTitle()

Description copied from interface: Sink

Was never properly evaluated by any Sink implementation because section titles (and sections) always started from 1 (not from 0).

Specified by:

sectionTitle in interface Sink

section1

public final void section1()

Description copied from interface: Sink

Starts a first heading element which contains the topic of the section. Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 1 and second argument being null.

Specified by:

section1 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

sectionTitle_

public final void sectionTitle_()

Description copied from interface: Sink

Was never properly evaluated by any Sink implementation because section titles (and sections) always started from 1 (not from 0).

Specified by:

sectionTitle_ in interface Sink

section1_

public final void section1_()

Description copied from interface: Sink

Ends a first heading element. Shortcut for Sink.section_(int) with argument being 1.

Specified by:

section1_ in interface Sink

sectionTitle1

public final void sectionTitle1()

Description copied from interface: Sink

Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 1 and second argument being null.

Specified by:

sectionTitle1 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle1_

public final void sectionTitle1_()

Description copied from interface: Sink

Ends a first title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 1.

Specified by:

sectionTitle1_ in interface Sink

section2

public final void section2()

Description copied from interface: Sink

Starts a second heading element which contains the topic of the section. This has to be contained within a Sink.section1() element.

Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 2 and second argument being null.

Specified by:

section2 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

section2_

public final void section2_()

Description copied from interface: Sink

Ends a second heading element. Shortcut for Sink.section_(int) with argument being 2.

Specified by:

section2_ in interface Sink

sectionTitle2

public final void sectionTitle2()

Description copied from interface: Sink

Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 2 and second argument being null.

Specified by:

sectionTitle2 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle2_

public final void sectionTitle2_()

Description copied from interface: Sink

Ends a second title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 2.

Specified by:

sectionTitle2_ in interface Sink

section3

public final void section3()

Description copied from interface: Sink

Starts a third heading element which contains the topic of the section. This has to be contained within a Sink.section2() element.

Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 3 and second argument being null.

Specified by:

section3 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

section3_

public final void section3_()

Description copied from interface: Sink

Ends a third heading element. Shortcut for Sink.section_(int) with argument being 3.

Specified by:

section3_ in interface Sink

sectionTitle3

public final void sectionTitle3()

Description copied from interface: Sink

Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 3 and second argument being null.

Specified by:

sectionTitle3 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle3_

public final void sectionTitle3_()

Description copied from interface: Sink

Ends a third title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 3.

Specified by:

sectionTitle3_ in interface Sink

section4

public final void section4()

Description copied from interface: Sink

Starts a 4th heading element which contains the topic of the section. This has to be contained within a Sink.section3() element.

Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 4 and second argument being null.

Specified by:

section4 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

section4_

public final void section4_()

Description copied from interface: Sink

Ends a 4th heading element. Shortcut for Sink.section_(int) with argument being 4.

Specified by:

section4_ in interface Sink

sectionTitle4

public final void sectionTitle4()

Description copied from interface: Sink

Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 4 and second argument being null.

Specified by:

sectionTitle4 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle4_

public final void sectionTitle4_()

Description copied from interface: Sink

Ends a 4th title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 4.

Specified by:

sectionTitle4_ in interface Sink

section5

public final void section5()

Description copied from interface: Sink

Starts a 5th heading element which contains the topic of the section. This has to be contained within a Sink.section5() element.

Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 5 and second argument being null.

Specified by:

section5 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

section5_

public final void section5_()

Description copied from interface: Sink

Ends a 5th heading element. Shortcut for Sink.section_(int) with argument being 5.

Specified by:

section5_ in interface Sink

sectionTitle5

public final void sectionTitle5()

Description copied from interface: Sink

Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 5 and second argument being null.

Specified by:

sectionTitle5 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle5_

public final void sectionTitle5_()

Description copied from interface: Sink

Ends a 5th title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 5.

Specified by:

sectionTitle5_ in interface Sink

section6

public final void section6()

Description copied from interface: Sink

Starts a 6th heading element which contains the topic of the section. This has to be contained within a Sink.section6() element.

Shortcut for Sink.section(int, SinkEventAttributes) with first argument being 6 and second argument being null.

Specified by:

section6 in interface Sink

See Also:

• Sink.section(int,SinkEventAttributes)

section6_

public final void section6_()

Description copied from interface: Sink

Ends a 6th heading element. Shortcut for Sink.section_(int) with argument being 6.

Specified by:

section6_ in interface Sink

sectionTitle6

public final void sectionTitle6()

Description copied from interface: Sink

Starts a 6th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element.

Shortcut for Sink.sectionTitle(int, SinkEventAttributes) with first argument being 6 and second argument being null.

Specified by:

sectionTitle6 in interface Sink

See Also:

• Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle6_

public final void sectionTitle6_()

Description copied from interface: Sink

Ends a 6th title heading element. Shortcut for Sink.sectionTitle_(int) with argument being 6.

Specified by:

sectionTitle6_ in interface Sink

header

public final void header()

Description copied from interface: Sink

Start a new header within the section or body. Shortcut for Sink.header(SinkEventAttributes) with argument being null.

Specified by:

header in interface Sink

content

public final void content()

Description copied from interface: Sink

Start the main content section between the header and the footer within the sections and/or body. Shortcut for Sink.content(SinkEventAttributes) with argument being null.

Specified by:

content in interface Sink

footer

public final void footer()

Description copied from interface: Sink

Start a new footer within the section or body. Shortcut for Sink.footer(SinkEventAttributes) with argument being null.

Specified by:

footer in interface Sink

list

public final void list()

Description copied from interface: Sink

Starts an unordered list element. Shortcut for Sink.list(SinkEventAttributes) with argument being null.

Specified by:

list in interface Sink

See Also:

• Sink.list(SinkEventAttributes)

listItem

public final void listItem()

Description copied from interface: Sink

Starts a list item element within an unordered list. Shortcut for Sink.listItem(SinkEventAttributes) with argument being null.

Specified by:

listItem in interface Sink

See Also:

• Sink.listItem(SinkEventAttributes)

numberedList

public final void numberedList(int numbering)

Description copied from interface: Sink

Starts an ordered list element. Shortcut for Sink.numberedList(int, SinkEventAttributes) with first argument being numbering and second argument being null.

Specified by:

numberedList in interface Sink

Parameters:

numbering - the numbering style.

See Also:

• Sink.numberedList(int,SinkEventAttributes)

numberedListItem

public final void numberedListItem()

Description copied from interface: Sink

Starts a list item element within an ordered list. Shortcut for Sink.numberedListItem(SinkEventAttributes) with argument being null.

Specified by:

numberedListItem in interface Sink

See Also:

• Sink.numberedListItem(SinkEventAttributes)

definitionList

public final void definitionList()

Description copied from interface: Sink

Starts a definition list element. Shortcut for Sink.definitionList(SinkEventAttributes) with argument being null.

Specified by:

definitionList in interface Sink

See Also:

• Sink.definitionList(SinkEventAttributes)

definitionListItem

public final void definitionListItem()

Description copied from interface: Sink

Starts a list item element within a definition list. Shortcut for Sink.definitionListItem(SinkEventAttributes) with argument being null.

Specified by:

definitionListItem in interface Sink

See Also:

• Sink.definitionListItem(SinkEventAttributes)

definition

public final void definition()

Description copied from interface: Sink

Starts a definition element within a definition list. Shortcut for Sink.definition(SinkEventAttributes) with argument being null.

Specified by:

definition in interface Sink

See Also:

• Sink.definition(SinkEventAttributes)

definedTerm

public final void definedTerm()

Description copied from interface: Sink

Starts a definition term element within a definition list. Shortcut for Sink.definedTerm(SinkEventAttributes) with argument being null.

Specified by:

definedTerm in interface Sink

See Also:

• Sink.definedTerm(SinkEventAttributes)

figure

public final void figure()

Description copied from interface: Sink

Starts a basic image embedding element. Shortcut for Sink.figure(SinkEventAttributes) with argument being null.

Specified by:

figure in interface Sink

See Also:

• Sink.figure(SinkEventAttributes)

figureCaption

public final void figureCaption()

Description copied from interface: Sink

Starts a caption of an image element. Shortcut for Sink.figureCaption(SinkEventAttributes) with argument being null.

Specified by:

figureCaption in interface Sink

See Also:

• Sink.figureCaption(SinkEventAttributes)

figureGraphics

public final void figureGraphics(String name)

Description copied from interface: Sink

Adds a graphic element. Shortcut for Sink.figureGraphics(String, SinkEventAttributes) with first argument being src and second argument being null.

Specified by:

figureGraphics in interface Sink

Parameters:

name - the source

table

public final void table()

Description copied from interface: Sink

Starts a table element for marking up tabular information in a document. Shortcut for Sink.table(SinkEventAttributes) with argument being null.

Specified by:

table in interface Sink

See Also:

• Sink.table(SinkEventAttributes)

tableRows

public final void tableRows()

Description copied from interface: Sink

Starts an element that contains rows of table data. Shortcut for Sink.tableRows(int[], boolean) with first argument being null and second being false.

Specified by:

tableRows in interface Sink

See Also:

• Sink.tableRows(int[], boolean)

tableRow

public final void tableRow()

Description copied from interface: Sink

Starts a row element which acts as a container for a row of table cells. Shortcut for Sink.tableRow(SinkEventAttributes) with argument being null.

Specified by:

tableRow in interface Sink

See Also:

• Sink.tableRow(SinkEventAttributes)

tableCell

public final void tableCell()

Description copied from interface: Sink

Starts a cell element which defines a cell that contains data. Shortcut for Sink.tableCell(SinkEventAttributes) with argument being null.

Specified by:

tableCell in interface Sink

See Also:

• Sink.tableCell(SinkEventAttributes)

tableHeaderCell

public final void tableHeaderCell()

Description copied from interface: Sink

Starts a cell element which defines a cell that contains header information. Shortcut for Sink.tableHeaderCell(SinkEventAttributes) with argument being null.

Specified by:

tableHeaderCell in interface Sink

See Also:

• Sink.tableHeaderCell(SinkEventAttributes)

tableCaption

public final void tableCaption()

Description copied from interface: Sink

Starts a caption element of a table. Shortcut for Sink.tableCaption(SinkEventAttributes) with argument being null.

Specified by:

tableCaption in interface Sink

See Also:

• Sink.tableCaption(SinkEventAttributes)

paragraph

public final void paragraph()

Description copied from interface: Sink

Starts an element which represents a paragraph. Shortcut for Sink.paragraph(SinkEventAttributes) with argument being null.

Specified by:

paragraph in interface Sink

See Also:

• Sink.paragraph(SinkEventAttributes)

data

public final void data(String value)

Description copied from interface: Sink

Starts a data element which groups together other elements representing microformats. Shortcut for Sink.data(String, SinkEventAttributes) with first argument being {code value} and second argument being null.

Specified by:

data in interface Sink

Parameters:

value - a String object.

See Also:

• Sink.data(String, SinkEventAttributes)

time

public final void time(String datetime)

Description copied from interface: Sink

Starts a time element which groups together other elements representing a time. Shortcut for Sink.time(String, SinkEventAttributes) with first argument being {code datetime} and second argument being null.

Specified by:

time in interface Sink

See Also:

• Sink.time(String, SinkEventAttributes)

address

public final void address()

Description copied from interface: Sink

Starts an address element. Shortcut for Sink.address(SinkEventAttributes) with argument being null.

Specified by:

address in interface Sink

See Also:

• Sink.address(SinkEventAttributes)

blockquote

public final void blockquote()

Description copied from interface: Sink

Starts a blockquote element. Shortcut for Sink.blockquote(SinkEventAttributes) with argument being null.

Specified by:

blockquote in interface Sink

See Also:

• Sink.blockquote(SinkEventAttributes)

division

public final void division()

Description copied from interface: Sink

Starts a division element grouping together other elements. Shortcut for Sink.division(SinkEventAttributes) with argument being null.

Specified by:

division in interface Sink

See Also:

• Sink.division(SinkEventAttributes)

verbatim

public final void verbatim()

Description copied from interface: Sink

Starts a verbatim block, ie a block where whitespace has semantic relevance. Shortcut for Sink.verbatim(SinkEventAttributes) with argument being null.

Specified by:

verbatim in interface Sink

See Also:

• Sink.verbatim(SinkEventAttributes)

horizontalRule

public final void horizontalRule()

Description copied from interface: Sink

Adds a separator of sections from a text to each other. Shortcut for Sink.horizontalRule(SinkEventAttributes) with argument being null.

Specified by:

horizontalRule in interface Sink

See Also:

• Sink.horizontalRule(SinkEventAttributes)

anchor

public final void anchor(String name)

Description copied from interface: Sink

Starts an element which defines an anchor. Shortcut for Sink.anchor(String, SinkEventAttributes) with first argument being name and second argument being null.

Specified by:

anchor in interface Sink

Parameters:

name - the name of the anchor.

See Also:

• Sink.anchor(String,SinkEventAttributes)

link

public final void link(String name)

Description copied from interface: Sink

Starts an element which defines a link. Shortcut for Sink.link(String, SinkEventAttributes) with first argument being name and second argument being null.

Specified by:

link in interface Sink

Parameters:

name - the name of the link.

See Also:

• Sink.link(String,SinkEventAttributes)

inline

public final void inline()

Description copied from interface: Sink

Starts an inline element. Shortcut for Sink.inline(SinkEventAttributes) with argument being null.

Specified by:

inline in interface Sink

See Also:

• Sink.inline(SinkEventAttributes)

lineBreak

public final void lineBreak()

Description copied from interface: Sink

Adds a line break. Shortcut for Sink.lineBreak(SinkEventAttributes) with argument being null.

Specified by:

lineBreak in interface Sink

See Also:

• Sink.lineBreak(SinkEventAttributes)

lineBreakOpportunity

public final void lineBreakOpportunity()

Description copied from interface: Sink

Adds a line break opportunity. Shortcut for Sink.lineBreakOpportunity(SinkEventAttributes) with argument being null.

Specified by:

lineBreakOpportunity in interface Sink

See Also:

• Sink.lineBreak(SinkEventAttributes)

text

public final void text(String text)

Description copied from interface: Sink

Adds a text. Shortcut for Sink.text(String, SinkEventAttributes) with first argument being text and second argument being null.

Specified by:

text in interface Sink

Parameters:

text - The text to write.

See Also:

• Sink.text(String,SinkEventAttributes)

unifyEOLs

protected static String unifyEOLs(String text)

Parses the given String and replaces all occurrences of '\n', '\r' and '\r\n' with the system EOL. All Sinks should make sure that text output is filtered through this method.

Parameters:

text - the text to scan. May be null in which case null is returned.

Returns:

a String that contains only System EOLs.

init

protected void init()

This is called in head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.

Since:

1.1.2

setDocumentLocator

public void setDocumentLocator(Locator locator)

Description copied from interface: Sink

Sets the locator which exposes location information for a particular Sink event.

Specified by:

setDocumentLocator in interface Sink

Parameters:

locator - the locator (never null).

getDocumentLocator

public Locator getDocumentLocator()

Description copied from interface: Sink

Returns the locator which exposes location information for a particular Sink event.

Specified by:

getDocumentLocator in interface Sink

Returns:

the locator (never null).

getLocationLogPrefix

protected String getLocationLogPrefix()

formatLocation

public static String formatLocation(Locator locator)

Creates a string with line/column information. Inspired by o.a.m.model.building.ModelProblemUtils.formatLocation(...).

Parameters:

locator - The locator must not be null.

Returns:

The formatted location or an empty string if unknown, never null.