Deprecated API

Contents

• Interfaces
• Classes
• Methods
• Constructors

Deprecated Interfaces

Interface	Description
org.apache.maven.doxia.module.fml.FmlMarkup	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.

Deprecated Classes

Class	Description
org.apache.maven.doxia.module.fml.FmlContentParser	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.
org.apache.maven.doxia.module.fml.FmlParser	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.
org.apache.maven.doxia.module.fml.FmlParserModule	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.
org.apache.maven.doxia.sink.impl.PipelineSink	Use the SinkWrapper approach which doesn't require the use of dynamic proxies.
org.apache.maven.doxia.sink.impl.RandomAccessSink	Use BufferingSinkProxyFactory instead which buffers on the (higher) Sink API level which usually is less memory intense than buffering the output stream which is done by this class. Also it doesn't require dynamically creating new sinks leveraging a SinkFactory.
org.apache.maven.doxia.sink.impl.SinkEventAttributeSet	since 2.2.0, use SinkEventAttributeSet instead.
org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics	Use SinkEventAttributeSet.Semantics instead.
org.apache.maven.doxia.util.LineBreaker	no longer used by Doxia and scheduled for removal in 2.3.0. It also swallows every write failure, so a failing writer would produce a silently truncated file.

Deprecated Methods

Method	Description
org.apache.maven.doxia.parser.AbstractParser.getBasedir()	this does not work in multi-module builds, see DOXIA-373
org.apache.maven.doxia.parser.AbstractXmlParser.getAttributesFromParser(XmlPullParser)	The return type will become SinkEventAttributes in 2.3.0. Callers are unaffected if they declare the result as that interface; every use in Doxia itself already needs nothing more than the interface. An override of this method will stop being called once the return type changes, with no error at build or run time. See issue 1074.
org.apache.maven.doxia.parser.AbstractXmlParser.handleUnknown(String, SinkEventAttributeSet, Sink, int)	The attribs parameter will become SinkEventAttributes in 2.3.0. An override of this signature will stop being called once the parameter type changes, with no error at build or run time, so move the override to the new signature when it lands. See issue 1074.
org.apache.maven.doxia.parser.Xhtml5BaseParser.baseEndTag(String, SinkEventAttributeSet, Sink)	The attribs parameter will become SinkEventAttributes in 2.3.0. An override of this signature will stop being called once the parameter type changes, with no error at build or run time, so move the override to the new signature when it lands. See issue 1074.
org.apache.maven.doxia.parser.Xhtml5BaseParser.baseStartTag(String, SinkEventAttributeSet, Sink)	The attribs parameter will become SinkEventAttributes in 2.3.0. An override of this signature will stop being called once the parameter type changes, with no error at build or run time, so move the override to the new signature when it lands. See issue 1074.
org.apache.maven.doxia.parser.Xhtml5BaseParser.consecutiveSections(int, Sink, SinkEventAttributeSet)	Use Xhtml5BaseParser.emitHeadingSections(int, Sink, boolean) instead.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeEndTag(HTML.Tag)	use AbstractXmlSink.writeEndTag(HtmlTag); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeSimpleTag(HTML.Tag)	use AbstractXmlSink.writeSimpleTag(HtmlTag); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeSimpleTag(HTML.Tag, MutableAttributeSet)	use AbstractXmlSink.writeSimpleTag(HtmlTag, javax.swing.text.MutableAttributeSet); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeStartTag(HTML.Tag)	use AbstractXmlSink.writeStartTag(HtmlTag); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeStartTag(HTML.Tag, MutableAttributeSet)	use AbstractXmlSink.writeStartTag(HtmlTag, javax.swing.text.MutableAttributeSet); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.impl.AbstractXmlSink.writeStartTag(HTML.Tag, MutableAttributeSet, boolean)	use AbstractXmlSink.writeStartTag(HtmlTag, javax.swing.text.MutableAttributeSet, boolean); the javax.swing tag type goes in 2.3.0.
org.apache.maven.doxia.sink.Sink.sectionTitle()	Use Sink.sectionTitle1() instead.
org.apache.maven.doxia.sink.Sink.sectionTitle_()	Use Sink.sectionTitle1_() instead.
org.apache.maven.doxia.util.HtmlTools.encodeId(String)	use DoxiaUtils.encodeId(String)
org.apache.maven.doxia.util.HtmlTools.isId(String)	use DoxiaUtils.isValidId(String)

Deprecated Constructors

Constructor	Description
org.apache.maven.doxia.index.IndexingSink(IndexEntry)	legacy constructor, use IndexingSink(Sink) with SinkAdapter as argument and call IndexingSink.getRootEntry() to retrieve the index tree afterwards.