Class FmlParser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

org.apache.maven.doxia.parser.AbstractXmlParser

org.apache.maven.doxia.module.fml.FmlParser

All Implemented Interfaces:

MacroExecutor, HtmlMarkup, Markup, XmlMarkup, FmlMarkup, Parser

@Deprecated
@Singleton
@Named("fml")
public class FmlParser
extends AbstractXmlParser
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 a fml model and emit events into the specified doxia Sink.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field	Description
private StringBuilder	buffer	Deprecated. Used to collect text events.
private Faq	currentFaq	Deprecated. Collect a single faq.
private Part	currentPart	Deprecated. Collect a part.
private Faqs	faqs	Deprecated. Collect a faqs model.
private static final org.slf4j.Logger	LOGGER	Deprecated.
private String	macroName	Deprecated. A macro name.
private Map<String,Object>	macroParameters	Deprecated. The macro parameters.
private String	sourceContent	Deprecated. The source content of the input reader.

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
FmlParser()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Handles CDATA sections.
protected void	handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Handles comments.
protected void	handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Goes through the possible end tags.
protected void	handleEntity(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Handles entities.
private void	handleMacroEnd(StringBuilder buffer)	Deprecated. TODO import from XdocParser, probably need to be generic.
private void	handleMacroStart(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)	Deprecated. TODO import from XdocParser, probably need to be generic.
private void	handleParamStart(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. TODO import from XdocParser, probably need to be generic.
protected void	handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Goes through the possible start tags.
protected void	handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Deprecated. Handles text events.
protected void	init()	Deprecated. Initialize the parser.
void	parse(Reader source, Sink sink, String reference)	Deprecated. Parses the given source model and emits Doxia events into the given sink.
private void	writeFaqs(Sink sink)	Deprecated. Writes the faqs to the specified sink.
private void	writeTopLink(Sink sink)	Deprecated. Writes a toplink element.

Methods inherited from class AbstractXmlParser

getAddDefaultEntities, getAttributesFromParser, getLocalEntities, getText, getType, handleUnknown, handleUnknown, initXmlParser, 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.

faqs

private Faqs faqs

Deprecated.

Collect a faqs model.

currentPart

private Part currentPart

Deprecated.

Collect a part.

currentFaq

private Faq currentFaq

Deprecated.

Collect a single faq.

buffer

private StringBuilder buffer

Deprecated.

Used to collect text events.

sourceContent

private String sourceContent

Deprecated.

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

macroName

private String macroName

Deprecated.

A macro name.

macroParameters

private Map<String,Object> macroParameters

Deprecated.

The macro parameters.

Constructor Details

FmlParser

public FmlParser()

Deprecated.

Method Details

parse

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

Deprecated.

Description copied from interface: Parser

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

Specified by:

parse in interface Parser

Overrides:

parse in class AbstractXmlParser

Parameters:

source - not null reader that provides the source document.

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.

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: AbstractXmlParser

Goes through the possible start tags.

Specified by:

handleStartTag in class AbstractXmlParser

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: AbstractXmlParser

Goes through the possible end tags.

Specified by:

handleEndTag in class AbstractXmlParser

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

handleText

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

Deprecated.

Description copied from class: AbstractXmlParser

Handles text events.

This is a default implementation, if the parser points to a non-empty text element, it is emitted as a text event into the specified sink.

Overrides:

handleText in class AbstractXmlParser

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

handleCdsect

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

Deprecated.

Description copied from class: AbstractXmlParser

Handles CDATA sections.

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

Overrides:

handleCdsect in class AbstractXmlParser

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

handleComment

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

Deprecated.

Description copied from class: AbstractXmlParser

Handles comments.

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

Overrides:

handleComment in class AbstractXmlParser

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

handleEntity

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

Deprecated.

Description copied from class: AbstractXmlParser

Handles entities.

This is a default implementation, all entities are resolved and emitted as text events into the specified sink, except:

• the entities with names #160, nbsp and #x00A0 are emitted as nonBreakingSpace() events.

Overrides:

handleEntity in class AbstractXmlParser

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

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 AbstractParser

handleMacroStart

private void handleMacroStart(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                       throws MacroExecutionException

Deprecated.

TODO import from XdocParser, probably need to be generic.

Parameters:

parser - not null

Throws:

MacroExecutionException - if any

handleMacroEnd

private void handleMacroEnd(StringBuilder buffer)
                     throws MacroExecutionException

Deprecated.

TODO import from XdocParser, probably need to be generic.

Parameters:

buffer - not null

Throws:

MacroExecutionException - if any

handleParamStart

private void handleParamStart(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)
                       throws MacroExecutionException

Deprecated.

TODO import from XdocParser, probably need to be generic.

Parameters:

parser - not null

sink - not null

Throws:

MacroExecutionException - if any

writeFaqs

private void writeFaqs(Sink sink)
                throws ParseException

Deprecated.

Writes the faqs to the specified sink.

Parameters:

sink - The sink to consume the event.

Throws:

ParseException - if something goes wrong.

writeTopLink

private void writeTopLink(Sink sink)

Deprecated.

Writes a toplink element.

Parameters:

sink - The sink to consume the event.