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

Class SiteRendererSink

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, org.apache.maven.doxia.module.xhtml5.Xhtml5Markup, org.apache.maven.doxia.sink.Sink, DocumentContent
    public class SiteRendererSink
extends org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
implements DocumentContent
    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
    Author:
    Emmanuel Venisse

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

        org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode

    • Field Summary

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

        contentStack, inlineStack, tableAttributes

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

        A, ABBR, ADDRESS, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BDI, BDO, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FOOTER, FORM, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, MENUITEM, META, METER, NAV, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRONG, STYLE, SUB, SUMMARY, SUP, SVG, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, U, UL, VAR, VIDEO, WBR

      • 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_DEFAULT, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, 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.xhtml5.Xhtml5Markup

        XHTML5_NAMESPACE

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

        BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void author​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void author_()
      void body​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Do nothing.
      void body_()
      Do nothing.
      void date​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void date_()
      java.util.List<java.lang.String> getAuthors()
      Get the authors of the document.
      java.lang.String getBody()
      Get the html body of the document.
      java.lang.String getDate()
      Get the date of the document.
      java.lang.String getHead()
      Get the html head of the document.
      DocumentRenderingContext getRenderingContext()
      Get the document rendering context.
      java.lang.String getTitle()
      Get the title of the document.
      void head​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void head_()
      void inline​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)  
      void inline_()  
      void title​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      Reset text buffer, since text content before title must not be in title.
      void title_()
      void verbatim​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)  
      void verbatim_()  
      protected void write​(java.lang.String text)

      • Methods inherited from class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink

        isHeadTitleFlag, setHeadTitleFlag

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

        address, address_, anchor, anchor_, article, article_, blockquote, blockquote_, bold, bold_, close, comment, content, content, content_, convertAndFilterAttributes, convertToHtml5CompliantAttributes, data, data_, definedTerm, definedTerm_, definition, definition_, definitionList, definitionList_, division, division_, encodeAsHtmlComment, encodeURL, escapeHTML, figure, figure_, figureCaption, figureCaption_, figureGraphics, flush, footer, footer_, getCellCount, getCellJustif, getTextBuffer, getVerbatimMode, header, header_, horizontalRule, init, isHeadFlag, isVerbatim, italic, italic_, lineBreak, lineBreakOpportunity, link, link_, list, list_, listItem, listItem_, markupLineBreak, monospaced, monospaced_, navigation, navigation_, nonBreakingSpace, numberedList, numberedList_, numberedListItem, numberedListItem_, onSection, onSection_, onSectionTitle, onSectionTitle_, pageBreak, paragraph, paragraph_, rawText, resetTextBuffer, section, section_, sectionTitle, sectionTitle_, setCellCount, setCellJustif, setHeadFlag, setVerbatimMode, sidebar, sidebar_, table, table_, tableCaption, tableCaption_, tableCell, tableCell_, tableHeaderCell, tableHeaderCell_, tableRow, tableRow_, tableRows, tableRows_, text, time, time_, unknown, 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

        definitionListItem, definitionListItem_

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

        address, anchor, article, author, blockquote, body, content, data, date, definedTerm, definition, definitionList, definitionListItem, division, figure, figureCaption, figureGraphics, footer, formatLocation, getDocumentLocator, getLocationLogPrefix, head, header, horizontalRule, inline, lineBreak, lineBreakOpportunity, link, list, listItem, navigation, numberedList, numberedListItem, paragraph, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle6, sectionTitle6_, setDocumentLocator, sidebar, table, tableCaption, tableCell, tableHeaderCell, tableRow, tableRows, text, time, title, unifyEOLs, verbatim

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SiteRendererSink

        public SiteRendererSink​(DocumentRenderingContext docRenderingContext)
        Construct a new SiteRendererSink for a document.
        Parameters:
        docRenderingContext - the document's rendering context.

      • SiteRendererSink

        public SiteRendererSink​(DocumentRenderingContext docRenderingContext,
                        org.apache.maven.doxia.site.MermaidConfiguration mermaid)

    • 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.xhtml5.Xhtml5Sink

      • title

        public void title​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Reset text buffer, since text content before title must not be in title.
        Specified by:
        title in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        title in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
        See Also:
        AbstractSink.title()

      • 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.module.xhtml5.Xhtml5Sink

      • 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.module.xhtml5.Xhtml5Sink

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

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

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

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

      • 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.xhtml5.Xhtml5Sink
        See Also:
        Xhtml5Sink.body_()

      • body

        public void body​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
        Do nothing.
        Specified by:
        body in interface org.apache.maven.doxia.sink.Sink
        Overrides:
        body in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
        See Also:
        AbstractSink.body()

      • head_

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

      • 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.module.xhtml5.Xhtml5Sink

      • write

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

      • getTitle

        public java.lang.String getTitle()
        Get the title of the document.
        Specified by:
        getTitle in interface DocumentContent
        Returns:
        the document title

      • getAuthors

        public java.util.List<java.lang.String> getAuthors()
        Get the authors of the document.
        Specified by:
        getAuthors in interface DocumentContent
        Returns:
        the document authors

      • getDate

        public java.lang.String getDate()
        Get the date of the document.
        Specified by:
        getDate in interface DocumentContent
        Returns:
        the document date

      • getBody

        public java.lang.String getBody()
        Get the html body of the document.
        Specified by:
        getBody in interface DocumentContent
        Returns:
        the document body head

      • getHead

        public java.lang.String getHead()
        Get the html head of the document.
        Specified by:
        getHead in interface DocumentContent
        Returns:
        the document html head