Class AptSink

  • All Implemented Interfaces:
    org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, AptMarkup, org.apache.maven.doxia.sink.Sink

    public class AptSink
    extends org.apache.maven.doxia.sink.impl.AbstractTextSink
    implements AptMarkup
    APT generator implementation.
    Note: The encoding used is UTF-8.
    Since:
    1.0
    Author:
    eredmond
    • Field Detail

      • inlineStack

        protected java.util.Stack<java.util.List<java.lang.String>> inlineStack
        Keep track of the closing tags for inline events.
    • Constructor Detail

      • AptSink

        protected AptSink​(java.io.Writer writer)
        Constructor, initialize the Writer and the variables.
        Parameters:
        writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.
    • Method Detail

      • getBuffer

        protected java.lang.StringBuffer getBuffer()
        Returns the buffer that holds the current text.
        Returns:
        A StringBuffer.
      • setHeadFlag

        protected void setHeadFlag​(boolean headFlag)
        Used to determine whether we are in head mode.
        Parameters:
        headFlag - True for head mode.
      • resetState

        protected void resetState()
        Deprecated.
        since 1.1.2, use init() instead of.
        Reset all variables.
      • init

        protected void init()
        Overrides:
        init in class org.apache.maven.doxia.sink.impl.AbstractSink
      • resetBuffer

        protected void resetBuffer()
        Reset the StringBuilder.
      • resetTableCaptionBuffer

        protected void resetTableCaptionBuffer()
        Reset the TableCaptionBuffer.
      • head

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public void numberedList​(int numbering)
        Specified by:
        numberedList in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • numberedList_

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

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

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

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

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

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

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

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

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

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

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

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

        public void verbatim​(boolean boxed)
        Specified by:
        verbatim in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • verbatim_

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

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

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

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

        public void tableRows​(int[] justification,
                              boolean grid)
        Specified by:
        tableRows in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • tableRows_

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

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

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

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

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

        public void tableCell​(boolean headerRow)
        Starts a table cell.
        Parameters:
        headerRow - If this cell is part of a header row.
      • tableCell_

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

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

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

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

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

        public void figureGraphics​(java.lang.String name)
        Specified by:
        figureGraphics in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • anchor

        public void anchor​(java.lang.String name)
        Specified by:
        anchor in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • anchor_

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

        public void link​(java.lang.String name)
        Specified by:
        link in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        link in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • link_

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

        public void link​(java.lang.String name,
                         java.lang.String target)
        A link with a target.
        Parameters:
        name - The name of the link.
        target - The link target.
      • inline

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

        public void inline​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        inline in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        inline in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • inline_

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

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

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

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

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

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

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

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

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

        public void text​(java.lang.String text)
        Specified by:
        text in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        text in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • rawText

        public void rawText​(java.lang.String text)
        Specified by:
        rawText in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        rawText in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • comment

        public void comment​(java.lang.String comment)
        Specified by:
        comment in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        comment in class org.apache.maven.doxia.sink.impl.SinkAdapter
      • unknown

        public void unknown​(java.lang.String name,
                            java.lang.Object[] requiredParams,
                            org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Unkown events just log a warning message but are ignored otherwise.
        Specified by:
        unknown in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter
        See Also:
        Sink.unknown(String,Object[],SinkEventAttributes)
      • write

        protected void write​(java.lang.String text)
        Write text to output.
        Parameters:
        text - The text to write.
      • content

        protected void content​(java.lang.String text)
        Write Apt escaped text to output.
        Parameters:
        text - The text to write.
      • verbatimContent

        protected void verbatimContent​(java.lang.String text)
        Write Apt escaped text to output.
        Parameters:
        text - The text to write.
      • flush

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

        public void close()
        Specified by:
        close in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        close in class org.apache.maven.doxia.sink.impl.SinkAdapter