Package org.apache.maven.doxia.module.xdoc

Class XdocParser

  • 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, XdocMarkup, org.apache.maven.doxia.parser.Parser
    @Component(role=org.apache.maven.doxia.parser.Parser.class,
           hint="xdoc")
public class XdocParser
extends org.apache.maven.doxia.parser.XhtmlBaseParser
implements XdocMarkup
    Parse an xdoc model and emit events into the specified doxia Sink.
    Since:
    1.0
    Version:
    $Id: XdocParser.java 1726411 2016-01-23 16:34:09Z hboutemy $
    Author:
    Jason van Zyl

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

        org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver

    • Field Summary

      • 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.parser.Parser

        ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

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

        BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

    • Constructor Summary

      Constructors 
      Constructor Description
      XdocParser()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void consecutiveSections​(int newLevel, org.apache.maven.doxia.sink.Sink sink)
      protected void handleEndTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
      protected void handleStartTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
      protected void init()
      void parse​(java.io.Reader source, org.apache.maven.doxia.sink.Sink sink)

      • Methods inherited from class org.apache.maven.doxia.parser.XhtmlBaseParser

        baseEndTag, baseStartTag, getSectionLevel, handleCdsect, handleComment, handleText, initXmlParser, isScriptBlock, isVerbatim, setSectionLevel, validAnchor, verbatim, verbatim_

      • Methods inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

        getAttributesFromParser, getLocalEntities, getText, getType, handleEntity, handleUnknown, isCollapsibleWhitespace, isIgnorableWhitespace, isTrimmableWhitespace, isValidate, parse, setCollapsibleWhitespace, setIgnorableWhitespace, setTrimmableWhitespace, setValidate

      • Methods inherited from class org.apache.maven.doxia.parser.AbstractParser

        doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isEmitComments, isSecondParsing, parse, setEmitComments, setSecondParsing

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • XdocParser

        public XdocParser()

    • Method Detail

      • parse

        public void parse​(java.io.Reader source,
                  org.apache.maven.doxia.sink.Sink sink)
           throws org.apache.maven.doxia.parser.ParseException
        Specified by:
        parse in interface org.apache.maven.doxia.parser.Parser
        Overrides:
        parse in class org.apache.maven.doxia.parser.XhtmlBaseParser
        Throws:
        org.apache.maven.doxia.parser.ParseException

      • handleStartTag

        protected void handleStartTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                              org.apache.maven.doxia.sink.Sink sink)
                       throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                              org.apache.maven.doxia.macro.MacroExecutionException
        Overrides:
        handleStartTag in class org.apache.maven.doxia.parser.XhtmlBaseParser
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        org.apache.maven.doxia.macro.MacroExecutionException

      • handleEndTag

        protected void handleEndTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                            org.apache.maven.doxia.sink.Sink sink)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                            org.apache.maven.doxia.macro.MacroExecutionException
        Overrides:
        handleEndTag in class org.apache.maven.doxia.parser.XhtmlBaseParser
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException
        org.apache.maven.doxia.macro.MacroExecutionException

      • consecutiveSections

        protected void consecutiveSections​(int newLevel,
                                   org.apache.maven.doxia.sink.Sink sink)
        Overrides:
        consecutiveSections in class org.apache.maven.doxia.parser.XhtmlBaseParser

      • init

        protected void init()
        Overrides:
        init in class org.apache.maven.doxia.parser.XhtmlBaseParser