Class FmlContentParser

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.fml.FmlContentParser

All Implemented Interfaces:

MacroExecutor, HtmlMarkup, Markup, XmlMarkup, FmlMarkup, Parser

@Deprecated
public class FmlContentParser
extends Xhtml5BaseParser
implements FmlMarkup

Deprecated.

FML is deprecated since 2.2.0 and scheduled for removal in the next major version. Convert FAQ pages to Markdown or XDoc, for example with doxia-converter; see https://github.com/apache/maven-doxia/issues/1101.

Parse Fml questions and answers, these may contain arbitrary xdoc elements.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isEmptyElement	Deprecated. Empty elements don't write a closing tag.
private static final org.slf4j.Logger	LOGGER	Deprecated.

Fields inherited from class Xhtml5BaseParser

isBeginningOfLineInsideBlock

Fields inherited from interface FmlMarkup

ANSWER_TAG, FAQ_TAG, FAQS_TAG, FML_NAMESPACE, FML_SYSTEM_ID, MACRO_TAG, PART_TAG, QUESTION_TAG, SOURCE_TAG

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 XmlMarkup

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
FmlContentParser()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Goes through the possible end tags.
protected void	handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Goes through the possible start tags.
protected void	init()	Deprecated. Initialize the parser.

Methods inherited from class Xhtml5BaseParser

baseEndTag, baseEndTag, baseStartTag, baseStartTag, consecutiveSections, emitHeadingSections, getSectionLevel, handleCdsect, handleComment, handleText, initXmlParser, isScriptBlock, isVerbatim, parse, processInsignificantLineBreaks, 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, setMacroExecutor, 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

Deprecated.

isEmptyElement

private boolean isEmptyElement

Deprecated.

Empty elements don't write a closing tag.

Constructor Details

FmlContentParser

public FmlContentParser()

Deprecated.

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

Deprecated.

Description copied from class: Xhtml5BaseParser

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

Deprecated.

Description copied from class: Xhtml5BaseParser

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

init

protected void init()

Deprecated.

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