org.apache.maven.doxia.module.xdoc
Class XdocParser

java.lang.Object
  org.apache.maven.doxia.parser.AbstractParser
      org.apache.maven.doxia.parser.AbstractXmlParser
          org.apache.maven.doxia.parser.XhtmlBaseParser
              org.apache.maven.doxia.module.xdoc.XdocParser

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, HtmlMarkup, Markup, XmlMarkup, XdocMarkup, Parser

public class XdocParser
extends XhtmlBaseParser
implements XdocMarkup

Parse an xdoc model and emit events into the specified doxia Sink.

Since:

1.0

Version:

$Id: XdocParser.java 1185529 2011-10-18 08:27:44Z ltheussl $

Author:

Jason van Zyl

Plexus component:

role:

"org.apache.maven.doxia.parser.Parser"

role-hint:

"xdoc"

Nested Class Summary

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

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup

AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG, XDOC_NAMESPACE, XDOC_SYSTEM_ID

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

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

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

Constructor Summary

XdocParser()

Method Summary

protected void	consecutiveSections(int newLevel, Sink sink)
protected void	handleEndTag(XmlPullParser parser, Sink sink)
protected void	handleStartTag(XmlPullParser parser, Sink sink)
protected void	init()
void	parse(Reader source, Sink sink)

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

baseEndTag, baseStartTag, getSectionLevel, handleCdsect, handleComment, handleText, 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, isSecondParsing, 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(Reader source,
                  Sink sink)
           throws ParseException

Specified by:

parse in interface Parser

Overrides:

parse in class XhtmlBaseParser

Throws:

ParseException

handleStartTag

protected void handleStartTag(XmlPullParser parser,
                              Sink sink)
                       throws XmlPullParserException,
                              MacroExecutionException

Overrides:

handleStartTag in class XhtmlBaseParser

Throws:

XmlPullParserException

MacroExecutionException

handleEndTag

protected void handleEndTag(XmlPullParser parser,
                            Sink sink)
                     throws XmlPullParserException,
                            MacroExecutionException

Overrides:

handleEndTag in class XhtmlBaseParser

Throws:

XmlPullParserException

MacroExecutionException

consecutiveSections

protected void consecutiveSections(int newLevel,
                                   Sink sink)

Overrides:

consecutiveSections in class XhtmlBaseParser

init

protected void init()

Overrides:

init in class XhtmlBaseParser