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:
LogEnabled
,Markup
,TextMarkup
,AptMarkup
,Sink
APT generator implementation.
Note: The encoding used is UTF-8.
Note: The encoding used is UTF-8.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
author.private StringBuffer
A buffer that holds the current text when headerFlag or bufferFlag set totrue
.private boolean
bufferFlag.private int
number of cells in a table.private int[]
justification of table cells.private String
date.private boolean
gridFlag for tables.private boolean
headerFlag.Keep track of the closing tags for inline events.private boolean
boxed verbatim.private boolean
itemFlag.private String
listNestingIndent.listStyles.private String
a line of a row in a table.private boolean
startFlag.private StringBuilder
A buffer that holds the table caption.private boolean
tableCaptionFlag.private boolean
tableCellFlag.private String
title.private boolean
verbatimFlag.private final PrintWriter
The writer to use.Fields inherited from interface org.apache.maven.doxia.module.apt.AptMarkup
ANCHOR_END_MARKUP, ANCHOR_START_MARKUP, BACKSLASH, BOLD_END_MARKUP, BOLD_START_MARKUP, BOXED_VERBATIM_END_MARKUP, BOXED_VERBATIM_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_BOXED_VERBATIM_END_MARKUP, NON_BOXED_VERBATIM_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
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, ROLE, 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.private void
Construct a table row.void
close()
Close the writer or the stream, if needed.void
Add a comment.protected void
Write Apt escaped text to output.void
date_()
Ends the date element.void
Starts a definition term element within a definition list.void
Ends a definition term element within a definition list.void
Starts a definition element within a definition list.void
Ends a definition element within a definition list.void
Starts a definition list element.void
Ends a definition list element.private void
Ends a table cell.private static String
Escape special characters in a text in APT:void
Ends a caption of an image.void
figureGraphics
(String name) Adding a source of a graphic.void
flush()
Flush the writer or the stream, if needed.protected StringBuffer
Returns the buffer that holds the current text.void
head()
Starts the head element.void
head_()
Ends the head element.void
Adding a separator of sections from a text to each other.protected void
init()
This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.void
inline()
Starts an inline element.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
Adds a line break.void
Starts an element which defines a link.void
A link with a target.void
link_()
Ends a link element.void
list()
Starts an unordered list element.void
list_()
Ends an unordered list element.void
listItem()
Starts a list item element within an unordered list.void
Ends a list item element within an unordered list.void
Starts a monospaced element.void
Ends a monospaced element.void
Adding a non breaking space, ie a space without any special formatting operations.void
numberedList
(int numbering) Starts an ordered list element.void
Ends an ordered list element.void
Starts a list item element within an ordered list.void
Ends a list item element within an ordered list.void
Adding a new page separator.void
Starts an element which represents a paragraph.void
Ends a paragraph element.void
Adding a raw text, ie a text without any special formatting operations.protected void
Reset the StringBuilder.protected void
Deprecated.protected void
Reset the TableCaptionBuffer.void
Ends a first heading element.void
Ends a second heading element.void
Ends a third heading element.void
Ends a 4th heading element.void
Ends a 5th heading element.void
Starts a first title heading element.void
Ends a first title heading element.void
Starts a second title heading element.void
Ends a second title heading element.void
Starts a third title heading element.void
Ends a third title heading element.void
Starts a 4th title heading element.void
Ends a 4th title heading element.void
Starts a 5th title heading element.void
Ends a 5th title heading element.protected void
setHeadFlag
(boolean headFlag) Used to determine whether we are in head mode.void
table()
Starts a table element for marking up tabular information in a document.void
table_()
Ends a table element.void
Starts a caption element of a table.void
Ends a caption element of a table.void
Starts a cell element which defines a cell that contains data.void
tableCell
(boolean headerRow) Starts a table cell.void
Ends a cell element.void
Starts a cell element which defines a cell that contains header information.void
Ends a cell header element.void
tableRow()
Starts a row element which acts as a container for a row of table cells.void
Ends a row element.void
tableRows
(int[] justification, boolean grid) Starts an element that contains rows of table data.void
Ends an element that contains rows of table data.void
Adding a text.void
title_()
Ends the title element.void
unknown
(String name, Object[] requiredParams, SinkEventAttributes attributes) Add an unknown event.void
verbatim
(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.void
Ends a verbatim element.protected void
verbatimContent
(String text) Write Apt escaped text to output.protected void
Write text to output.Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
address, address, address_, anchor, article, article, article_, author, author, blockquote, blockquote, blockquote_, body, body, body_, content, content, content_, data, data, data_, date, date, definedTerm, definition, definitionList, definitionListItem, definitionListItem, definitionListItem_, division, division, division_, figure, figure, figure_, figureCaption, figureCaption, figureGraphics, footer, footer, footer_, head, header, header, header_, horizontalRule, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, list, listItem, navigation, navigation, navigation_, numberedList, numberedListItem, paragraph, section, section_, section1, section2, section3, section4, section5, section6, section6_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, time, time, time_, title, title, verbatim
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
buffer
A buffer that holds the current text when headerFlag or bufferFlag set totrue
. -
tableCaptionBuffer
A buffer that holds the table caption. -
author
author. -
title
title. -
date
date. -
startFlag
private boolean startFlagstartFlag. -
tableCaptionFlag
private boolean tableCaptionFlagtableCaptionFlag. -
tableCellFlag
private boolean tableCellFlagtableCellFlag. -
headerFlag
private boolean headerFlagheaderFlag. -
bufferFlag
private boolean bufferFlagbufferFlag. -
itemFlag
private boolean itemFlagitemFlag. -
verbatimFlag
private boolean verbatimFlagverbatimFlag. -
isBoxed
private boolean isBoxedboxed verbatim. -
gridFlag
private boolean gridFlaggridFlag for tables. -
cellCount
private int cellCountnumber of cells in a table. -
writer
The writer to use. -
cellJustif
private int[] cellJustifjustification of table cells. -
rowLine
a line of a row in a table. -
listNestingIndent
listNestingIndent. -
listStyles
listStyles. -
inlineStack
Keep track of the closing tags for inline events.
-
-
Constructor Details
-
AptSink
Constructor, initialize the Writer and the variables.- Parameters:
writer
- not null writer to write the result. Should be an UTF-8 Writer. You could usenewWriter
methods fromWriterFactory
.
-
-
Method Details
-
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.
-
resetState
protected void resetState()Deprecated.since 1.1.2, useinit()
instead of.Reset all variables. -
init
protected void init()This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.- Overrides:
init
in classAbstractSink
-
resetBuffer
protected void resetBuffer()Reset the StringBuilder. -
resetTableCaptionBuffer
protected void resetTableCaptionBuffer()Reset the TableCaptionBuffer. -
head
public void head()Starts the head element.- Specified by:
head
in interfaceSink
- Overrides:
head
in classSinkAdapter
- See Also:
-
head_
public void head_()Ends the head element.- Specified by:
head_
in interfaceSink
- Overrides:
head_
in classSinkAdapter
-
title_
public void title_()Ends the title element.- Specified by:
title_
in interfaceSink
- Overrides:
title_
in classSinkAdapter
-
author_
public void author_()Ends an author element.- Specified by:
author_
in interfaceSink
- Overrides:
author_
in classSinkAdapter
-
date_
public void date_()Ends the date element.- Specified by:
date_
in interfaceSink
- Overrides:
date_
in classSinkAdapter
-
section1_
public void section1_()Ends a first heading element.- Specified by:
section1_
in interfaceSink
- Overrides:
section1_
in classSinkAdapter
-
section2_
public void section2_()Ends a second heading element.- Specified by:
section2_
in interfaceSink
- Overrides:
section2_
in classSinkAdapter
-
section3_
public void section3_()Ends a third heading element.- Specified by:
section3_
in interfaceSink
- Overrides:
section3_
in classSinkAdapter
-
section4_
public void section4_()Ends a 4th heading element.- Specified by:
section4_
in interfaceSink
- Overrides:
section4_
in classSinkAdapter
-
section5_
public void section5_()Ends a 5th heading element.- Specified by:
section5_
in interfaceSink
- Overrides:
section5_
in classSinkAdapter
-
sectionTitle1
public void sectionTitle1()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 aSink.section1()
element.- Specified by:
sectionTitle1
in interfaceSink
- Overrides:
sectionTitle1
in classSinkAdapter
- See Also:
-
sectionTitle1_
public void sectionTitle1_()Ends a first title heading element.- Specified by:
sectionTitle1_
in interfaceSink
- Overrides:
sectionTitle1_
in classSinkAdapter
-
sectionTitle2
public void sectionTitle2()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 aSink.section2()
element.- Specified by:
sectionTitle2
in interfaceSink
- Overrides:
sectionTitle2
in classSinkAdapter
- See Also:
-
sectionTitle2_
public void sectionTitle2_()Ends a second title heading element.- Specified by:
sectionTitle2_
in interfaceSink
- Overrides:
sectionTitle2_
in classSinkAdapter
-
sectionTitle3
public void sectionTitle3()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 aSink.section3()
element.- Specified by:
sectionTitle3
in interfaceSink
- Overrides:
sectionTitle3
in classSinkAdapter
- See Also:
-
sectionTitle3_
public void sectionTitle3_()Ends a third title heading element.- Specified by:
sectionTitle3_
in interfaceSink
- Overrides:
sectionTitle3_
in classSinkAdapter
-
sectionTitle4
public void sectionTitle4()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 aSink.section4()
element.- Specified by:
sectionTitle4
in interfaceSink
- Overrides:
sectionTitle4
in classSinkAdapter
- See Also:
-
sectionTitle4_
public void sectionTitle4_()Ends a 4th title heading element.- Specified by:
sectionTitle4_
in interfaceSink
- Overrides:
sectionTitle4_
in classSinkAdapter
-
sectionTitle5
public void sectionTitle5()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 aSink.section5()
element.- Specified by:
sectionTitle5
in interfaceSink
- Overrides:
sectionTitle5
in classSinkAdapter
- See Also:
-
sectionTitle5_
public void sectionTitle5_()Ends a 5th title heading element.- Specified by:
sectionTitle5_
in interfaceSink
- Overrides:
sectionTitle5_
in classSinkAdapter
-
list
public void list()Starts an unordered list element.- Specified by:
list
in interfaceSink
- Overrides:
list
in classSinkAdapter
- See Also:
-
list_
public void list_()Ends an unordered list element.- Specified by:
list_
in interfaceSink
- Overrides:
list_
in classSinkAdapter
-
listItem
public void listItem()Starts a list item element within an unordered list.- Specified by:
listItem
in interfaceSink
- Overrides:
listItem
in classSinkAdapter
- See Also:
-
listItem_
public void listItem_()Ends a list item element within an unordered list.- Specified by:
listItem_
in interfaceSink
- Overrides:
listItem_
in classSinkAdapter
-
numberedList
public void numberedList(int numbering) Starts an ordered list element.- Specified by:
numberedList
in interfaceSink
- Overrides:
numberedList
in classSinkAdapter
- Parameters:
numbering
- the numbering style.- See Also:
-
numberedList_
public void numberedList_()Ends an ordered list element.- Specified by:
numberedList_
in interfaceSink
- Overrides:
numberedList_
in classSinkAdapter
-
numberedListItem
public void numberedListItem()Starts a list item element within an ordered list.- Specified by:
numberedListItem
in interfaceSink
- Overrides:
numberedListItem
in classSinkAdapter
- See Also:
-
numberedListItem_
public void numberedListItem_()Ends a list item element within an ordered list.- Specified by:
numberedListItem_
in interfaceSink
- Overrides:
numberedListItem_
in classSinkAdapter
-
definitionList
public void definitionList()Starts a definition list element.- Specified by:
definitionList
in interfaceSink
- Overrides:
definitionList
in classSinkAdapter
- See Also:
-
definitionList_
public void definitionList_()Ends a definition list element.- Specified by:
definitionList_
in interfaceSink
- Overrides:
definitionList_
in classSinkAdapter
-
definedTerm
public void definedTerm()Starts a definition term element within a definition list.- Specified by:
definedTerm
in interfaceSink
- Overrides:
definedTerm
in classSinkAdapter
- See Also:
-
definedTerm_
public void definedTerm_()Ends a definition term element within a definition list.- Specified by:
definedTerm_
in interfaceSink
- Overrides:
definedTerm_
in classSinkAdapter
-
definition
public void definition()Starts a definition element within a definition list.- Specified by:
definition
in interfaceSink
- Overrides:
definition
in classSinkAdapter
- See Also:
-
definition_
public void definition_()Ends a definition element within a definition list.- Specified by:
definition_
in interfaceSink
- Overrides:
definition_
in classSinkAdapter
-
pageBreak
public void pageBreak()Adding a new page separator.- Specified by:
pageBreak
in interfaceSink
- Overrides:
pageBreak
in classSinkAdapter
-
paragraph
public void paragraph()Starts an element which represents a paragraph.- Specified by:
paragraph
in interfaceSink
- Overrides:
paragraph
in classSinkAdapter
- See Also:
-
paragraph_
public void paragraph_()Ends a paragraph element.- Specified by:
paragraph_
in interfaceSink
- Overrides:
paragraph_
in classSinkAdapter
-
verbatim
public void verbatim(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.- Specified by:
verbatim
in interfaceSink
- Overrides:
verbatim
in classSinkAdapter
- Parameters:
boxed
- true to add a box, false otherwise
-
verbatim_
public void verbatim_()Ends a verbatim element.- Specified by:
verbatim_
in interfaceSink
- Overrides:
verbatim_
in classSinkAdapter
-
horizontalRule
public void horizontalRule()Adding a separator of sections from a text to each other.- Specified by:
horizontalRule
in interfaceSink
- Overrides:
horizontalRule
in classSinkAdapter
- See Also:
-
table
public void table()Starts a table element for marking up tabular information in a document.- Specified by:
table
in interfaceSink
- Overrides:
table
in classSinkAdapter
- See Also:
-
table_
public void table_()Ends a table element.- Specified by:
table_
in interfaceSink
- Overrides:
table_
in classSinkAdapter
-
tableRows
public void tableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.- Specified by:
tableRows
in interfaceSink
- Overrides:
tableRows
in classSinkAdapter
- 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.grid
- true to provide a grid, false otherwise.- See Also:
-
tableRows_
public void tableRows_()Ends an element that contains rows of table data.- Specified by:
tableRows_
in interfaceSink
- Overrides:
tableRows_
in classSinkAdapter
-
tableRow
public void tableRow()Starts a row element which acts as a container for a row of table cells.- Specified by:
tableRow
in interfaceSink
- Overrides:
tableRow
in classSinkAdapter
- See Also:
-
tableRow_
public void tableRow_()Ends a row element.- Specified by:
tableRow_
in interfaceSink
- Overrides:
tableRow_
in classSinkAdapter
-
buildRowLine
private void buildRowLine()Construct a table row. -
tableCell
public void tableCell()Starts a cell element which defines a cell that contains data.- Specified by:
tableCell
in interfaceSink
- Overrides:
tableCell
in classSinkAdapter
- See Also:
-
tableHeaderCell
public void tableHeaderCell()Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCell
in interfaceSink
- Overrides:
tableHeaderCell
in classSinkAdapter
- See Also:
-
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 interfaceSink
- Overrides:
tableCell_
in classSinkAdapter
-
tableHeaderCell_
public void tableHeaderCell_()Ends a cell header element.- Specified by:
tableHeaderCell_
in interfaceSink
- Overrides:
tableHeaderCell_
in classSinkAdapter
-
endTableCell
private void endTableCell()Ends a table cell. -
tableCaption
public void tableCaption()Starts a caption element of a table.- Specified by:
tableCaption
in interfaceSink
- Overrides:
tableCaption
in classSinkAdapter
- See Also:
-
tableCaption_
public void tableCaption_()Ends a caption element of a table.- Specified by:
tableCaption_
in interfaceSink
- Overrides:
tableCaption_
in classSinkAdapter
-
figureCaption_
public void figureCaption_()Ends a caption of an image.- Specified by:
figureCaption_
in interfaceSink
- Overrides:
figureCaption_
in classSinkAdapter
-
figureGraphics
Adding a source of a graphic.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classSinkAdapter
- Parameters:
name
- the source
-
anchor
Starts an element which defines an anchor.- Specified by:
anchor
in interfaceSink
- Overrides:
anchor
in classSinkAdapter
- Parameters:
name
- the name of the anchor.- See Also:
-
anchor_
public void anchor_()Ends an anchor element.- Specified by:
anchor_
in interfaceSink
- Overrides:
anchor_
in classSinkAdapter
-
link
Starts an element which defines a link.- Specified by:
link
in interfaceSink
- Overrides:
link
in classSinkAdapter
- Parameters:
name
- the name of the link.- See Also:
-
link_
public void link_()Ends a link element.- Specified by:
link_
in interfaceSink
- Overrides:
link_
in classSinkAdapter
-
link
A link with a target.- Parameters:
name
- The name of the link.target
- The link target.
-
inline
public void inline()Starts an inline element.- Specified by:
inline
in interfaceSink
- Overrides:
inline
in classSinkAdapter
- See Also:
-
inline
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
plusSEMANTICS
(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 interfaceSink
- Overrides:
inline
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
inline_
public void inline_()Ends an inline element.- Specified by:
inline_
in interfaceSink
- Overrides:
inline_
in classSinkAdapter
-
italic
public void italic()Starts an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic
in interfaceSink
- Overrides:
italic
in classSinkAdapter
-
italic_
public void italic_()Ends an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic_
in interfaceSink
- Overrides:
italic_
in classSinkAdapter
-
bold
public void bold()Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold
in interfaceSink
- Overrides:
bold
in classSinkAdapter
-
bold_
public void bold_()Ends a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold_
in interfaceSink
- Overrides:
bold_
in classSinkAdapter
-
monospaced
public void monospaced()Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced
in interfaceSink
- Overrides:
monospaced
in classSinkAdapter
-
monospaced_
public void monospaced_()Ends a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced_
in interfaceSink
- Overrides:
monospaced_
in classSinkAdapter
-
lineBreak
public void lineBreak()Adds a line break.- Specified by:
lineBreak
in interfaceSink
- Overrides:
lineBreak
in classSinkAdapter
- See Also:
-
nonBreakingSpace
public void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpace
in interfaceSink
- Overrides:
nonBreakingSpace
in classSinkAdapter
-
text
Adding a text.- Specified by:
text
in interfaceSink
- Overrides:
text
in classSinkAdapter
- Parameters:
text
- The text to write.- See Also:
-
rawText
Adding a raw text, ie a text without any special formatting operations.- Specified by:
rawText
in interfaceSink
- Overrides:
rawText
in classSinkAdapter
- Parameters:
text
- The text to write.
-
comment
Add a comment.- Specified by:
comment
in interfaceSink
- Overrides:
comment
in classSinkAdapter
- Parameters:
comment
- The comment to write.
-
unknown
Add 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 interfaceSink
- Overrides:
unknown
in classSinkAdapter
- Parameters:
name
- The name of the event.requiredParams
- An optional array of required parameters to the event. May benull
.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
write
Write text to output.- Parameters:
text
- The text to write.
-
content
Write Apt escaped text to output.- Parameters:
text
- The text to write.
-
verbatimContent
Write Apt escaped text to output.- Parameters:
text
- The text to write.
-
flush
public void flush()Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.- Specified by:
flush
in interfaceSink
- Overrides:
flush
in classSinkAdapter
-
close
public void close()Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
close
in interfaceSink
- Overrides:
close
in classSinkAdapter
-
escapeAPT
Escape special characters in a text in APT:\~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\
- Parameters:
text
- the String to escape, may be null- Returns:
- the text escaped, "" if null String input
-
init()
instead of.