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,org.apache.maven.doxia.markup.Markup,org.apache.maven.doxia.markup.TextMarkup,AptMarkup,org.apache.maven.doxia.sink.Sink
APT generator implementation.
Note: The encoding used is UTF-8.
Note: The encoding used is UTF-8.
- Since:
- 1.0
- Author:
- eredmond
-
Field Summary
FieldsModifier and TypeFieldDescriptionKeep 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_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, 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 TypeMethodDescriptionvoidvoidanchor_()voidauthor_()voidbold()voidbold_()voidclose()voidprotected voidWrite Apt escaped text to output.voiddate_()voiddefinedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoiddefinition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoiddefinitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidvoidfigureGraphics(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidflush()protected StringBufferReturns the buffer that holds the current text.voidhead(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidhead_()voidhorizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) protected voidinit()voidinline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidinline_()voiditalic()voiditalic_()voidlineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidA link with a target.voidvoidlink_()voidlist(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidlist_()voidlistItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidvoidvoidvoidnumberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidnumberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidvoidparagraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidprotected voidReset the StringBuilder.protected voidReset the TableCaptionBuffer.voidsection_(int level) voidsectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidsectionTitle_(int level) protected voidsetHeadFlag(boolean headFlag) Used to determine whether we are in head mode.voidtable(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidtable_()voidtableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableCell(boolean headerRow) Starts a table cell.voidtableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidvoidtableRows(int[] justification, boolean grid) voidvoidvoidtitle_()voidunknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Unkown events just log a warning message but are ignored otherwise.voidverbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) voidprotected 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_, 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_, titleMethods 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
-
Field Details
-
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 fromorg.codehaus.plexus.util.WriterFactory.
-
-
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.
-
init
protected void init()- Overrides:
initin classorg.apache.maven.doxia.sink.impl.AbstractSink
-
resetBuffer
protected void resetBuffer()Reset the StringBuilder. -
resetTableCaptionBuffer
protected void resetTableCaptionBuffer()Reset the TableCaptionBuffer. -
head
public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
headin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
headin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
head_
public void head_()- Specified by:
head_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
head_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
title_
public void title_()- Specified by:
title_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
title_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author_
public void author_()- Specified by:
author_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
author_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date_
public void date_()- Specified by:
date_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
date_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section_
public void section_(int level) - Specified by:
section_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
section_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle
public void sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
sectionTitlein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitlein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle_
public void sectionTitle_(int level) - Specified by:
sectionTitle_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
sectionTitle_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
list
public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
list_
public void list_()- Specified by:
list_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
list_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem
public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
listItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItemin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
listItem_
public void listItem_()- Specified by:
listItem_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
listItem_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList
public void numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedList_
public void numberedList_()- Specified by:
numberedList_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedList_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem
public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
numberedListItemin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItemin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
numberedListItem_
public void numberedListItem_()- Specified by:
numberedListItem_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
numberedListItem_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList
public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionListin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionListin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definitionList_
public void definitionList_()- Specified by:
definitionList_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionList_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm
public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definedTermin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTermin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definedTerm_
public void definedTerm_()- Specified by:
definedTerm_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definedTerm_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition
public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
definitionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definitionin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
definition_
public void definition_()- Specified by:
definition_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
definition_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
pageBreak
public void pageBreak()- Specified by:
pageBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
pageBreakin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph
public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
paragraphin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraphin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
paragraph_
public void paragraph_()- Specified by:
paragraph_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
paragraph_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
verbatim
public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
verbatimin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatimin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
verbatim_
public void verbatim_()- Specified by:
verbatim_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
verbatim_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
horizontalRule
public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
horizontalRulein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
horizontalRulein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table
public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tablein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tablein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
table_
public void table_()- Specified by:
table_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
table_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRows
public void tableRows(int[] justification, boolean grid) - Specified by:
tableRowsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowsin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRows_
public void tableRows_()- Specified by:
tableRows_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRows_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow
public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableRowin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRowin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableRow_
public void tableRow_()- Specified by:
tableRow_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableRow_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCell
public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell
public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableHeaderCellin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCellin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
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_()- Specified by:
tableCell_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCell_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableHeaderCell_
public void tableHeaderCell_()- Specified by:
tableHeaderCell_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableHeaderCell_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption
public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
tableCaptionin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaptionin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
tableCaption_
public void tableCaption_()- Specified by:
tableCaption_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
tableCaption_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureCaption_
public void figureCaption_()- Specified by:
figureCaption_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureCaption_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
figureGraphics
- Specified by:
figureGraphicsin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
figureGraphicsin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor
- Specified by:
anchorin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchorin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor_
public void anchor_()- Specified by:
anchor_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
anchor_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link
- Specified by:
linkin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
linkin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link_
public void link_()- Specified by:
link_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
link_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
link
A link with a target.- Parameters:
name- The name of the link.target- The link target.
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
inlinein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inlinein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline_
public void inline_()- Specified by:
inline_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
inline_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
italic
public void italic()- Specified by:
italicin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
italicin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
italic_
public void italic_()- Specified by:
italic_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
italic_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
bold
public void bold()- Specified by:
boldin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
boldin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
bold_
public void bold_()- Specified by:
bold_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
bold_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
monospaced
public void monospaced()- Specified by:
monospacedin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
monospacedin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
monospaced_
public void monospaced_()- Specified by:
monospaced_in interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
monospaced_in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
lineBreak
public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
lineBreakin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
lineBreakin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()- Specified by:
nonBreakingSpacein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
nonBreakingSpacein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
- Specified by:
textin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
textin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
rawText
- Specified by:
rawTextin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
rawTextin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
comment
- Specified by:
commentin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
commentin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
unknown
public void unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Unkown events just log a warning message but are ignored otherwise.- Specified by:
unknownin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
unknownin classorg.apache.maven.doxia.sink.impl.SinkAdapter- 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()- Specified by:
flushin interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
flushin classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
close
public void close()- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceorg.apache.maven.doxia.sink.Sink- Overrides:
closein classorg.apache.maven.doxia.sink.impl.SinkAdapter
-