|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.sink.AbstractSink
org.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.sink.AbstractTextSink
org.apache.maven.doxia.module.apt.AptSink
public class AptSink
APT generator implementation.
Note: The encoding used is UTF-8.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup |
---|
PIPE |
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 |
Constructor Summary | |
---|---|
protected |
AptSink(Writer writer)
Constructor, initialize the Writer and the variables. |
Method Summary | |
---|---|
void |
anchor_()
|
void |
anchor(String name)
|
void |
author_()
|
void |
bold_()
|
void |
bold()
|
void |
close()
|
void |
comment(String comment)
|
protected void |
content(String text)
Write Apt escaped text to output. |
void |
date_()
|
void |
definedTerm_()
|
void |
definedTerm()
|
void |
definition_()
|
void |
definition()
|
void |
definitionList_()
|
void |
definitionList()
|
void |
figureCaption_()
|
void |
figureGraphics(String name)
|
void |
flush()
|
protected StringBuffer |
getBuffer()
Returns the buffer that holds the current text. |
void |
head_()
|
void |
head()
|
void |
horizontalRule()
|
protected void |
init()
|
void |
italic_()
|
void |
italic()
|
void |
lineBreak()
|
void |
link_()
|
void |
link(String name)
|
void |
link(String name,
String target)
A link with a target. |
void |
list_()
|
void |
list()
|
void |
listItem_()
|
void |
listItem()
|
void |
monospaced_()
|
void |
monospaced()
|
void |
nonBreakingSpace()
|
void |
numberedList_()
|
void |
numberedList(int numbering)
|
void |
numberedListItem_()
|
void |
numberedListItem()
|
void |
pageBreak()
|
void |
paragraph_()
|
void |
paragraph()
|
void |
rawText(String text)
|
protected void |
resetBuffer()
Reset the StringBuffer. |
protected void |
resetState()
Deprecated. since 1.1.2, use init() instead of. |
protected void |
resetTableCaptionBuffer()
Reset the TableCaptionBuffer. |
void |
section1_()
|
void |
section2_()
|
void |
section3_()
|
void |
section4_()
|
void |
section5_()
|
void |
sectionTitle1_()
|
void |
sectionTitle1()
|
void |
sectionTitle2_()
|
void |
sectionTitle2()
|
void |
sectionTitle3_()
|
void |
sectionTitle3()
|
void |
sectionTitle4_()
|
void |
sectionTitle4()
|
void |
sectionTitle5_()
|
void |
sectionTitle5()
|
protected void |
setHeadFlag(boolean headFlag)
Used to determine whether we are in head mode. |
void |
table_()
|
void |
table()
|
void |
tableCaption_()
|
void |
tableCaption()
|
void |
tableCell_()
|
void |
tableCell()
|
void |
tableCell(boolean headerRow)
Starts a table cell. |
void |
tableHeaderCell_()
|
void |
tableHeaderCell()
|
void |
tableRow_()
|
void |
tableRow()
|
void |
tableRows_()
|
void |
tableRows(int[] justification,
boolean grid)
|
void |
text(String text)
|
void |
title_()
|
void |
unknown(String name,
Object[] requiredParams,
SinkEventAttributes attributes)
Unkown events just log a warning message but are ignored otherwise. |
void |
verbatim_()
|
void |
verbatim(boolean boxed)
|
protected void |
verbatimContent(String text)
Write Apt escaped text to output. |
protected void |
write(String text)
Write text to output. |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
anchor, author, author, body_, body, body, date, date, definedTerm, definition, definitionList, definitionListItem_, definitionListItem, definitionListItem, figure_, figure, figure, figureCaption, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, section_, section, section1, section2, section3, section4, section5, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, title, verbatim |
Methods inherited from class org.apache.maven.doxia.sink.AbstractSink |
---|
enableLogging, getLog, unifyEOLs |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AptSink(Writer writer)
writer
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newWriter
methods from WriterFactory
.Method Detail |
---|
protected StringBuffer getBuffer()
protected void setHeadFlag(boolean headFlag)
headFlag
- True for head mode.protected void resetState()
init()
instead of.
protected void init()
init
in class AbstractSink
protected void resetBuffer()
protected void resetTableCaptionBuffer()
public void head()
head
in interface Sink
head
in class SinkAdapter
public void head_()
head_
in interface Sink
head_
in class SinkAdapter
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5_()
section5_
in interface Sink
section5_
in class SinkAdapter
public void sectionTitle1()
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
public void sectionTitle1_()
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void sectionTitle2()
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
public void sectionTitle2_()
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void sectionTitle3()
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
public void sectionTitle3_()
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void sectionTitle4()
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
public void sectionTitle4_()
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void sectionTitle5()
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
public void sectionTitle5_()
sectionTitle5_
in interface Sink
sectionTitle5_
in class SinkAdapter
public void list()
list
in interface Sink
list
in class SinkAdapter
public void list_()
list_
in interface Sink
list_
in class SinkAdapter
public void listItem()
listItem
in interface Sink
listItem
in class SinkAdapter
public void listItem_()
listItem_
in interface Sink
listItem_
in class SinkAdapter
public void numberedList(int numbering)
numberedList
in interface Sink
numberedList
in class SinkAdapter
public void numberedList_()
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem()
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
public void numberedListItem_()
numberedListItem_
in interface Sink
numberedListItem_
in class SinkAdapter
public void definitionList()
definitionList
in interface Sink
definitionList
in class SinkAdapter
public void definitionList_()
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definedTerm()
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
public void definedTerm_()
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void definition()
definition
in interface Sink
definition
in class SinkAdapter
public void definition_()
definition_
in interface Sink
definition_
in class SinkAdapter
public void pageBreak()
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void paragraph()
paragraph
in interface Sink
paragraph
in class SinkAdapter
public void paragraph_()
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface Sink
verbatim
in class SinkAdapter
public void verbatim_()
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
public void horizontalRule()
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
public void table()
table
in interface Sink
table
in class SinkAdapter
public void table_()
table_
in interface Sink
table_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface Sink
tableRows
in class SinkAdapter
public void tableRows_()
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void tableRow()
tableRow
in interface Sink
tableRow
in class SinkAdapter
public void tableRow_()
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableCell()
tableCell
in interface Sink
tableCell
in class SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
public void tableCell(boolean headerRow)
headerRow
- If this cell is part of a header row.public void tableCell_()
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableHeaderCell_()
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableCaption()
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
public void tableCaption_()
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void figureCaption_()
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void figureGraphics(String name)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
public void anchor(String name)
anchor
in interface Sink
anchor
in class SinkAdapter
public void anchor_()
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void link(String name)
link
in interface Sink
link
in class SinkAdapter
public void link_()
link_
in interface Sink
link_
in class SinkAdapter
public void link(String name, String target)
name
- The name of the link.target
- The link target.public void italic()
italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
italic_
in interface Sink
italic_
in class SinkAdapter
public void bold()
bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
bold_
in interface Sink
bold_
in class SinkAdapter
public void monospaced()
monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void lineBreak()
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
public void nonBreakingSpace()
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void text(String text)
text
in interface Sink
text
in class SinkAdapter
public void rawText(String text)
rawText
in interface Sink
rawText
in class SinkAdapter
public void comment(String comment)
comment
in interface Sink
comment
in class SinkAdapter
public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
unknown
in interface Sink
unknown
in class SinkAdapter
Sink.unknown(String,Object[],SinkEventAttributes)
protected void write(String text)
text
- The text to write.protected void content(String text)
text
- The text to write.protected void verbatimContent(String text)
text
- The text to write.public void flush()
flush
in interface Sink
flush
in class SinkAdapter
public void close()
close
in interface Sink
close
in class SinkAdapter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |