org.apache.maven.doxia.index
Class IndexingSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.AbstractSink
      extended by org.apache.maven.doxia.sink.SinkAdapter
          extended by 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 1090706 2011-04-09 23:15:28Z hboutemy $
Author:
Trygve Laugstøl, Vincent Siveton

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()
          
 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_()
          
 void section2_()
          
 void section3_()
          
 void section4_()
          
 void section5_()
          
 void sectionTitle1_()
          
 void sectionTitle1()
          
 void sectionTitle2_()
          
 void sectionTitle2()
          
 void sectionTitle3_()
          
 void sectionTitle3()
          
 void sectionTitle4_()
          
 void sectionTitle4()
          
 void sectionTitle5_()
          
 void sectionTitle5()
          
 void text(String text)
          
 void title_()
          
 void title()
          
 
Methods inherited from class org.apache.maven.doxia.sink.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, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, 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.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 String getTitle()

Getter for the field title.

Returns:
the title

title

public void title()

Specified by:
title in interface Sink
Overrides:
title in class SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:
sectionTitle1 in interface Sink
Overrides:
sectionTitle1 in class SinkAdapter

title_

public void title_()

Specified by:
title_ in interface Sink
Overrides:
title_ in class SinkAdapter

sectionTitle1_

public void sectionTitle1_()
Description copied from class: SinkAdapter

Specified by:
sectionTitle1_ in interface Sink
Overrides:
sectionTitle1_ in class SinkAdapter

section1_

public void section1_()

Specified by:
section1_ in interface Sink
Overrides:
section1_ in class SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:
sectionTitle2 in interface Sink
Overrides:
sectionTitle2 in class SinkAdapter

sectionTitle2_

public void sectionTitle2_()
Description copied from class: SinkAdapter

Specified by:
sectionTitle2_ in interface Sink
Overrides:
sectionTitle2_ in class SinkAdapter

section2_

public void section2_()

Specified by:
section2_ in interface Sink
Overrides:
section2_ in class SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:
sectionTitle3 in interface Sink
Overrides:
sectionTitle3 in class SinkAdapter

sectionTitle3_

public void sectionTitle3_()
Description copied from class: SinkAdapter

Specified by:
sectionTitle3_ in interface Sink
Overrides:
sectionTitle3_ in class SinkAdapter

section3_

public void section3_()

Specified by:
section3_ in interface Sink
Overrides:
section3_ in class SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:
sectionTitle4 in interface Sink
Overrides:
sectionTitle4 in class SinkAdapter

sectionTitle4_

public void sectionTitle4_()
Description copied from class: SinkAdapter

Specified by:
sectionTitle4_ in interface Sink
Overrides:
sectionTitle4_ in class SinkAdapter

section4_

public void section4_()

Specified by:
section4_ in interface Sink
Overrides:
section4_ in class SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:
sectionTitle5 in interface Sink
Overrides:
sectionTitle5 in class SinkAdapter

sectionTitle5_

public void sectionTitle5_()
Description copied from class: SinkAdapter

Specified by:
sectionTitle5_ in interface Sink
Overrides:
sectionTitle5_ in class SinkAdapter

section5_

public void section5_()

Specified by:
section5_ in interface Sink
Overrides:
section5_ in class SinkAdapter

text

public void text(String text)

Specified by:
text in interface Sink
Overrides:
text in class SinkAdapter

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()

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


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.