public class IndexingSink extends SinkAdapter
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
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 and Description |
---|
IndexingSink(IndexEntry sectionEntry)
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the writer or the stream, if needed.
|
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 |
pushNewEntry()
Creates and pushes a new IndexEntry onto the top of this stack.
|
void |
section1_()
Ends a first heading element.
|
void |
section1()
Starts a first heading element which contains the topic of the section.
|
void |
section2_()
Ends a second heading element.
|
void |
section2()
Starts a second heading element which contains the topic of the section.
|
void |
section3_()
Ends a third heading element.
|
void |
section3()
Starts a third heading element which contains the topic of the section.
|
void |
section4_()
Ends a 4th heading element.
|
void |
section4()
Starts a 4th heading element which contains the topic of the section.
|
void |
section5_()
Ends a 5th heading element.
|
void |
section5()
Starts a 5th heading element which contains the topic of the section.
|
void |
sectionTitle1_()
Ends a first title heading element.
|
void |
sectionTitle1()
Starts a first title heading element.
|
void |
sectionTitle2_()
Ends a second title heading element.
|
void |
sectionTitle2()
Starts a second title heading element.
|
void |
sectionTitle3_()
Ends a third title heading element.
|
void |
sectionTitle3()
Starts a third title heading element.
|
void |
sectionTitle4_()
Ends a 4th title heading element.
|
void |
sectionTitle4()
Starts a 4th title heading element.
|
void |
sectionTitle5_()
Ends a 5th title heading element.
|
void |
sectionTitle5()
Starts a 5th title heading element.
|
void |
text(String text)
Adding a text.
|
void |
title_()
Ends the title element.
|
void |
title()
Starts the title element.
|
anchor_, anchor, anchor, author_, author, author, body_, body, body, bold_, bold, comment, date_, date, date, definedTerm_, definedTerm, definedTerm, definition_, definition, definition, definitionList_, definitionList, definitionList, definitionListItem_, definitionListItem, definitionListItem, figure_, figure, figure, figureCaption_, figureCaption, figureCaption, figureGraphics, figureGraphics, flush, head_, head, head, horizontalRule, horizontalRule, italic_, italic, lineBreak, lineBreak, link_, link, link, list_, list, list, listItem_, listItem, listItem, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedList, numberedListItem_, numberedListItem, numberedListItem, pageBreak, paragraph_, paragraph, paragraph, rawText, section_, section, section6_, section6, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, sectionTitle6_, sectionTitle6, table_, table, table, tableCaption_, tableCaption, tableCaption, tableCell_, tableCell, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRow, tableRows_, tableRows, text, title, unknown, verbatim_, verbatim, verbatim
enableLogging, getLog, unifyEOLs
public IndexingSink(IndexEntry sectionEntry)
sectionEntry
- The first index entry.public void title()
title
in interface Sink
title
in class SinkAdapter
Sink.title(SinkEventAttributes)
public void section1()
section1
in interface Sink
section1
in class SinkAdapter
Sink.section(int,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_()
Sink
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2()
Sink.section1()
element.section2
in interface Sink
section2
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void sectionTitle2()
Sink.section2()
element.sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle2_()
Sink
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3()
Sink.section2()
element.section3
in interface Sink
section3
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void sectionTitle3()
Sink.section3()
element.sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle3_()
Sink
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4()
Sink.section3()
element.section4
in interface Sink
section4
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void sectionTitle4()
Sink.section4()
element.sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle4_()
Sink
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5()
Sink.section4()
element.section5
in interface Sink
section5
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void sectionTitle5()
Sink.section5()
element.sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle5_()
Sink
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 pushNewEntry()
entry
- to put.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
Copyright © 2005–2017 The Apache Software Foundation. All rights reserved.