Package org.apache.maven.doxia.module.apt

Class AptSink

java.lang.Object

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

org.apache.maven.doxia.sink.impl.SinkAdapter

org.apache.maven.doxia.sink.impl.AbstractTextSink

org.apache.maven.doxia.module.apt.AptSink

All Implemented Interfaces:

AutoCloseable, Markup, TextMarkup, AptMarkup, Sink

public class AptSink
extends AbstractTextSink
implements AptMarkup

APT generator implementation.
Note: The encoding used is UTF-8.

Since:

1.0

Author:

eredmond

Field Summary

Fields

Modifier and Type	Field	Description
protected Stack<List<String>>	inlineStack	Keep track of the closing tags for inline events.

Fields inherited from interface org.apache.maven.doxia.module.apt.AptMarkup

ANCHOR_END_MARKUP, ANCHOR_START_MARKUP, BACKSLASH, BOLD_END_MARKUP, BOLD_START_MARKUP, COMMENT, HEADER_START_MARKUP, HORIZONTAL_RULE_MARKUP, ITALIC_END_MARKUP, ITALIC_START_MARKUP, LINK_END_MARKUP, LINK_START_1_MARKUP, LINK_START_2_MARKUP, LIST_END_MARKUP, LIST_START_MARKUP, MONOSPACED_END_MARKUP, MONOSPACED_START_MARKUP, NON_BREAKING_SPACE_MARKUP, NUMBERING, NUMBERING_LOWER_ALPHA_CHAR, NUMBERING_LOWER_ROMAN_CHAR, NUMBERING_UPPER_ALPHA_CHAR, NUMBERING_UPPER_ROMAN_CHAR, PAGE_BREAK, PAGE_BREAK_MARKUP, PERCENT, SECTION_TITLE_START_MARKUP, TAB, TABLE_CELL_SEPARATOR_MARKUP, TABLE_COL_CENTERED_ALIGNED_MARKUP, TABLE_COL_LEFT_ALIGNED_MARKUP, TABLE_COL_RIGHT_ALIGNED_MARKUP, TABLE_ROW_SEPARATOR_MARKUP, TABLE_ROW_START_MARKUP, VERBATIM_END_MARKUP, VERBATIM_SOURCE_END_MARKUP, VERBATIM_SOURCE_START_MARKUP, VERBATIM_START_MARKUP

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

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AptSink(Writer writer)	Constructor, initialize the Writer and the variables.

Method Summary

Modifier and Type	Method	Description
void	anchor(String name, SinkEventAttributes attributes)	Starts an element which defines an anchor.
void	anchor_()	Ends an anchor element.
void	author_()	Ends an author element.
void	bold()	Starts a bold element.
void	bold_()	Ends a bold element.
void	close()	Closes the writer or the stream, if needed.
void	comment(String comment)	Adds a comment (a text that should not be rendered but may be visible in the source of the output document).
protected void	content(String text)	Write Apt escaped text to output.
void	date_()	Ends the date element.
void	definedTerm(SinkEventAttributes attributes)	Starts a definition term element within a definition list.
void	definedTerm_()	Ends a definition term element within a definition list.
void	definition(SinkEventAttributes attributes)	Starts a definition element within a definition list.
void	definition_()	Ends a definition element within a definition list.
void	definitionList(SinkEventAttributes attributes)	Starts a definition list.
void	definitionList_()	Ends a definition list element.
void	figureCaption_()	Ends a caption of an image.
void	figureGraphics(String name, SinkEventAttributes attributes)	Adds a graphic element.
void	flush()	Flushes the writer or the stream, if needed.
protected StringBuffer	getBuffer()	Returns the buffer that holds the current text.
void	head(SinkEventAttributes attributes)	Starts the head element.
void	head_()	Ends the head element.
void	horizontalRule(SinkEventAttributes attributes)	Adds a horizontal separator rule.
protected void	init()	This is called in AbstractSink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
void	inline(SinkEventAttributes attributes)	Starts an inline element.
void	inline_()	Ends an inline element.
void	italic()	Starts an italic element.
void	italic_()	Ends an italic element.
void	lineBreak(SinkEventAttributes attributes)	Adds a line break.
void	link(String name, String target)	A link with a target.
void	link(String name, SinkEventAttributes attributes)	Starts a link.
void	link_()	Ends a link element.
void	list(SinkEventAttributes attributes)	Starts an unordered list.
void	list_()	Ends an unordered list element.
void	listItem(SinkEventAttributes attributes)	Starts a list item element within an unordered list.
void	listItem_()	Ends a list item element within an unordered list.
void	monospaced()	Starts a monospaced element.
void	monospaced_()	Ends a monospaced element.
void	nonBreakingSpace()	Adds a non breaking space, ie a space without any special formatting operations.
void	numberedList(int numbering, SinkEventAttributes attributes)	Starts an ordered list element.
void	numberedList_()	Ends an ordered list element.
void	numberedListItem(SinkEventAttributes attributes)	Starts a list item element within an ordered list.
void	numberedListItem_()	Ends a list item element within an ordered list.
void	pageBreak()	Adds a new page separator.
void	paragraph(SinkEventAttributes attributes)	Starts a paragraph.
void	paragraph_()	Ends a paragraph element.
void	rawText(String text)	Adds a raw text, ie a text without any special formatting operations.
protected void	resetBuffer()	Reset the StringBuilder.
protected void	resetTableCaptionBuffer()	Reset the TableCaptionBuffer.
void	section_(int level)	Ends a section at the given level.
void	sectionTitle(int level, SinkEventAttributes attributes)	Start a new section title at the given level.
void	sectionTitle_(int level)	Ends a section title at the given level.
protected void	setHeadFlag(boolean headFlag)	Used to determine whether we are in head mode.
void	table(SinkEventAttributes attributes)	Starts a table.
void	table_()	Ends a table element.
void	tableCaption(SinkEventAttributes attributes)	Starts a table caption.
void	tableCaption_()	Ends a caption element of a table.
void	tableCell(boolean headerRow)	Starts a table cell.
void	tableCell(SinkEventAttributes attributes)	Starts a table cell.
void	tableCell_()	Ends a cell element.
void	tableHeaderCell(SinkEventAttributes attributes)	Starts a table header cell.
void	tableHeaderCell_()	Ends a cell header element.
void	tableRow(SinkEventAttributes attributes)	Starts a table row.
void	tableRow_()	Ends a row element.
void	tableRows(int[] justification, boolean grid)	Starts an element that contains rows of table data.
void	tableRows_()	Ends an element that contains rows of table data.
void	text(String text, SinkEventAttributes attributes)	Adds a text.
void	title_()	Ends the title element.
void	unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)	Adds an unknown event.
void	verbatim(SinkEventAttributes attributes)	Starts a verbatim block, ie a block where whitespace has semantic relevance.
void	verbatim_()	Ends a verbatim element.
protected void	verbatimContent(String text)	Write Apt escaped text to output.
protected void	write(String text)	Write text to output.

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter

address, address_, article, article_, author, blockquote, blockquote_, body, body_, content, content_, data, data_, date, definitionListItem, definitionListItem_, division, division_, figure, figure_, figureCaption, footer, footer_, header, header_, lineBreakOpportunity, navigation, navigation_, section, sidebar, sidebar_, time, time_, title

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, getDocumentLocator, getLocationLogPrefix, head, header, horizontalRule, 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_, setDocumentLocator, 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

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

markupLineBreak

Field Details

inlineStack

protected Stack<List<String>> inlineStack

Keep track of the closing tags for inline events.

Constructor Details

AptSink

protected AptSink(Writer writer)

Constructor, initialize the Writer and the variables.

Parameters:

writer - not null writer to write the result. Should be an UTF-8 Writer.

Method Details

getBuffer

protected StringBuffer getBuffer()

Returns the buffer that holds the current text.

Returns:

A StringBuffer.

setHeadFlag

protected void setHeadFlag(boolean headFlag)

Used to determine whether we are in head mode.

Parameters:

headFlag - True for head mode.

init

protected void init()

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

Overrides:

init in class AbstractSink

resetBuffer

protected void resetBuffer()

Reset the StringBuilder.

resetTableCaptionBuffer

protected void resetTableCaptionBuffer()

Reset the TableCaptionBuffer.

head

public void head(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts the head element.

This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.

The canonical sequence of events for the head element is:

   sink.head();

   sink.title();
   sink.text("Title");
   sink.title_();

   sink.author();
   sink.text("Author");
   sink.author_();

   sink.date();
   sink.text("Date");
   sink.date_();

   sink.head_();
 

but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).

Supported attributes are:

PROFILE, LANG.

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

head_

public void head_()

Ends the head element.

Specified by:

head_ in interface Sink

Overrides:

head_ in class SinkAdapter

title_

public void title_()

Ends the title element.

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author_

public void author_()

Ends an author element.

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date_

public void date_()

Ends the date element.

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

section_

public void section_(int level)

Description copied from interface: Sink

Ends a section at the given level.

Specified by:

section_ in interface Sink

Overrides:

section_ in class SinkAdapter

Parameters:

level - the section level (must be a value between 1 and 6).

sectionTitle

public void sectionTitle(int level,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Start a new section title at the given level.

This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.

NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).

Supported attributes are the base attributes plus ALIGN.

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

Parameters:

level - the section title level (must be a value between 1 and 6).

attributes - A set of SinkEventAttributes, may be null.

sectionTitle_

public void sectionTitle_(int level)

Description copied from interface: Sink

Ends a section title at the given level.

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

Parameters:

level - the section title level (must be a value between 1 and 6).

list

public void list(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts an unordered list.

Supported attributes are the base attributes.

A list must contain at least one Sink.listItem(SinkEventAttributes) or Sink.listItem() as direct successor of this method.

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

list_

public void list_()

Ends an unordered list element.

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a list item element within an unordered list.

Supported attributes are the base attributes.

Nested lists must have the following Sink method sequence:

1. Sink.listItem(SinkEventAttributes) or Sink.listItem()
2. Sink.list(SinkEventAttributes) or Sink.list()
3. Sink.listItem(SinkEventAttributes) or Sink.listItem()
4. ...
5. Sink.listItem_()
6. Sink.list_()
7. ...
8. Sink.listItem_()
9. Sink.list_()

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

listItem_

public void listItem_()

Ends a list item element within an unordered list.

Specified by:

listItem_ in interface Sink

Overrides:

listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Starts an ordered list element.

Supported attributes are the base attributes.

A list must contain at least one Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem() as direct successor of this method.

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

Parameters:

numbering - the numbering style.

attributes - A set of SinkEventAttributes, may be null.

See Also:

• Sink.NUMBERING_DECIMAL
• Sink.NUMBERING_LOWER_ALPHA
• Sink.NUMBERING_LOWER_ROMAN
• Sink.NUMBERING_UPPER_ALPHA
• Sink.NUMBERING_UPPER_ROMAN

numberedList_

public void numberedList_()

Ends an ordered list element.

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a list item element within an ordered list.

Supported attributes are the base attributes.

Nested lists must have the following Sink method sequence:

1. Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
2. Sink.numberedList(int,SinkEventAttributes) or Sink.numberedList(int)
3. Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
4. ...
5. Sink.numberedListItem_()
6. Sink.numberedList_()
7. ...
8. Sink.numberedListItem_()
9. Sink.numberedList_()

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

numberedListItem_

public void numberedListItem_()

Ends a list item element within an ordered list.

Specified by:

numberedListItem_ in interface Sink

Overrides:

numberedListItem_ in class SinkAdapter

definitionList

public void definitionList(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a definition list.

Supported attributes are the base attributes.

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

definitionList_

public void definitionList_()

Ends a definition list element.

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a definition term element within a definition list.

Supported attributes are the base attributes.

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

definedTerm_

public void definedTerm_()

Ends a definition term element within a definition list.

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definition

public void definition(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a definition element within a definition list.

Supported attributes are the base attributes.

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

definition_

public void definition_()

Ends a definition element within a definition list.

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

pageBreak

public void pageBreak()

Adds a new page separator.

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

paragraph

public void paragraph(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

paragraph_

public void paragraph_()

Ends a paragraph element.

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a verbatim block, ie a block where whitespace has semantic relevance.

Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.

Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.

Supported attributes are the base attributes plus:

DECORATION (values: "source"), ALIGN, WIDTH.

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

verbatim_

public void verbatim_()

Ends a verbatim element.

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)

Description copied from interface: Sink

Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

table

public void table(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a table.

The canonical sequence of events for the table element is:

   sink.table();

   sink.tableRows(justify, true);

   sink.tableRow();
   sink.tableCell();
   sink.text("cell 1,1");
   sink.tableCell_();
   sink.tableCell();
   sink.text("cell 1,2");
   sink.tableCell_();
   sink.tableRow_();

   sink.tableRows_();

   sink.tableCaption();
   sink.text("Table caption");
   sink.tableCaption_();

   sink.table_();

 

where the tableCaption element is optional.

However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

table_

public void table_()

Ends a table element.

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

public void tableRows(int[] justification,
 boolean grid)

Description copied from interface: Sink

Starts an element that contains rows of table data.

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

Parameters:

justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells. Each element of the array must be one of the following constants: Sink.JUSTIFY_LEFT, Sink.JUSTIFY_CENTER, Sink.JUSTIFY_RIGHT or Sink.JUSTIFY_DEFAULT.

grid - true to render a grid, false otherwise.

See Also:

• Sink.table(SinkEventAttributes)
• Sink.JUSTIFY_CENTER
• Sink.JUSTIFY_LEFT
• Sink.JUSTIFY_RIGHT
• Sink.JUSTIFY_DEFAULT

tableRows_

public void tableRows_()

Ends an element that contains rows of table data.

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a table row.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

tableRow_

public void tableRow_()

Ends a row element.

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a table cell.

Supported attributes are the base attributes plus:

ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a table header cell.

Supported attributes are the same as for tableCell.

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

tableCell

public void tableCell(boolean headerRow)

Starts a table cell.

Parameters:

headerRow - If this cell is part of a header row.

tableCell_

public void tableCell_()

Ends a cell element.

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Ends a cell header element.

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a table caption.

Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus ALIGN.

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

See Also:

• Sink.table(SinkEventAttributes)

tableCaption_

public void tableCaption_()

Ends a caption element of a table.

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

figureCaption_

public void figureCaption_()

Ends a caption of an image.

Specified by:

figureCaption_ in interface Sink

Overrides:

figureCaption_ in class SinkAdapter

figureGraphics

public void figureGraphics(String name,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Adds a graphic element.

The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.

Supported attributes are the base attributes plus:

SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.

If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

Parameters:

name - the image source, a valid URL.

attributes - A set of SinkEventAttributes, may be null.

See Also:

• Sink.figure(SinkEventAttributes)

anchor

public void anchor(String name,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Starts an element which defines an anchor.

The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:

ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

Parameters:

name - the name of the anchor. This has to be a valid SGML NAME token.

attributes - A set of SinkEventAttributes, may be null.

anchor_

public void anchor_()

Ends an anchor element.

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(String name,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Starts a link.

The name parameter has to be a valid URI according to RFC 3986, i.e. for internal links (links to an anchor within the same source document), name should start with the character "#". This also implies that all unsafe characters are already encoded.

Supported attributes are the base attributes plus:

CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.

If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

Parameters:

name - the name of the link.

attributes - A set of SinkEventAttributes, may be null.

See Also:

• URI.toASCIIString()

link_

public void link_()

Ends a link element.

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

link

public void link(String name,
 String target)

A link with a target.

Parameters:

name - The name of the link.

target - The link target.

inline

public void inline(SinkEventAttributes attributes)

Description copied from interface: Sink

Starts an inline element.

The inline method is similar to Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.

Supported attributes are the base attributes plus

SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").

Specified by:

inline in interface Sink

Overrides:

inline in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

inline_

public void inline_()

Ends an inline element.

Specified by:

inline_ in interface Sink

Overrides:

inline_ in class SinkAdapter

italic

public void italic()

Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak(SinkEventAttributes attributes)

Description copied from interface: Sink

Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

Parameters:

attributes - A set of SinkEventAttributes, may be null.

nonBreakingSpace

public void nonBreakingSpace()

Adds a non breaking space, ie a space without any special formatting operations.

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(String text,
 SinkEventAttributes attributes)

Description copied from interface: Sink

Adds a text.

The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.

If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.

Supported attributes are the base attributes plus

SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").

The following attributes are deprecated:

VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

Parameters:

text - The text to write.

attributes - A set of SinkEventAttributes, may be null.

rawText

public void rawText(String text)

Description copied from interface: Sink

Adds a raw text, ie a text without any special formatting operations.

Specified by:

rawText in interface Sink

Overrides:

rawText in class SinkAdapter

Parameters:

text - The text to write.

comment

public void comment(String comment)

Description copied from interface: Sink

Adds a comment (a text that should not be rendered but may be visible in the source of the output document).

Specified by:

comment in interface Sink

Overrides:

comment in class SinkAdapter

Parameters:

comment - The comment to write.

unknown

public void unknown(String name,
 Object[] requiredParams,
 SinkEventAttributes attributes)

Adds an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Unkown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

Parameters:

name - The name of the event.

requiredParams - An optional array of required parameters to the event. May be null.

attributes - A set of SinkEventAttributes, may be null.

See Also:

• Sink.unknown(String,Object[],SinkEventAttributes)

write

protected void write(String text)

Write text to output.

Parameters:

text - The text to write.

content

protected void content(String text)

Write Apt escaped text to output.

Parameters:

text - The text to write.

verbatimContent

protected void verbatimContent(String text)

Write Apt escaped text to output.

Parameters:

text - The text to write.

flush

public void flush()

Flushes the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Closes the writer or the stream, if needed. Closing a previously-closed Sink has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter