Package org.apache.maven.doxia.siterenderer.sink

Class SiteRendererSink

  • All Implemented Interfaces:
    org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, org.apache.maven.doxia.module.xhtml.XhtmlMarkup, org.apache.maven.doxia.sink.Sink, org.codehaus.doxia.sink.Sink
    public class SiteRendererSink
extends org.apache.maven.doxia.module.xhtml.XhtmlSink
implements org.apache.maven.doxia.sink.Sink, org.codehaus.doxia.sink.Sink
    Sink for site rendering of a document, to allow later merge document's output with a template. During raw Doxia rendering, content is stored in multiple fields for later use when incorporating into skin or template: title, date, authors, head, body
    Version:
    $Id: SiteRendererSink.java 1720924 2015-12-19 13:44:56Z hboutemy $
    Author:
    Emmanuel Venisse
    See Also:
    getTitle(), getDate(), getAuthors(), getHead(), getBody()

    • Field Summary

      • Fields inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

        tableAttributes, tableRows

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

        A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR

      • 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.module.xhtml.XhtmlMarkup

        XHTML_NAMESPACE, XHTML_TRANSITIONAL_PUBLIC_ID, XHTML_TRANSITIONAL_SYSTEM_ID

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

        BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

    • Constructor Summary

      Constructors 
      Constructor Description
      SiteRendererSink​(org.apache.maven.doxia.sink.render.RenderingContext renderingContext)
      Construct a new SiteRendererSink for a document.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void anchor​(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void author()
      void author_()
      void body()
      Do nothing.
      void body_()
      Do nothing.
      void date()
      void date_()
      java.util.List<java.lang.String> getAuthors()
      Getter for the field authors.
      java.lang.String getBody()
      getBody.
      java.lang.String getDate()
      Getter for the field date.
      java.lang.String getHead()
      getHead.
      org.apache.maven.doxia.sink.render.RenderingContext getRenderingContext()
      Getter for the field renderingContext.
      java.lang.String getTitle()
      Getter for the field title.
      void head()
      void head_()
      protected void onSectionTitle​(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      protected void onSectionTitle_​(int depth)
      void text​(java.lang.String text)
      void title()
      Reset text buffer, since text content before title mustn't be in title.
      void title_()
      protected void write​(java.lang.String text)

      • Methods inherited from class org.apache.maven.doxia.module.xhtml.XhtmlSink

        isHeadTitleFlag, setHeadTitleFlag

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

        anchor, anchor_, bold, bold_, close, comment, content, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, init, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, onSection, onSection_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetState, resetTextBuffer, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, setCellCount, setCellJustif, setHeadFlag, setVerbatimFlag, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, unknown, verbatim, verbatim, verbatim_, verbatimContent, writeEndTag, writeStartTag

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

        getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

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

        author, body, date, definitionListItem, definitionListItem, definitionListItem_, head, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, title

      • 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

      • Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled

        enableLogging

      • Methods inherited from interface org.apache.maven.doxia.sink.Sink

        anchor, anchor_, author, body, bold, bold_, close, comment, date, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, definitionListItem, definitionListItem, definitionListItem_, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, 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, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, section6, section6_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, 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_

    • Constructor Detail

      • SiteRendererSink

        public SiteRendererSink​(org.apache.maven.doxia.sink.render.RenderingContext renderingContext)
        Construct a new SiteRendererSink for a document.
        Parameters:
        renderingContext - the document's RenderingContext.

    • Method Detail

      • title_

        public void title_()
        Specified by:
        title_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        title_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

      • title

        public void title()
        Reset text buffer, since text content before title mustn't be in title.
        Specified by:
        title in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        title in class org.apache.maven.doxia.module.xhtml.XhtmlSink
        See Also:
        XhtmlSink.title()

      • getTitle

        public java.lang.String getTitle()

        Getter for the field title.

        Returns:
        a String object.

      • 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_()
        Specified by:
        author_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        author_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

      • getAuthors

        public java.util.List<java.lang.String> getAuthors()

        Getter for the field authors.

        Returns:
        a List object.

      • 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_()
        Specified by:
        date_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        date_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

      • getDate

        public java.lang.String getDate()

        Getter for the field date.

        Returns:
        a String object.

      • body_

        public void body_()
        Do nothing.
        Specified by:
        body_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        body_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink
        See Also:
        XhtmlSink.body_()

      • body

        public void body()
        Do nothing.
        Specified by:
        body in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        body in class org.apache.maven.doxia.module.xhtml.XhtmlSink
        See Also:
        XhtmlSink.body()

      • getBody

        public java.lang.String getBody()

        getBody.

        Returns:
        a String object.

      • getHead

        public java.lang.String getHead()

        getHead.

        Returns:
        a String object.
        Since:
        1.1.1

      • head_

        public void head_()
        Specified by:
        head_ in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        head_ in class org.apache.maven.doxia.module.xhtml.XhtmlSink

      • head

        public void head()
        Specified by:
        head in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        head in class org.apache.maven.doxia.module.xhtml.XhtmlSink

      • 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.XhtmlBaseSink

      • onSectionTitle

        protected void onSectionTitle​(int depth,
                              org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Overrides:
        onSectionTitle in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

      • onSectionTitle_

        protected void onSectionTitle_​(int depth)
        Overrides:
        onSectionTitle_ in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink

      • getRenderingContext

        public org.apache.maven.doxia.sink.render.RenderingContext getRenderingContext()

        Getter for the field renderingContext.

        Returns:
        the current rendering context
        Since:
        1.1

      • 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.XhtmlBaseSink

      • write

        protected void write​(java.lang.String text)
        Overrides:
        write in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink