java.lang.Object
- org.apache.maven.doxia.sink.impl.AbstractSink
- - org.apache.maven.doxia.sink.impl.SinkAdapter
  - - org.apache.maven.doxia.index.IndexingSink

All Implemented Interfaces:

LogEnabled, Markup, Sink
```
public class IndexingSink
extends SinkAdapter
```
A sink implementation for index.

Version:

$Id: IndexingSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

Trygve Laugstøl, Vincent Siveton

Field Summary
- 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, SECTION_LEVEL_6

Constructor Summary

Constructors
Constructor Description

IndexingSink(IndexEntry sectionEntry)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the writer or the stream, if needed.
`java.lang.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()`	Starts a first title heading element.
`void`	`sectionTitle1_()`	Ends a first title heading element.
`void`	`sectionTitle2()`	Starts a second title heading element.
`void`	`sectionTitle2_()`	Ends a second title heading element.
`void`	`sectionTitle3()`	Starts a third title heading element.
`void`	`sectionTitle3_()`	Ends a third title heading element.
`void`	`sectionTitle4()`	Starts a 4th title heading element.
`void`	`sectionTitle4_()`	Ends a 4th title heading element.
`void`	`sectionTitle5()`	Starts a 5th title heading element.
`void`	`sectionTitle5_()`	Ends a 5th title heading element.
`void`	`text(java.lang.String text)`	Adding a text.
`void`	`title()`	Starts the title element.
`void`	`title_()`	Ends the title element.

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
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_, section1, section2, section3, section4, section5, 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_

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IndexingSink
```
public IndexingSink(IndexEntry sectionEntry)
```
    Default constructor.
    
    Parameters:
    
    sectionEntry - The first index entry.
- Method Detail
  - getTitle
```
public java.lang.String getTitle()
```
    Getter for the field title.
    
    Returns:
    
    the title
  - title
```
public void title()
```
    Starts the title element.
    
    Specified by:
    
    title in interface Sink
    
    Overrides:
    
    title in class SinkAdapter
    
    See Also:
    
    Sink.title(SinkEventAttributes)
  - sectionTitle1
```
public 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.
    
    Specified by:
    
    sectionTitle1 in interface Sink
    
    Overrides:
    
    sectionTitle1 in class SinkAdapter
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - title_
```
public void title_()
```
    Ends the title element.
    
    Specified by:
    
    title_ in interface Sink
    
    Overrides:
    
    title_ in class SinkAdapter
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Description copied from interface: Sink
    
    Ends a first title heading element.
    
    Specified by:
    
    sectionTitle1_ in interface Sink
    
    Overrides:
    
    sectionTitle1_ in class SinkAdapter
  - section1_
```
public void section1_()
```
    Ends a first heading element.
    
    Specified by:
    
    section1_ in interface Sink
    
    Overrides:
    
    section1_ in class SinkAdapter
  - sectionTitle2
```
public 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.
    
    Specified by:
    
    sectionTitle2 in interface Sink
    
    Overrides:
    
    sectionTitle2 in class SinkAdapter
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Description copied from interface: Sink
    
    Ends a second title heading element.
    
    Specified by:
    
    sectionTitle2_ in interface Sink
    
    Overrides:
    
    sectionTitle2_ in class SinkAdapter
  - section2_
```
public void section2_()
```
    Ends a second heading element.
    
    Specified by:
    
    section2_ in interface Sink
    
    Overrides:
    
    section2_ in class SinkAdapter
  - sectionTitle3
```
public 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.
    
    Specified by:
    
    sectionTitle3 in interface Sink
    
    Overrides:
    
    sectionTitle3 in class SinkAdapter
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Description copied from interface: Sink
    
    Ends a third title heading element.
    
    Specified by:
    
    sectionTitle3_ in interface Sink
    
    Overrides:
    
    sectionTitle3_ in class SinkAdapter
  - section3_
```
public void section3_()
```
    Ends a third heading element.
    
    Specified by:
    
    section3_ in interface Sink
    
    Overrides:
    
    section3_ in class SinkAdapter
  - sectionTitle4
```
public 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.
    
    Specified by:
    
    sectionTitle4 in interface Sink
    
    Overrides:
    
    sectionTitle4 in class SinkAdapter
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Description copied from interface: Sink
    
    Ends a 4th title heading element.
    
    Specified by:
    
    sectionTitle4_ in interface Sink
    
    Overrides:
    
    sectionTitle4_ in class SinkAdapter
  - section4_
```
public void section4_()
```
    Ends a 4th heading element.
    
    Specified by:
    
    section4_ in interface Sink
    
    Overrides:
    
    section4_ in class SinkAdapter
  - sectionTitle5
```
public 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.
    
    Specified by:
    
    sectionTitle5 in interface Sink
    
    Overrides:
    
    sectionTitle5 in class SinkAdapter
    
    See Also:
    
    Sink.sectionTitle(int,SinkEventAttributes)
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Description copied from interface: Sink
    
    Ends a 5th title heading element.
    
    Specified by:
    
    sectionTitle5_ in interface Sink
    
    Overrides:
    
    sectionTitle5_ in class SinkAdapter
  - section5_
```
public void section5_()
```
    Ends a 5th heading element.
    
    Specified by:
    
    section5_ in interface Sink
    
    Overrides:
    
    section5_ in class SinkAdapter
  - text
```
public void text(java.lang.String text)
```
    Adding a text.
    
    Specified by:
    
    text in interface Sink
    
    Overrides:
    
    text in class SinkAdapter
    
    Parameters:
    
    text - The text to write.
    
    See Also:
    
    Sink.text(String,SinkEventAttributes)
  - push
```
public void push(IndexEntry entry)
```
    Pushes an IndexEntry onto the top of this stack.
    
    Parameters:
    
    entry - to put.
  - pop
```
public void pop()
```
    Removes the IndexEntry at the top of this stack.
  - peek
```
public IndexEntry peek()
```
    peek.
    
    Returns:
    
    Looks at the IndexEntry at the top of this stack.
  - close
```
public void close()
```
    Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
    
    Specified by:
    
    close in interface Sink
    
    Overrides:
    
    close in class SinkAdapter
  - init
```
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.
    
    Overrides:
    
    init in class AbstractSink

Class IndexingSink

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.Markup

Fields inherited from interface org.apache.maven.doxia.sink.Sink

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

Methods inherited from class java.lang.Object

Constructor Detail

IndexingSink

Method Detail

getTitle

title

sectionTitle1

title_

sectionTitle1_

section1_

sectionTitle2

sectionTitle2_

section2_

sectionTitle3

sectionTitle3_

section3_

sectionTitle4

sectionTitle4_

section4_

sectionTitle5

sectionTitle5_

section5_

text

push

pop

peek

close

init