Class Xhtml5Parser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

org.apache.maven.doxia.parser.AbstractXmlParser

org.apache.maven.doxia.parser.Xhtml5BaseParser

org.apache.maven.doxia.module.xhtml5.Xhtml5Parser

All Implemented Interfaces:

HtmlMarkup, Markup, XmlMarkup, Xhtml5Markup, Parser

Direct Known Subclasses:

MarkdownParser.MarkdownHtmlParser

@Singleton
@Named("xhtml")
public class Xhtml5Parser
extends Xhtml5BaseParser
implements Xhtml5Markup

Parse an xhtml5 model and emit events into a Doxia Sink.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isEmptyElement	Empty elements don't write a closing tag.
private static final org.slf4j.Logger	LOGGER
protected boolean	source	For verbatim source.
private String	sourceContent	The source content of the input reader.

Fields inherited from interface 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 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 Parser

TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Fields inherited from interface Xhtml5Markup

XHTML5_NAMESPACE

Fields inherited from interface XmlMarkup

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Xhtml5Parser()

Method Summary

Modifier and Type	Method	Description
private String	escapeForMacro(String s)	escapeForMacro
protected void	handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Handles comments.
protected void	handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Goes through the possible end tags.
protected void	handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Goes through the possible start tags.
protected void	init()	Initialize the parser.
void	parse(Reader source, Sink sink, String reference)	Parses the given source model and emits Doxia events into the given sink.
private void	processMacro(String text, Sink sink)	process macro embedded in XHTML commment
private String	unescapeForMacro(String s)	unescapeForMacro

Methods inherited from class Xhtml5BaseParser

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

Methods inherited from class AbstractXmlParser

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

Methods inherited from class AbstractParser

addSinkWrapperFactory, doxiaVersion, executeMacro, getBasedir, getMacroManager, getSinkWrapperFactories, getWrappedSink, isEmitAnchorsForIndexableEntries, isEmitComments, isSecondParsing, parse, parse, parse, setEmitAnchorsForIndexableEntries, setEmitComments, setSecondParsing

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

source

protected boolean source

For verbatim source.

isEmptyElement

private boolean isEmptyElement

Empty elements don't write a closing tag.

sourceContent

private String sourceContent

The source content of the input reader. Used to pass into macros.

Constructor Details

Xhtml5Parser

public Xhtml5Parser()

Method Details

handleStartTag

protected void handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)
                       throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
MacroExecutionException

Goes through the possible start tags. Just calls Xhtml5BaseParser.baseStartTag(XmlPullParser,Sink), this should be overridden by implementing parsers to include additional tags.

Overrides:

handleStartTag in class Xhtml5BaseParser

Parameters:

parser - A parser, not null.

sink - the sink to receive the events.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if there's a problem parsing the model

MacroExecutionException - if there's a problem executing a macro

handleEndTag

protected void handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
MacroExecutionException

Goes through the possible end tags. Just calls Xhtml5BaseParser.baseEndTag(XmlPullParser,Sink), this should be overridden by implementing parsers to include additional tags.

Overrides:

handleEndTag in class Xhtml5BaseParser

Parameters:

parser - A parser, not null.

sink - the sink to receive the events.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if there's a problem parsing the model

MacroExecutionException - if there's a problem executing a macro

handleComment

protected void handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)
                      throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Handles comments.

This is a default implementation, all data are emitted as comment events into the specified sink.

Overrides:

handleComment in class Xhtml5BaseParser

Parameters:

parser - A parser, not null.

sink - the sink to receive the events. Not null.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if there's a problem parsing the model

processMacro

private void processMacro(String text,
 Sink sink)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

process macro embedded in XHTML commment

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

escapeForMacro

private String escapeForMacro(String s)

escapeForMacro

Parameters:

s - String

Returns:

String

unescapeForMacro

private String unescapeForMacro(String s)

unescapeForMacro

Parameters:

s - String

Returns:

String

init

protected void init()

Initialize the parser. This is called first by AbstractParser.parse(java.io.Reader, org.apache.maven.doxia.sink.Sink) and can be used to set the parser into a clear state so it can be re-used.

Overrides:

init in class Xhtml5BaseParser

parse

public void parse(Reader source,
 Sink sink,
 String reference)
           throws ParseException

Parses the given source model and emits Doxia events into the given sink.

Specified by:

parse in interface Parser

Overrides:

parse in class Xhtml5BaseParser

Parameters:

source - not null reader that provides the source document. You could use newReader methods from ReaderFactory.

sink - A sink that consumes the Doxia events.

reference - a string identifying the source (for file based documents the source file path)

Throws:

ParseException - if the model could not be parsed.