Package org.apache.maven.doxia.module.latex

Class LatexSink

  • All Implemented Interfaces:
    org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, org.apache.maven.doxia.sink.Sink
    public class LatexSink
extends org.apache.maven.doxia.sink.impl.AbstractTextSink
    Latex Sink implementation.
    Note: The encoding used is UTF-8.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Stack<java.util.List<java.lang.String>> inlineStack
      Keep track of the closing tags for inline events.

      • 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

      • Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

        PIPE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected LatexSink​(java.io.Writer out)
      Constructor, initialize the Writer and the variables.
      protected LatexSink​(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble)
      Constructor, initialize the Writer and the variables.
      protected LatexSink​(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble, boolean fragmentDocument)
      Constructor, initialize the Writer and the variables.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void anchor​(java.lang.String name)
      void anchor​(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void anchor_()
      void author()
      void author​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void author_()
      void body()
      void body​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void body_()
      void bold()
      void bold_()
      void close()
      void comment​(java.lang.String comment)
      protected void content​(java.lang.String text)
      Writes the text, without preserving whitespace.
      void date()
      void date​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void date_()
      protected java.lang.String defaultPreamble()
      Returns the default preamble.
      protected java.lang.String defaultSinkCommands()
      Returns the default sink commands.
      void definedTerm()
      void definedTerm​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void definedTerm_()
      void definition()
      void definition​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void definition_()
      void definitionList()
      void definitionList​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void definitionList_()
      void definitionListItem()
      void definitionListItem​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void definitionListItem_()
      static java.lang.String escaped​(java.lang.String text)
      Escapes special characters.
      void figure()
      void figure​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void figure_()
      void figureCaption()
      void figureCaption​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void figureCaption_()
      void figureGraphics​(java.lang.String name)
      void figureGraphics​(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void flush()
      protected java.lang.String getDocumentBegin()
      Returns a default \begin{document} declaration.
      protected java.lang.String getDocumentEnd()
      Returns a default \end{document} declaration.
      protected java.lang.String getDocumentStart()
      Returns a default \documentclass declaration.
      void head()
      void head​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void horizontalRule()
      void horizontalRule​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      protected void init()
      void inline()
      void inline​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void inline_()
      void italic()
      void italic_()
      void lineBreak()
      void lineBreak​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void link​(java.lang.String name)
      void link​(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void link_()
      void list()
      void list​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void list_()
      void listItem()
      void listItem​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      protected void markup​(java.lang.String text)
      Writes the text, preserving whitespace.
      void monospaced()
      void monospaced_()
      void nonBreakingSpace()
      void numberedList​(int numbering)
      void numberedList​(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void numberedList_()
      void numberedListItem()
      void numberedListItem​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void pageBreak()
      void paragraph()
      void paragraph​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void paragraph_()
      void rawText​(java.lang.String text)
      void sectionTitle​(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void sectionTitle_​(int level)
      void sectionTitle1()
      void sectionTitle1_()
      void sectionTitle2()
      void sectionTitle2_()
      void sectionTitle3()
      void sectionTitle3_()
      void sectionTitle4()
      void sectionTitle4_()
      void sectionTitle5()
      void sectionTitle5_()
      void table()
      void table​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void table_()
      void tableCaption()
      void tableCaption​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void tableCaption_()
      void tableCell()
      void tableCell​(java.lang.String width)
      void tableCell​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void tableCell_()
      void tableHeaderCell()
      void tableHeaderCell​(java.lang.String width)
      void tableHeaderCell​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void tableHeaderCell_()
      void tableRow()
      void tableRow​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void tableRow_()
      void tableRows​(int[] justification, boolean grid)
      void tableRows_()
      void text​(java.lang.String text)
      void text​(java.lang.String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void title()
      void title​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void title_()
      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.
      void verbatim​(boolean boxed)
      void verbatim​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void verbatim_()
      protected void verbatimContent​(java.lang.String text)
      Writes the text, preserving whitespace.

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

        address, address, address_, article, article, article_, blockquote, blockquote, blockquote_, content, content, content_, data, data, data_, division, division, division_, footer, footer, footer_, head_, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, listItem_, navigation, navigation, navigation_, numberedListItem_, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_

      • 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

    • 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

      • LatexSink

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

      • LatexSink

        protected LatexSink​(java.io.Writer out,
                    java.lang.String sinkCommands,
                    java.lang.String preamble)
        Constructor, initialize the Writer and the variables.
        Parameters:
        out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.
        sinkCommands - A String representation of commands that go before \documentclass.
        preamble - A String representation of commands that go between \documentclass and \begin{document}.

      • LatexSink

        protected LatexSink​(java.io.Writer out,
                    java.lang.String sinkCommands,
                    java.lang.String preamble,
                    boolean fragmentDocument)
        Constructor, initialize the Writer and the variables.
        Parameters:
        out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.
        sinkCommands - A String representation of commands that go before \documentclass.
        preamble - A String representation of commands that go between \documentclass and \begin{document}.
        fragmentDocument - If this receives events that that are only part of a document. Typically, headers are omitted if this is true.

    • Method Detail

      • getDocumentStart

        protected java.lang.String getDocumentStart()
        Returns a default \documentclass declaration.
        Returns:
        String.

      • getDocumentBegin

        protected java.lang.String getDocumentBegin()
        Returns a default \begin{document} declaration.
        Returns:
        String.

      • getDocumentEnd

        protected java.lang.String getDocumentEnd()
        Returns a default \end{document} declaration.
        Returns:
        String.

      • 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        head in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        head in class org.apache.maven.doxia.sink.impl.SinkAdapter

      • body

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

      • body

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

      • body_

        public void body_()
        Specified by:
        body_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        body_ 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

      • title

        public void title​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        title in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        title 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

      • author

        public void author​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        author in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        author 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

      • date

        public void date​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        date in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        date 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

      • sectionTitle

        public void sectionTitle​(int level,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        sectionTitle in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter

      • sectionTitle_

        public void sectionTitle_​(int level)
        Specified by:
        sectionTitle_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        sectionTitle_ 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(int numbering,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • definitionListItem

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

      • definitionListItem

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

      • definitionListItem_

        public void definitionListItem_()
        Specified by:
        definitionListItem_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        definitionListItem_ 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • figure

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

      • figure

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

      • figure_

        public void figure_()
        Specified by:
        figure_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        figure_ 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

      • figureGraphics

        public void figureGraphics​(java.lang.String src,
                           org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        figureGraphics in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        figureGraphics 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

      • figureCaption

        public void figureCaption​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        figureCaption in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        figureCaption 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

      • 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • tableCell

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

      • tableCell

        public void tableCell​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        tableCell in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        tableCell 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

      • tableHeaderCell

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

      • tableHeaderCell

        public void tableHeaderCell​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        tableHeaderCell 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • 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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        verbatim in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
        Parameters:
        attributes - a SinkEventAttributes object.

      • 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

      • horizontalRule

        public void horizontalRule​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Specified by:
        horizontalRule in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        horizontalRule 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

      • 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​(java.lang.String name,
                   org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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​(java.lang.String name,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • 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

      • lineBreak

        public void lineBreak​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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

      • text

        public void text​(java.lang.String text,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        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)

      • markup

        protected void markup​(java.lang.String text)
        Writes the text, preserving whitespace.
        Parameters:
        text - the text to write.

      • content

        protected void content​(java.lang.String text)
        Writes the text, without preserving whitespace.
        Parameters:
        text - the text to write.

      • verbatimContent

        protected void verbatimContent​(java.lang.String text)
        Writes the text, preserving whitespace.
        Parameters:
        text - the text to write.

      • escaped

        public static java.lang.String escaped​(java.lang.String text)
        Escapes special characters.
        Parameters:
        text - The text to escape.
        Returns:
        The text with special characters replaced.

      • 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

      • defaultSinkCommands

        protected java.lang.String defaultSinkCommands()
        Returns the default sink commands.
        Returns:
        String.

      • defaultPreamble

        protected java.lang.String defaultPreamble()
        Returns the default preamble.
        Returns:
        String.

      • init

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