Package org.apache.maven.doxia.sink.impl
Class AbstractSink
java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractSink
- All Implemented Interfaces:
AutoCloseable
,Markup
,org.apache.maven.doxia.sink.Sink
- Direct Known Subclasses:
SinkAdapter
,SinkWrapper
public abstract class AbstractSink
extends Object
implements org.apache.maven.doxia.sink.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_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 -
Method Summary
Modifier and TypeMethodDescriptionfinal void
address()
final void
final void
article()
final void
author()
final void
final void
body()
final void
content()
final void
final void
date()
final void
final void
final void
final void
final void
division()
final void
figure()
final void
final void
figureGraphics
(String name) final void
footer()
static String
formatLocation
(org.apache.maven.doxia.sink.Locator locator) Creates a string with line/column information.org.apache.maven.doxia.sink.Locator
protected String
final void
head()
final void
header()
final void
protected void
init()
This is called inhead()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.final void
inline()
final void
final void
final void
final void
list()
final void
listItem()
final void
final void
numberedList
(int numbering) final void
final void
final void
section1()
final void
final void
section2()
final void
final void
section3()
final void
final void
section4()
final void
final void
section5()
final void
final void
section6()
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
final void
void
setDocumentLocator
(org.apache.maven.doxia.sink.Locator locator) final void
sidebar()
final void
table()
final void
final void
final void
final void
tableRow()
final void
final void
final void
final void
title()
protected static String
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_, 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 interfaceorg.apache.maven.doxia.sink.Sink
-
title
public final void title()- Specified by:
title
in interfaceorg.apache.maven.doxia.sink.Sink
-
author
public final void author()- Specified by:
author
in interfaceorg.apache.maven.doxia.sink.Sink
-
date
public final void date()- Specified by:
date
in interfaceorg.apache.maven.doxia.sink.Sink
-
body
public final void body()- Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
-
article
public final void article()- Specified by:
article
in interfaceorg.apache.maven.doxia.sink.Sink
-
sidebar
public final void sidebar()- Specified by:
sidebar
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle
public final void sectionTitle()- Specified by:
sectionTitle
in interfaceorg.apache.maven.doxia.sink.Sink
-
section1
public final void section1()- Specified by:
section1
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle_
public final void sectionTitle_()- Specified by:
sectionTitle_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section1_
public final void section1_()- Specified by:
section1_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle1
public final void sectionTitle1()- Specified by:
sectionTitle1
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle1_
public final void sectionTitle1_()- Specified by:
sectionTitle1_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section2
public final void section2()- Specified by:
section2
in interfaceorg.apache.maven.doxia.sink.Sink
-
section2_
public final void section2_()- Specified by:
section2_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle2
public final void sectionTitle2()- Specified by:
sectionTitle2
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle2_
public final void sectionTitle2_()- Specified by:
sectionTitle2_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section3
public final void section3()- Specified by:
section3
in interfaceorg.apache.maven.doxia.sink.Sink
-
section3_
public final void section3_()- Specified by:
section3_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle3
public final void sectionTitle3()- Specified by:
sectionTitle3
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle3_
public final void sectionTitle3_()- Specified by:
sectionTitle3_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section4
public final void section4()- Specified by:
section4
in interfaceorg.apache.maven.doxia.sink.Sink
-
section4_
public final void section4_()- Specified by:
section4_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle4
public final void sectionTitle4()- Specified by:
sectionTitle4
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle4_
public final void sectionTitle4_()- Specified by:
sectionTitle4_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section5
public final void section5()- Specified by:
section5
in interfaceorg.apache.maven.doxia.sink.Sink
-
section5_
public final void section5_()- Specified by:
section5_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle5
public final void sectionTitle5()- Specified by:
sectionTitle5
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle5_
public final void sectionTitle5_()- Specified by:
sectionTitle5_
in interfaceorg.apache.maven.doxia.sink.Sink
-
section6
public final void section6()- Specified by:
section6
in interfaceorg.apache.maven.doxia.sink.Sink
-
section6_
public final void section6_()- Specified by:
section6_
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle6
public final void sectionTitle6()- Specified by:
sectionTitle6
in interfaceorg.apache.maven.doxia.sink.Sink
-
sectionTitle6_
public final void sectionTitle6_()- Specified by:
sectionTitle6_
in interfaceorg.apache.maven.doxia.sink.Sink
-
header
public final void header()- Specified by:
header
in interfaceorg.apache.maven.doxia.sink.Sink
-
content
public final void content()- Specified by:
content
in interfaceorg.apache.maven.doxia.sink.Sink
-
list
public final void list()- Specified by:
list
in interfaceorg.apache.maven.doxia.sink.Sink
-
listItem
public final void listItem()- Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
-
numberedList
public final void numberedList(int numbering) - Specified by:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
-
numberedListItem
public final void numberedListItem()- Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
-
definitionList
public final void definitionList()- Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
-
definitionListItem
public final void definitionListItem()- Specified by:
definitionListItem
in interfaceorg.apache.maven.doxia.sink.Sink
-
definition
public final void definition()- Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
-
definedTerm
public final void definedTerm()- Specified by:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
-
figure
public final void figure()- Specified by:
figure
in interfaceorg.apache.maven.doxia.sink.Sink
-
figureCaption
public final void figureCaption()- Specified by:
figureCaption
in interfaceorg.apache.maven.doxia.sink.Sink
-
figureGraphics
- Specified by:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
-
table
public final void table()- Specified by:
table
in interfaceorg.apache.maven.doxia.sink.Sink
-
tableRows
public final void tableRows()- Specified by:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
-
tableRow
public final void tableRow()- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
-
tableCell
public final void tableCell()- Specified by:
tableCell
in interfaceorg.apache.maven.doxia.sink.Sink
-
tableHeaderCell
public final void tableHeaderCell()- Specified by:
tableHeaderCell
in interfaceorg.apache.maven.doxia.sink.Sink
-
tableCaption
public final void tableCaption()- Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
-
paragraph
public final void paragraph()- Specified by:
paragraph
in interfaceorg.apache.maven.doxia.sink.Sink
-
data
- Specified by:
data
in interfaceorg.apache.maven.doxia.sink.Sink
-
time
- Specified by:
time
in interfaceorg.apache.maven.doxia.sink.Sink
-
address
public final void address()- Specified by:
address
in interfaceorg.apache.maven.doxia.sink.Sink
-
blockquote
public final void blockquote()- Specified by:
blockquote
in interfaceorg.apache.maven.doxia.sink.Sink
-
division
public final void division()- Specified by:
division
in interfaceorg.apache.maven.doxia.sink.Sink
-
verbatim
public final void verbatim()- Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
-
horizontalRule
public final void horizontalRule()- Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
-
anchor
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
-
link
- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
-
inline
public final void inline()- Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
-
lineBreak
public final void lineBreak()- Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
-
lineBreakOpportunity
public final void lineBreakOpportunity()- Specified by:
lineBreakOpportunity
in interfaceorg.apache.maven.doxia.sink.Sink
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
-
unifyEOLs
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 inhead()
or inSink.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(org.apache.maven.doxia.sink.Locator locator) - Specified by:
setDocumentLocator
in interfaceorg.apache.maven.doxia.sink.Sink
-
getDocumentLocator
public org.apache.maven.doxia.sink.Locator getDocumentLocator()- Specified by:
getDocumentLocator
in interfaceorg.apache.maven.doxia.sink.Sink
-
getLocationLogPrefix
-
formatLocation
Creates a string with line/column information. Inspired byo.a.m.model.building.ModelProblemUtils.formatLocation(...)
.- Parameters:
locator
- The locator must not benull
.- Returns:
- The formatted location or an empty string if unknown, never
null
.
-