|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.sink.AbstractSink org.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 |
---|
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 |
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 |
Constructor Summary | |
---|---|
IndexingSink(IndexEntry sectionEntry)
Default constructor. |
Method Summary | |
---|---|
void |
close()
Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect. |
String |
getTitle()
Getter for the field title . |
protected void |
init()
This is called in Sink.head() or in Sink.close() , and can be used
to set the sink into a clear state so it can be re-used. |
IndexEntry |
peek()
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_()
Ends a first heading element. |
void |
section2_()
Ends a second heading element. |
void |
section3_()
Ends a third heading element. |
void |
section4_()
Ends a 4th heading element. |
void |
section5_()
Ends a 5th heading element. |
void |
sectionTitle1_()
Ends a first title heading element. |
void |
sectionTitle1()
Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element. |
void |
sectionTitle2_()
Ends a second title heading element. |
void |
sectionTitle2()
Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element. |
void |
sectionTitle3_()
Ends a third title heading element. |
void |
sectionTitle3()
Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element. |
void |
sectionTitle4_()
Ends a 4th title heading element. |
void |
sectionTitle4()
Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element. |
void |
sectionTitle5_()
Ends a 5th title heading element. |
void |
sectionTitle5()
Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element. |
void |
text(String text)
Adding a text. |
void |
title_()
Ends the title element. |
void |
title()
Starts the title element. |
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 |
---|
public IndexingSink(IndexEntry sectionEntry)
sectionEntry
- The first index entry.Method Detail |
---|
public String getTitle()
Getter for the field title
.
public void title()
title
in interface Sink
title
in class SinkAdapter
Sink.title(SinkEventAttributes)
public void sectionTitle1()
Sink.section1()
element.
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void sectionTitle1_()
SinkAdapter
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void sectionTitle2()
Sink.section2()
element.
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle2_()
SinkAdapter
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void sectionTitle3()
Sink.section3()
element.
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle3_()
SinkAdapter
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void sectionTitle4()
Sink.section4()
element.
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle4_()
SinkAdapter
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void sectionTitle5()
Sink.section5()
element.
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle5_()
SinkAdapter
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.Sink.text(String,SinkEventAttributes)
public void push(IndexEntry entry)
entry
- to put.public void pop()
public IndexEntry peek()
peek.
public void close()
close
in interface Sink
close
in class SinkAdapter
protected void init()
Sink.head()
or in Sink.close()
, and can be used
to set the sink into a clear state so it can be re-used.
init
in class AbstractSink
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |