|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.sink.AbstractXmlSink
org.apache.maven.doxia.module.xdoc.XdocSink
public class XdocSink
A doxia Sink which produces an xdoc model.
| Field Summary | |
|---|---|
protected java.lang.StringBuffer |
buffer
Used to collect text events. |
protected boolean |
headFlag
An indication on if we're inside a head. |
protected org.apache.maven.doxia.util.LineBreaker |
out
The LineBreaker to write the result. |
protected boolean |
titleFlag
An indication on if we're inside a title. |
| Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup |
|---|
AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG |
| Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup |
|---|
BANG, CDATA |
| Fields inherited from interface org.apache.maven.doxia.markup.Markup |
|---|
EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SLASH, SPACE, STAR |
| Fields inherited from interface org.apache.maven.doxia.sink.Sink |
|---|
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 | |
|---|---|
XdocSink(java.io.Writer writer)
Constructor, initialize the LineBreaker. |
|
| Method Summary | |
|---|---|
void |
anchor_()
|
void |
anchor(java.lang.String name)
|
void |
author_()
|
void |
body_()
|
void |
body()
|
void |
bold_()
|
void |
bold()
|
void |
close()
|
protected void |
content(java.lang.String text)
Write HTML escaped text to output, not preserving white space. |
void |
date_()
|
void |
definedTerm_()
|
void |
definedTerm()
|
void |
definition_()
|
void |
definition()
|
void |
definitionList_()
|
void |
definitionList()
|
static java.lang.String |
encodeURL(java.lang.String text)
Forward to HtmlTools.encodeURL( text ). |
static java.lang.String |
escapeHTML(java.lang.String text)
Forward to HtmlTools.escapeHTML( text ). |
void |
figure_()
|
void |
figure()
|
void |
figureCaption_()
|
void |
figureCaption()
|
void |
figureGraphics(java.lang.String s)
|
void |
flush()
|
void |
head_()
|
void |
head()
|
void |
horizontalRule()
|
void |
italic_()
|
void |
italic()
|
void |
lineBreak()
|
void |
link_()
|
void |
link(java.lang.String name)
|
void |
list_()
|
void |
list()
|
void |
listItem_()
|
void |
listItem()
|
protected void |
markup(java.lang.String text)
Write text to output, preserving white space. |
void |
monospaced_()
|
void |
monospaced()
|
void |
nonBreakingSpace()
|
void |
numberedList_()
|
void |
numberedList(int numbering)
The default list style depends on the numbering. |
void |
numberedListItem_()
|
void |
numberedListItem()
|
void |
paragraph_()
|
void |
paragraph()
|
protected void |
resetState()
Reset all variables. |
void |
section1_()
|
void |
section1()
|
void |
section2_()
|
void |
section2()
|
void |
section3_()
|
void |
section3()
|
void |
section4_()
|
void |
section4()
|
void |
section5_()
|
void |
section5()
|
void |
sectionTitle1_()
|
void |
sectionTitle1()
|
void |
sectionTitle2_()
|
void |
sectionTitle2()
|
void |
sectionTitle3_()
|
void |
sectionTitle3()
|
void |
sectionTitle4_()
|
void |
sectionTitle4()
|
void |
sectionTitle5_()
|
void |
sectionTitle5()
|
void |
table_()
|
void |
table()
The default align is center. |
void |
tableCaption_()
|
void |
tableCaption()
|
void |
tableCell_()
|
void |
tableCell_(boolean headerRow)
Ends a table cell. |
void |
tableCell()
|
void |
tableCell(boolean headerRow)
Starts a table cell. |
void |
tableHeaderCell_()
|
void |
tableHeaderCell()
|
void |
tableRow_()
|
void |
tableRow()
The default valign is top. |
void |
tableRows_()
|
void |
tableRows(int[] justification,
boolean grid)
The default align is center. |
void |
text(java.lang.String text)
|
void |
title_()
|
void |
verbatim_()
|
void |
verbatim(boolean boxed)
|
protected void |
verbatimContent(java.lang.String text)
Write HTML escaped text to output, preserving white space. |
protected void |
write(java.lang.String text)
|
| Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink |
|---|
writeEndTag, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag |
| Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
|---|
author, date, definitionListItem_, definitionListItem, pageBreak, rawText, sectionTitle_, sectionTitle, tableCell, tableHeaderCell, title |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected org.apache.maven.doxia.util.LineBreaker out
protected java.lang.StringBuffer buffer
protected boolean headFlag
protected boolean titleFlag
| Constructor Detail |
|---|
public XdocSink(java.io.Writer writer)
writer - The writer to write the result.| Method Detail |
|---|
protected void resetState()
public void head()
head in interface org.apache.maven.doxia.sink.Sinkhead in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.DOCUMENT_TAG,
XdocMarkup.PROPERTIES_TAGpublic void head_()
head_ in interface org.apache.maven.doxia.sink.Sinkhead_ in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.DOCUMENT_TAG,
XdocMarkup.PROPERTIES_TAGpublic void title_()
title_ in interface org.apache.maven.doxia.sink.Sinktitle_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TITLEpublic void author_()
author_ in interface org.apache.maven.doxia.sink.Sinkauthor_ in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.AUTHOR_TAGpublic void date_()
date_ in interface org.apache.maven.doxia.sink.Sinkdate_ in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.DATE_TAGpublic void body()
body in interface org.apache.maven.doxia.sink.Sinkbody in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.BODYpublic void body_()
body_ in interface org.apache.maven.doxia.sink.Sinkbody_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.BODY,
XdocMarkup.DOCUMENT_TAGpublic void section1()
section1 in interface org.apache.maven.doxia.sink.Sinksection1 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle1()
sectionTitle1 in interface org.apache.maven.doxia.sink.SinksectionTitle1 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle1_()
sectionTitle1_ in interface org.apache.maven.doxia.sink.SinksectionTitle1_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section1_()
section1_ in interface org.apache.maven.doxia.sink.Sinksection1_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section2()
section2 in interface org.apache.maven.doxia.sink.Sinksection2 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle2()
sectionTitle2 in interface org.apache.maven.doxia.sink.SinksectionTitle2 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle2_()
sectionTitle2_ in interface org.apache.maven.doxia.sink.SinksectionTitle2_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section2_()
section2_ in interface org.apache.maven.doxia.sink.Sinksection2_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section3()
section3 in interface org.apache.maven.doxia.sink.Sinksection3 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle3()
sectionTitle3 in interface org.apache.maven.doxia.sink.SinksectionTitle3 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle3_()
sectionTitle3_ in interface org.apache.maven.doxia.sink.SinksectionTitle3_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section3_()
section3_ in interface org.apache.maven.doxia.sink.Sinksection3_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section4()
section4 in interface org.apache.maven.doxia.sink.Sinksection4 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle4()
sectionTitle4 in interface org.apache.maven.doxia.sink.SinksectionTitle4 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle4_()
sectionTitle4_ in interface org.apache.maven.doxia.sink.SinksectionTitle4_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section4_()
section4_ in interface org.apache.maven.doxia.sink.Sinksection4_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section5()
section5 in interface org.apache.maven.doxia.sink.Sinksection5 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle5()
sectionTitle5 in interface org.apache.maven.doxia.sink.SinksectionTitle5 in class org.apache.maven.doxia.sink.SinkAdapterpublic void sectionTitle5_()
sectionTitle5_ in interface org.apache.maven.doxia.sink.SinksectionTitle5_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void section5_()
section5_ in interface org.apache.maven.doxia.sink.Sinksection5_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void list()
list in interface org.apache.maven.doxia.sink.Sinklist in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.ULpublic void list_()
list_ in interface org.apache.maven.doxia.sink.Sinklist_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.ULpublic void listItem()
listItem in interface org.apache.maven.doxia.sink.SinklistItem in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.LIpublic void listItem_()
listItem_ in interface org.apache.maven.doxia.sink.SinklistItem_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.LIpublic void numberedList(int numbering)
numberedList in interface org.apache.maven.doxia.sink.SinknumberedList in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.OLpublic void numberedList_()
numberedList_ in interface org.apache.maven.doxia.sink.SinknumberedList_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.OLpublic void numberedListItem()
numberedListItem in interface org.apache.maven.doxia.sink.SinknumberedListItem in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.LIpublic void numberedListItem_()
numberedListItem_ in interface org.apache.maven.doxia.sink.SinknumberedListItem_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.LIpublic void definitionList()
definitionList in interface org.apache.maven.doxia.sink.SinkdefinitionList in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DLpublic void definitionList_()
definitionList_ in interface org.apache.maven.doxia.sink.SinkdefinitionList_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DLpublic void definedTerm()
definedTerm in interface org.apache.maven.doxia.sink.SinkdefinedTerm in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DTpublic void definedTerm_()
definedTerm_ in interface org.apache.maven.doxia.sink.SinkdefinedTerm_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DTpublic void definition()
definition in interface org.apache.maven.doxia.sink.Sinkdefinition in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DDpublic void definition_()
definition_ in interface org.apache.maven.doxia.sink.Sinkdefinition_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.DDpublic void figure()
figure in interface org.apache.maven.doxia.sink.Sinkfigure in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.IMGpublic void figure_()
figure_ in interface org.apache.maven.doxia.sink.Sinkfigure_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void figureGraphics(java.lang.String s)
figureGraphics in interface org.apache.maven.doxia.sink.SinkfigureGraphics in class org.apache.maven.doxia.sink.SinkAdapterpublic void figureCaption()
figureCaption in interface org.apache.maven.doxia.sink.SinkfigureCaption in class org.apache.maven.doxia.sink.SinkAdapterpublic void figureCaption_()
figureCaption_ in interface org.apache.maven.doxia.sink.SinkfigureCaption_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void paragraph()
paragraph in interface org.apache.maven.doxia.sink.Sinkparagraph in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Ppublic void paragraph_()
paragraph_ in interface org.apache.maven.doxia.sink.Sinkparagraph_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Ppublic void verbatim(boolean boxed)
verbatim in interface org.apache.maven.doxia.sink.Sinkverbatim in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.SOURCE_TAG,
HTML.Tag.PREpublic void verbatim_()
verbatim_ in interface org.apache.maven.doxia.sink.Sinkverbatim_ in class org.apache.maven.doxia.sink.SinkAdapterXdocMarkup.SOURCE_TAG,
HTML.Tag.PREpublic void horizontalRule()
horizontalRule in interface org.apache.maven.doxia.sink.SinkhorizontalRule in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.HRpublic void table()
center.
table in interface org.apache.maven.doxia.sink.Sinktable in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TABLEpublic void table_()
table_ in interface org.apache.maven.doxia.sink.Sinktable_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TABLE
public void tableRows(int[] justification,
boolean grid)
center.
tableRows in interface org.apache.maven.doxia.sink.SinktableRows in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TABLEpublic void tableRows_()
tableRows_ in interface org.apache.maven.doxia.sink.SinktableRows_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TABLEpublic void tableRow()
top.
tableRow in interface org.apache.maven.doxia.sink.SinktableRow in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TRpublic void tableRow_()
tableRow_ in interface org.apache.maven.doxia.sink.SinktableRow_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TRpublic void tableCell()
tableCell in interface org.apache.maven.doxia.sink.SinktableCell in class org.apache.maven.doxia.sink.SinkAdapterpublic void tableHeaderCell()
tableHeaderCell in interface org.apache.maven.doxia.sink.SinktableHeaderCell in class org.apache.maven.doxia.sink.SinkAdapterpublic void tableCell(boolean headerRow)
headerRow - true if it is an header rowHTML.Tag.TH,
HTML.Tag.TDpublic void tableCell_()
tableCell_ in interface org.apache.maven.doxia.sink.SinktableCell_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void tableHeaderCell_()
tableHeaderCell_ in interface org.apache.maven.doxia.sink.SinktableHeaderCell_ in class org.apache.maven.doxia.sink.SinkAdapterpublic void tableCell_(boolean headerRow)
headerRow - true if it is an header rowHTML.Tag.TH,
HTML.Tag.TDpublic void tableCaption()
tableCaption in interface org.apache.maven.doxia.sink.SinktableCaption in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.P,
HTML.Tag.Ipublic void tableCaption_()
tableCaption_ in interface org.apache.maven.doxia.sink.SinktableCaption_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.P,
HTML.Tag.Ipublic void anchor(java.lang.String name)
anchor in interface org.apache.maven.doxia.sink.Sinkanchor in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Apublic void anchor_()
anchor_ in interface org.apache.maven.doxia.sink.Sinkanchor_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Apublic void link(java.lang.String name)
link in interface org.apache.maven.doxia.sink.Sinklink in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Apublic void link_()
link_ in interface org.apache.maven.doxia.sink.Sinklink_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Apublic void italic()
italic in interface org.apache.maven.doxia.sink.Sinkitalic in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Ipublic void italic_()
italic_ in interface org.apache.maven.doxia.sink.Sinkitalic_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Ipublic void bold()
bold in interface org.apache.maven.doxia.sink.Sinkbold in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Bpublic void bold_()
bold_ in interface org.apache.maven.doxia.sink.Sinkbold_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.Bpublic void monospaced()
monospaced in interface org.apache.maven.doxia.sink.Sinkmonospaced in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TTpublic void monospaced_()
monospaced_ in interface org.apache.maven.doxia.sink.Sinkmonospaced_ in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.TTpublic void lineBreak()
lineBreak in interface org.apache.maven.doxia.sink.SinklineBreak in class org.apache.maven.doxia.sink.SinkAdapterHTML.Tag.BRpublic void nonBreakingSpace()
nonBreakingSpace in interface org.apache.maven.doxia.sink.SinknonBreakingSpace in class org.apache.maven.doxia.sink.SinkAdapterpublic void text(java.lang.String text)
text in interface org.apache.maven.doxia.sink.Sinktext in class org.apache.maven.doxia.sink.SinkAdapterprotected void markup(java.lang.String text)
text - The text to write.protected void content(java.lang.String text)
text - The text to write.protected void verbatimContent(java.lang.String text)
text - The text to write.public static java.lang.String escapeHTML(java.lang.String text)
text - the String to escape, may be null
HtmlTools.escapeHTML(String)public static java.lang.String encodeURL(java.lang.String text)
text - the String to encode, may be null.
HtmlTools.encodeURL(String)public void flush()
flush in interface org.apache.maven.doxia.sink.Sinkflush in class org.apache.maven.doxia.sink.SinkAdapterpublic void close()
close in interface org.apache.maven.doxia.sink.Sinkclose in class org.apache.maven.doxia.sink.SinkAdapterprotected void write(java.lang.String text)
write in class org.apache.maven.doxia.sink.AbstractXmlSink
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||