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:
org.apache.maven.doxia.logging.LogEnabled
,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, 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
void
anchor_()
void
author_()
void
bold()
void
bold_()
void
close()
void
protected void
Write Apt escaped text to output.void
date_()
void
void
void
void
void
void
void
void
figureGraphics
(String name) void
flush()
protected StringBuffer
Returns the buffer that holds the current text.void
head()
void
head_()
void
protected void
init()
void
inline()
void
inline
(org.apache.maven.doxia.sink.SinkEventAttributes attributes) void
inline_()
void
italic()
void
italic_()
void
void
void
A link with a target.void
link_()
void
list()
void
list_()
void
listItem()
void
void
void
void
void
numberedList
(int numbering) void
void
void
void
void
void
void
protected void
Reset the StringBuilder.protected void
Deprecated.protected void
Reset the TableCaptionBuffer.void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
protected void
setHeadFlag
(boolean headFlag) Used to determine whether we are in head mode.void
table()
void
table_()
void
void
void
void
tableCell
(boolean headerRow) Starts a table cell.void
void
void
void
tableRow()
void
void
tableRows
(int[] justification, boolean grid) void
void
void
title_()
void
unknown
(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes) Unkown events just log a warning message but are ignored otherwise.void
verbatim
(boolean boxed) void
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
-
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()- Overrides:
init
in 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()- Specified by:
head
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head
in 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
-
section1_
public void section1_()- Specified by:
section1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section1_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section2_
public void section2_()- Specified by:
section2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section2_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section3_
public void section3_()- Specified by:
section3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section3_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section4_
public void section4_()- Specified by:
section4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section4_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
section5_
public void section5_()- Specified by:
section5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
section5_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle1
public void sectionTitle1()- Specified by:
sectionTitle1
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle1_
public void sectionTitle1_()- Specified by:
sectionTitle1_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle1_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle2
public void sectionTitle2()- Specified by:
sectionTitle2
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle2_
public void sectionTitle2_()- Specified by:
sectionTitle2_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle2_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle3
public void sectionTitle3()- Specified by:
sectionTitle3
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle3_
public void sectionTitle3_()- Specified by:
sectionTitle3_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle3_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle4
public void sectionTitle4()- Specified by:
sectionTitle4
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle4_
public void sectionTitle4_()- Specified by:
sectionTitle4_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle4_
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle5
public void sectionTitle5()- Specified by:
sectionTitle5
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
sectionTitle5_
public void sectionTitle5_()- Specified by:
sectionTitle5_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
sectionTitle5_
in 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
-
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()- Specified by:
listItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
listItem
in 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) - Specified by:
numberedList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedList
in 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()- Specified by:
numberedListItem
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
numberedListItem
in 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()- Specified by:
definitionList
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definitionList
in 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()- Specified by:
definedTerm
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definedTerm
in 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()- Specified by:
definition
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
definition
in 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:
pageBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
pageBreak
in 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
-
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(boolean boxed) - Specified by:
verbatim
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
verbatim
in 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()- Specified by:
horizontalRule
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
horizontalRule
in 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
-
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:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows
in 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()- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in 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()- 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
-
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()- Specified by:
tableCaption
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableCaption
in 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:
figureGraphics
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
figureGraphics
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
anchor
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in 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:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in 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()- Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
inline
public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes) - Specified by:
inline
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
inline
in 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:
italic
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
italic
in 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:
bold
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
bold
in 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:
monospaced
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
monospaced
in 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()- Specified by:
lineBreak
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
lineBreak
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()- Specified by:
nonBreakingSpace
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
nonBreakingSpace
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
text
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
rawText
- Specified by:
rawText
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
rawText
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
comment
- Specified by:
comment
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
comment
in 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:
unknown
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
unknown
in 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:
flush
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
flush
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
close
public void close()- Specified by:
close
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
close
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
init()
instead of.