|
||||||||||
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.index.IndexingSink
public class IndexingSink
A sink implementation for index
Field Summary |
---|
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 | |
---|---|
IndexingSink(IndexEntry sectionEntry)
Default constructor. |
Method Summary | |
---|---|
String |
getTitle()
|
IndexEntry |
peek()
|
void |
pop()
Removes the IndexEntry at the top of this stack |
void |
push(IndexEntry entry)
Pushes an IndexEntry onto the top of this stack |
void |
section1_()
Ending a first heading element. |
void |
section2_()
Ending a second heading element. |
void |
section3_()
Ending a third heading element. |
void |
section4_()
Ending a 4th heading element. |
void |
section5_()
Ending a 5th heading element. |
void |
sectionTitle1()
Starting a first title heading element. |
void |
sectionTitle2()
Starting a second title heading element. |
void |
sectionTitle3()
Starting a third title heading element. |
void |
sectionTitle4()
Starting a 4th title heading element. |
void |
sectionTitle5()
Starting a 5th title heading element. |
void |
text(String text)
Adding a text. |
void |
title()
Starting the title element which is used to identify the document. |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
anchor_, anchor, author_, author, body_, body, bold_, bold, close, date_, date, definedTerm_, definedTerm, definition_, definition, definitionList_, definitionList, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, flush, head_, head, horizontalRule, italic_, italic, lineBreak, link_, link, list_, list, listItem_, listItem, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedListItem_, numberedListItem, pageBreak, paragraph_, paragraph, rawText, section1, section2, section3, section4, section5, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle2_, sectionTitle3_, sectionTitle4_, sectionTitle5_, table_, table, tableCaption_, tableCaption, tableCell_, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRows_, tableRows, title_, verbatim_, verbatim |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndexingSink(IndexEntry sectionEntry)
sectionEntry
- The first index entry.Method Detail |
---|
public String getTitle()
public void title()
title
in interface Sink
title
in class SinkAdapter
public void sectionTitle1()
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void sectionTitle2()
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void sectionTitle3()
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void sectionTitle4()
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void sectionTitle5()
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
public void section5_()
section5_
in interface Sink
section5_
in class SinkAdapter
public void text(String text)
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.public void push(IndexEntry entry)
entry
- to putpublic void pop()
public IndexEntry peek()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |