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()
final void	anchor(String name)
final void	article()
final void	author()
final void	blockquote()
final void	body()
final void	content()
final void	data(String value)
final void	date()
final void	definedTerm()
final void	definition()
final void	definitionList()
final void	definitionListItem()
final void	division()
final void	figure()
final void	figureCaption()
final void	figureGraphics(String name)
final void	footer()
static String	formatLocation(Locator locator)	Creates a string with line/column information.
Locator	getDocumentLocator()
protected String	getLocationLogPrefix()
final void	head()
final void	header()
final void	horizontalRule()
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()
final void	lineBreak()
final void	lineBreakOpportunity()
final void	link(String name)
final void	list()
final void	listItem()
final void	navigation()
final void	numberedList(int numbering)
final void	numberedListItem()
final void	paragraph()
final void	section1()
final void	section1_()
final void	section2()
final void	section2_()
final void	section3()
final void	section3_()
final void	section4()
final void	section4_()
final void	section5()
final void	section5_()
final void	section6()
final void	section6_()
final void	sectionTitle()
final void	sectionTitle_()
final void	sectionTitle1()
final void	sectionTitle1_()
final void	sectionTitle2()
final void	sectionTitle2_()
final void	sectionTitle3()
final void	sectionTitle3_()
final void	sectionTitle4()
final void	sectionTitle4_()
final void	sectionTitle5()
final void	sectionTitle5_()
final void	sectionTitle6()
final void	sectionTitle6_()
void	setDocumentLocator(Locator locator)
final void	sidebar()
final void	table()
final void	tableCaption()
final void	tableCell()
final void	tableHeaderCell()
final void	tableRow()
final void	tableRows()
final void	text(String text)
final void	time(String datetime)
final void	title()
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()

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

Specified by:

head in interface Sink

title

public final void title()

Specified by:

title in interface Sink

author

public final void author()

Specified by:

author in interface Sink

date

public final void date()

Specified by:

date in interface Sink

body

public final void body()

Specified by:

body in interface Sink

article

public final void article()

Specified by:

article in interface Sink

navigation

public final void navigation()

Specified by:

navigation in interface Sink

sidebar

public final void sidebar()

Specified by:

sidebar in interface Sink

sectionTitle

public final void sectionTitle()

Specified by:

sectionTitle in interface Sink

section1

public final void section1()

Specified by:

section1 in interface Sink

sectionTitle_

public final void sectionTitle_()

Specified by:

sectionTitle_ in interface Sink

section1_

public final void section1_()

Specified by:

section1_ in interface Sink

sectionTitle1

public final void sectionTitle1()

Specified by:

sectionTitle1 in interface Sink

sectionTitle1_

public final void sectionTitle1_()

Specified by:

sectionTitle1_ in interface Sink

section2

public final void section2()

Specified by:

section2 in interface Sink

section2_

public final void section2_()

Specified by:

section2_ in interface Sink

sectionTitle2

public final void sectionTitle2()

Specified by:

sectionTitle2 in interface Sink

sectionTitle2_

public final void sectionTitle2_()

Specified by:

sectionTitle2_ in interface Sink

section3

public final void section3()

Specified by:

section3 in interface Sink

section3_

public final void section3_()

Specified by:

section3_ in interface Sink

sectionTitle3

public final void sectionTitle3()

Specified by:

sectionTitle3 in interface Sink

sectionTitle3_

public final void sectionTitle3_()

Specified by:

sectionTitle3_ in interface Sink

section4

public final void section4()

Specified by:

section4 in interface Sink

section4_

public final void section4_()

Specified by:

section4_ in interface Sink

sectionTitle4

public final void sectionTitle4()

Specified by:

sectionTitle4 in interface Sink

sectionTitle4_

public final void sectionTitle4_()

Specified by:

sectionTitle4_ in interface Sink

section5

public final void section5()

Specified by:

section5 in interface Sink

section5_

public final void section5_()

Specified by:

section5_ in interface Sink

sectionTitle5

public final void sectionTitle5()

Specified by:

sectionTitle5 in interface Sink

sectionTitle5_

public final void sectionTitle5_()

Specified by:

sectionTitle5_ in interface Sink

section6

public final void section6()

Specified by:

section6 in interface Sink

section6_

public final void section6_()

Specified by:

section6_ in interface Sink

sectionTitle6

public final void sectionTitle6()

Specified by:

sectionTitle6 in interface Sink

sectionTitle6_

public final void sectionTitle6_()

Specified by:

sectionTitle6_ in interface Sink

header

public final void header()

Specified by:

header in interface Sink

content

public final void content()

Specified by:

content in interface Sink

footer

public final void footer()

Specified by:

footer in interface Sink

list

public final void list()

Specified by:

list in interface Sink

listItem

public final void listItem()

Specified by:

listItem in interface Sink

numberedList

public final void numberedList(int numbering)

Specified by:

numberedList in interface Sink

numberedListItem

public final void numberedListItem()

Specified by:

numberedListItem in interface Sink

definitionList

public final void definitionList()

Specified by:

definitionList in interface Sink

definitionListItem

public final void definitionListItem()

Specified by:

definitionListItem in interface Sink

definition

public final void definition()

Specified by:

definition in interface Sink

definedTerm

public final void definedTerm()

Specified by:

definedTerm in interface Sink

figure

public final void figure()

Specified by:

figure in interface Sink

figureCaption

public final void figureCaption()

Specified by:

figureCaption in interface Sink

figureGraphics

public final void figureGraphics(String name)

Specified by:

figureGraphics in interface Sink

table

public final void table()

Specified by:

table in interface Sink

tableRows

public final void tableRows()

Specified by:

tableRows in interface Sink

tableRow

public final void tableRow()

Specified by:

tableRow in interface Sink

tableCell

public final void tableCell()

Specified by:

tableCell in interface Sink

tableHeaderCell

public final void tableHeaderCell()

Specified by:

tableHeaderCell in interface Sink

tableCaption

public final void tableCaption()

Specified by:

tableCaption in interface Sink

paragraph

public final void paragraph()

Specified by:

paragraph in interface Sink

data

public final void data(String value)

Specified by:

data in interface Sink

time

public final void time(String datetime)

Specified by:

time in interface Sink

address

public final void address()

Specified by:

address in interface Sink

blockquote

public final void blockquote()

Specified by:

blockquote in interface Sink

division

public final void division()

Specified by:

division in interface Sink

verbatim

public final void verbatim()

Specified by:

verbatim in interface Sink

horizontalRule

public final void horizontalRule()

Specified by:

horizontalRule in interface Sink

anchor

public final void anchor(String name)

Specified by:

anchor in interface Sink

link

public final void link(String name)

Specified by:

link in interface Sink

inline

public final void inline()

Specified by:

inline in interface Sink

lineBreak

public final void lineBreak()

Specified by:

lineBreak in interface Sink

lineBreakOpportunity

public final void lineBreakOpportunity()

Specified by:

lineBreakOpportunity in interface Sink

text

public final void text(String text)

Specified by:

text in interface Sink

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)

Specified by:

setDocumentLocator in interface Sink

getDocumentLocator

public Locator getDocumentLocator()

Specified by:

getDocumentLocator in interface Sink

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.