Package org.apache.maven.doxia.module.fml

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:
org.apache.maven.doxia.macro.MacroExecutor, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, FmlMarkup, org.apache.maven.doxia.parser.Parser
@Deprecated @Singleton @Named("fml") public class FmlParser extends org.apache.maven.doxia.parser.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
Author:
Emmanuel Venisse, ltheussl

  • 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.module.fml.FmlMarkup

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

    Fields inherited from interface org.apache.maven.doxia.markup.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 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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    handleEntity(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink)
    Deprecated.
     
    protected void
    init()
    Deprecated.
    void
    parse(Reader source, org.apache.maven.doxia.sink.Sink sink, String reference)
    Deprecated.
     

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

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

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

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • parse

      public void parse(Reader source, org.apache.maven.doxia.sink.Sink sink, String reference) throws org.apache.maven.doxia.parser.ParseException
      Deprecated.
      Specified by:
      parse in interface org.apache.maven.doxia.parser.Parser
      Overrides:
      parse in class org.apache.maven.doxia.parser.AbstractXmlParser
      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
      Deprecated.
      Specified by:
      handleStartTag in class org.apache.maven.doxia.parser.AbstractXmlParser
      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
      Deprecated.
      Specified by:
      handleEndTag in class org.apache.maven.doxia.parser.AbstractXmlParser
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException
      org.apache.maven.doxia.macro.MacroExecutionException

    • handleText

      protected void handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
      Deprecated.
      Overrides:
      handleText in class org.apache.maven.doxia.parser.AbstractXmlParser
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException

    • handleCdsect

      protected void handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
      Deprecated.
      Overrides:
      handleCdsect in class org.apache.maven.doxia.parser.AbstractXmlParser
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException

    • handleComment

      protected void handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
      Deprecated.
      Overrides:
      handleComment in class org.apache.maven.doxia.parser.AbstractXmlParser
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException

    • handleEntity

      protected void handleEntity(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, org.apache.maven.doxia.sink.Sink sink) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
      Deprecated.
      Overrides:
      handleEntity in class org.apache.maven.doxia.parser.AbstractXmlParser
      Throws:
      org.codehaus.plexus.util.xml.pull.XmlPullParserException

    • init

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