Class IndexingSink

All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, Markup, org.apache.maven.doxia.sink.Sink

public class IndexingSink extends SinkAdapter
A sink implementation for index.
Author:
Trygve Laugstøl, Vincent Siveton
  • Constructor Details

    • IndexingSink

      public IndexingSink(IndexEntry sectionEntry)
      Default constructor.
      Parameters:
      sectionEntry - The first index entry.
  • Method Details

    • getTitle

      public String getTitle()

      Getter for the field title.

      Returns:
      the title
    • title

      public void title()
      Specified by:
      title in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title in class SinkAdapter
    • section1

      public void section1()
      Specified by:
      section1 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section1 in class SinkAdapter
    • sectionTitle1

      public void sectionTitle1()
      Specified by:
      sectionTitle1 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle1 in class SinkAdapter
    • title_

      public void title_()
      Specified by:
      title_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      title_ in class SinkAdapter
    • sectionTitle1_

      public void sectionTitle1_()

      sectionTitle1_.

      Specified by:
      sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle1_ in class SinkAdapter
    • section1_

      public void section1_()
      Specified by:
      section1_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section1_ in class SinkAdapter
    • section2

      public void section2()
      Specified by:
      section2 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section2 in class SinkAdapter
    • sectionTitle2

      public void sectionTitle2()
      Specified by:
      sectionTitle2 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle2 in class SinkAdapter
    • sectionTitle2_

      public void sectionTitle2_()

      sectionTitle2_.

      Specified by:
      sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle2_ in class SinkAdapter
    • section2_

      public void section2_()
      Specified by:
      section2_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section2_ in class SinkAdapter
    • section3

      public void section3()
      Specified by:
      section3 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section3 in class SinkAdapter
    • sectionTitle3

      public void sectionTitle3()
      Specified by:
      sectionTitle3 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle3 in class SinkAdapter
    • sectionTitle3_

      public void sectionTitle3_()

      sectionTitle3_.

      Specified by:
      sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle3_ in class SinkAdapter
    • section3_

      public void section3_()
      Specified by:
      section3_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section3_ in class SinkAdapter
    • section4

      public void section4()
      Specified by:
      section4 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section4 in class SinkAdapter
    • sectionTitle4

      public void sectionTitle4()
      Specified by:
      sectionTitle4 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle4 in class SinkAdapter
    • sectionTitle4_

      public void sectionTitle4_()

      sectionTitle4_.

      Specified by:
      sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle4_ in class SinkAdapter
    • section4_

      public void section4_()
      Specified by:
      section4_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section4_ in class SinkAdapter
    • section5

      public void section5()
      Specified by:
      section5 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section5 in class SinkAdapter
    • sectionTitle5

      public void sectionTitle5()
      Specified by:
      sectionTitle5 in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle5 in class SinkAdapter
    • sectionTitle5_

      public void sectionTitle5_()

      sectionTitle5_.

      Specified by:
      sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      sectionTitle5_ in class SinkAdapter
    • section5_

      public void section5_()
      Specified by:
      section5_ in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      section5_ in class SinkAdapter
    • text

      public void text(String text)
      Specified by:
      text in interface org.apache.maven.doxia.sink.Sink
      Overrides:
      text in class SinkAdapter
    • pushNewEntry

      public void pushNewEntry()
      Creates and pushes a new IndexEntry onto the top of this stack.
    • 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 org.apache.maven.doxia.sink.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