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 Stringauthor.private StringBufferA buffer that holds the current text when headerFlag or bufferFlag set totrue.private booleanbufferFlag.private intnumber of cells in a table.private int[]justification of table cells.private Stringdate.private booleangridFlag for tables.private booleanheaderFlag.Keep track of the closing tags for inline events.private booleanboxed verbatim.private booleanitemFlag.private StringlistNestingIndent.listStyles.private Stringa line of a row in a table.private booleanstartFlag.private StringBuilderA buffer that holds the table caption.private booleantableCaptionFlag.private booleantableCellFlag.private Stringtitle.private booleanverbatimFlag.private final PrintWriterThe 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_MARKUPFields 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, STARFields 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_6Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidStarts an element which defines an anchor.voidanchor_()Ends an anchor element.voidauthor_()Ends an author element.voidbold()Starts a bold element.voidbold_()Ends a bold element.private voidConstruct a table row.voidclose()Close the writer or the stream, if needed.voidAdd a comment.protected voidWrite Apt escaped text to output.voiddate_()Ends the date element.voidStarts a definition term element within a definition list.voidEnds a definition term element within a definition list.voidStarts a definition element within a definition list.voidEnds a definition element within a definition list.voidStarts a definition list element.voidEnds a definition list element.private voidEnds a table cell.private static StringEscape special characters in a text in APT:voidEnds a caption of an image.voidfigureGraphics(String name) Adding a source of a graphic.voidflush()Flush the writer or the stream, if needed.protected StringBufferReturns the buffer that holds the current text.voidhead()Starts the head element.voidhead_()Ends the head element.voidAdding a separator of sections from a text to each other.protected voidinit()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.voidinline()Starts an inline element.voidinline(SinkEventAttributes attributes) Starts an inline element.voidinline_()Ends an inline element.voiditalic()Starts an italic element.voiditalic_()Ends an italic element.voidAdds a line break.voidStarts an element which defines a link.voidA link with a target.voidlink_()Ends a link element.voidlist()Starts an unordered list element.voidlist_()Ends an unordered list element.voidlistItem()Starts a list item element within an unordered list.voidEnds a list item element within an unordered list.voidStarts a monospaced element.voidEnds a monospaced element.voidAdding a non breaking space, ie a space without any special formatting operations.voidnumberedList(int numbering) Starts an ordered list element.voidEnds an ordered list element.voidStarts a list item element within an ordered list.voidEnds a list item element within an ordered list.voidAdding a new page separator.voidStarts an element which represents a paragraph.voidEnds a paragraph element.voidAdding a raw text, ie a text without any special formatting operations.protected voidReset the StringBuilder.protected voidDeprecated.protected voidReset the TableCaptionBuffer.voidEnds a first heading element.voidEnds a second heading element.voidEnds a third heading element.voidEnds a 4th heading element.voidEnds a 5th heading element.voidStarts a first title heading element.voidEnds a first title heading element.voidStarts a second title heading element.voidEnds a second title heading element.voidStarts a third title heading element.voidEnds a third title heading element.voidStarts a 4th title heading element.voidEnds a 4th title heading element.voidStarts a 5th title heading element.voidEnds a 5th title heading element.protected voidsetHeadFlag(boolean headFlag) Used to determine whether we are in head mode.voidtable()Starts a table element for marking up tabular information in a document.voidtable_()Ends a table element.voidStarts a caption element of a table.voidEnds a caption element of a table.voidStarts a cell element which defines a cell that contains data.voidtableCell(boolean headerRow) Starts a table cell.voidEnds a cell element.voidStarts a cell element which defines a cell that contains header information.voidEnds a cell header element.voidtableRow()Starts a row element which acts as a container for a row of table cells.voidEnds a row element.voidtableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.voidEnds an element that contains rows of table data.voidAdding a text.voidtitle_()Ends the title element.voidunknown(String name, Object[] requiredParams, SinkEventAttributes attributes) Add an unknown event.voidverbatim(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.voidEnds a verbatim element.protected voidverbatimContent(String text) Write Apt escaped text to output.protected voidWrite 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, verbatimMethods 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 usenewWritermethods 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:
initin 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:
headin interfaceSink- Overrides:
headin 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:
sectionTitle1in interfaceSink- Overrides:
sectionTitle1in 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:
sectionTitle2in interfaceSink- Overrides:
sectionTitle2in 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:
sectionTitle3in interfaceSink- Overrides:
sectionTitle3in 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:
sectionTitle4in interfaceSink- Overrides:
sectionTitle4in 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:
sectionTitle5in interfaceSink- Overrides:
sectionTitle5in 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:
listin interfaceSink- Overrides:
listin 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:
listItemin interfaceSink- Overrides:
listItemin 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:
numberedListin interfaceSink- Overrides:
numberedListin 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:
numberedListItemin interfaceSink- Overrides:
numberedListItemin 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:
definitionListin interfaceSink- Overrides:
definitionListin 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:
definedTermin interfaceSink- Overrides:
definedTermin 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:
definitionin interfaceSink- Overrides:
definitionin 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:
pageBreakin interfaceSink- Overrides:
pageBreakin classSinkAdapter
-
paragraph
public void paragraph()Starts an element which represents a paragraph.- Specified by:
paragraphin interfaceSink- Overrides:
paragraphin 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:
verbatimin interfaceSink- Overrides:
verbatimin 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:
horizontalRulein interfaceSink- Overrides:
horizontalRulein classSinkAdapter- See Also:
-
table
public void table()Starts a table element for marking up tabular information in a document.- Specified by:
tablein interfaceSink- Overrides:
tablein 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:
tableRowsin interfaceSink- Overrides:
tableRowsin 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:
tableRowin interfaceSink- Overrides:
tableRowin 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:
tableCellin interfaceSink- Overrides:
tableCellin classSinkAdapter- See Also:
-
tableHeaderCell
public void tableHeaderCell()Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCellin interfaceSink- Overrides:
tableHeaderCellin 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:
tableCaptionin interfaceSink- Overrides:
tableCaptionin 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:
figureGraphicsin interfaceSink- Overrides:
figureGraphicsin classSinkAdapter- Parameters:
name- the source
-
anchor
Starts an element which defines an anchor.- Specified by:
anchorin interfaceSink- Overrides:
anchorin 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:
linkin interfaceSink- Overrides:
linkin 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:
inlinein interfaceSink- Overrides:
inlinein 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 attributesplusSEMANTICS(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:
inlinein interfaceSink- Overrides:
inlinein 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)withSTYLEinstead.- Specified by:
italicin interfaceSink- Overrides:
italicin classSinkAdapter
-
italic_
public void italic_()Ends an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
italic_in interfaceSink- Overrides:
italic_in classSinkAdapter
-
bold
public void bold()Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
boldin interfaceSink- Overrides:
boldin classSinkAdapter
-
bold_
public void bold_()Ends a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
bold_in interfaceSink- Overrides:
bold_in classSinkAdapter
-
monospaced
public void monospaced()Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
monospacedin interfaceSink- Overrides:
monospacedin classSinkAdapter
-
monospaced_
public void monospaced_()Ends a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)withSTYLEinstead.- Specified by:
monospaced_in interfaceSink- Overrides:
monospaced_in classSinkAdapter
-
lineBreak
public void lineBreak()Adds a line break.- Specified by:
lineBreakin interfaceSink- Overrides:
lineBreakin classSinkAdapter- See Also:
-
nonBreakingSpace
public void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpacein interfaceSink- Overrides:
nonBreakingSpacein classSinkAdapter
-
text
Adding a text.- Specified by:
textin interfaceSink- Overrides:
textin classSinkAdapter- Parameters:
text- The text to write.- See Also:
-
rawText
Adding a raw text, ie a text without any special formatting operations.- Specified by:
rawTextin interfaceSink- Overrides:
rawTextin classSinkAdapter- Parameters:
text- The text to write.
-
comment
Add a comment.- Specified by:
commentin interfaceSink- Overrides:
commentin 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:
unknownin interfaceSink- Overrides:
unknownin 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:
flushin interfaceSink- Overrides:
flushin classSinkAdapter
-
close
public void close()Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
closein interfaceSink- Overrides:
closein classSinkAdapter
-
escapeAPT
Escape special characters in a text in APT:\~, \=, \-, \+, \*, \[, \], \invalid input: '<', \>, \{, \}, \\- Parameters:
text- the String to escape, may be null- Returns:
- the text escaped, "" if null String input
-
init()instead of.