Package org.apache.maven.doxia.module.xhtml5

Class Xhtml5Sink

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, Xhtml5Markup, org.apache.maven.doxia.sink.Sink
    public class Xhtml5Sink
extends org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
implements Xhtml5Markup
    XHTML 5.2 sink implementation.

    • 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.markup.XmlMarkup

        BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Xhtml5Sink​(java.io.Writer writer)
      Constructor, initialize the Writer.
      protected Xhtml5Sink​(java.io.Writer writer, java.lang.String encoding)
      Constructor, initialize the Writer and tells which encoding is used.
      protected Xhtml5Sink​(java.io.Writer writer, java.lang.String encoding, java.lang.String languageId)
      Constructor, initialize the Writer and tells which encoding and languageId are used.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void author_()
      void body​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void body_()
      void date_()
      void head​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)  
      void head_()
      protected boolean isHeadTitleFlag()
      isHeadTitleFlag.
      protected void setHeadTitleFlag​(boolean headTitleFlag)
      Setter for the field headTitleFlag.
      void title​(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
      void title_()

      • 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, inline, inline_, 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, verbatim, verbatim_, verbatimContent, write, 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, date, 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

      • Xhtml5Sink

        protected Xhtml5Sink​(java.io.Writer writer)
        Constructor, initialize the Writer.
        Parameters:
        writer - not null writer to write the result.

      • Xhtml5Sink

        protected Xhtml5Sink​(java.io.Writer writer,
                     java.lang.String encoding)
        Constructor, initialize the Writer and tells which encoding is used.
        Parameters:
        writer - not null writer to write the result.
        encoding - the encoding used, that should be written to the generated HTML content if not null.

      • Xhtml5Sink

        protected Xhtml5Sink​(java.io.Writer writer,
                     java.lang.String encoding,
                     java.lang.String languageId)
        Constructor, initialize the Writer and tells which encoding and languageId are used.
        Parameters:
        writer - not null writer to write the result.
        encoding - the encoding used, that should be written to the generated HTML content if not null.
        languageId - language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.

    • Method Detail

      • 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

      • 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​(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
        See Also:
        HTML.Tag.TITLE

      • 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
        See Also:
        HTML.Tag.TITLE

      • 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
        See Also:
        HTML.Tag.META

      • 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
        See Also:
        HTML.Tag.META

      • 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
        See Also:
        HTML.Tag.BODY

      • 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
        See Also:
        HTML.Tag.BODY, HTML.Tag.HTML

      • setHeadTitleFlag

        protected void setHeadTitleFlag​(boolean headTitleFlag)

        Setter for the field headTitleFlag.

        Parameters:
        headTitleFlag - an header title flag.
        Since:
        1.1

      • isHeadTitleFlag

        protected boolean isHeadTitleFlag()

        isHeadTitleFlag.

        Returns:
        the current headTitleFlag.
        Since:
        1.1